【PHP8.x】DateInvalidOperationException::codeプロパティの使い方

Copy
1<?php
2
3namespace App\Controllers;
4
5use CodeIgniter\Controller;
6use DateInvalidOperationException;
7use DateTime;
8use DateInterval;
9use Throwable;
10
11/**
12 * CodeIgniter のコントローラー内で DateInvalidOperationException を処理するサンプルクラス
13 *
14 * このクラスは、無効な日付操作によってスローされる
15 * DateInvalidOperationException を捕捉し、
16 * Exception クラスから継承された `code` プロパティの値を
17 * getCode() メソッドで取得する方法を示します。
18 */
19class DateExceptionDemo extends Controller
20{
21    /**
22     * 意図的に無効な日付操作を実行し、例外のエラーコードを表示します。
23     *
24     * CodeIgniter環境で /dateexceptiondemo のようなルートにアクセスすると実行されます。
25     *
26     * @return string
27     */
28    public function index(): string
29    {
30        try {
31            // DateTimeオブジェクトを作成します。
32            $date = new DateTime('2024-01-01');
33
34            // invertプロパティに無効な値(-1)を設定したDateIntervalオブジェクトを作成します。
35            // このオブジェクトを sub() メソッドで使用すると、
36            // PHP 8では DateInvalidOperationException がスローされます。
37            $invalidInterval = new DateInterval('P1M');
38            $invalidInterval->invert = -1; // この操作が無効と見なされます
39
40            // 意図的に例外を発生させます。
41            $date->sub($invalidInterval);
42
43            // 例外がスローされるため、この行は実行されません。
44            return '処理は正常に完了しました。';
45
46        } catch (DateInvalidOperationException $e) {
47            // DateInvalidOperationException を捕捉します。
48            // Exceptionクラスから継承された getCode() メソッドでエラーコードを取得します。
49            // この組み込み例外の場合、通常はコード 0 が返されます。
50            $errorCode = $e->getCode();
51
52            // 取得したエラーコードとメッセージを画面に出力します。
53            // 実際のアプリケーションでは、ロギングや専用のエラーページ表示などを行います。
54            return "DateInvalidOperationException が発生しました。<br>"
55                 . "エラーメッセージ: " . htmlspecialchars($e->getMessage(), ENT_QUOTES, 'UTF-8') . "<br>"
56                 . "エラーコード (code プロパティ): " . $errorCode;
57        } catch (Throwable $th) {
58            // 予期しないその他のエラーを捕捉します。
59            return "予期しないエラーが発生しました: " . htmlspecialchars($th->getMessage(), ENT_QUOTES, 'UTF-8');
60        }
61    }
62}
63
64/*
65 * このファイルを CodeIgniter 4 プロジェクトの app/Controllers/DateExceptionDemo.php
66 * として保存し、サーバーを起動後、ブラウザで /dateexceptiondemo にアクセスすると
67 * 結果が表示されます。
68 * CodeIgniter環境がない場合は、クラス定義以降の実行部分をコメントアウト解除して
69 * コマンドラインから `php YourFileName.php` で実行することも可能です。
70 */
71/*
72// ---- CodeIgniter環境外で実行する場合のサンプルコード ----
73// require_once 'vendor/autoload.php'; // CodeIgniterのオートローダーが必要な場合
74// (この例では不要)
75
76// クラスのインスタンスを作成
77$demo = new \App\Controllers\DateExceptionDemo();
78
79// メソッドを実行して結果を出力
80echo $demo->index();
81*/
82

このサンプルコードは、PHP 8で導入されたDateInvalidOperationExceptionクラスのcodeプロパティについて説明しています。DateInvalidOperationExceptionは、日付や時刻に関する操作が不正な場合に発生する例外です。codeプロパティは、発生した例外に割り当てられた数値のエラーコードを表し、通常はExceptionクラスから継承されたgetCode()メソッドを通じて整数値（int）として取得されます。このプロパティに直接引数はありません。

サンプルコードでは、CodeIgniterのコントローラー内で、DateIntervalオブジェクトのinvertプロパティに無効な値（-1）を設定し、DateTimeオブジェクトのsub()メソッドに渡すことで、意図的にDateInvalidOperationExceptionを発生させています。try-catchブロックを用いることで、この例外を安全に捕捉し、$e->getCode()を呼び出してエラーコードを取得しています。PHPの組み込み例外の場合、このcodeプロパティは通常 0 を返しますが、これはその例外が特定のカスタムエラーコードを持たないことを意味します。システムエンジニアにとって、このようにエラーコードを取得し表示することは、問題の原因を特定し、適切なエラーハンドリングを実装するための重要な手法となります。取得したエラーコードは、デバッグやログ記録の際に役立ちます。