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

Copy
1<?php
2
3namespace App\Libraries;
4
5use DateTime;
6use DateInterval;
7use DatePeriod;
8use DateObjectError;
9
10class DateExceptionExample
11{
12    /**
13     * DateException を発生させて、code プロパティの値を取得する例
14     *
15     * @return int|null DateException の code プロパティの値。発生しない場合は null
16     */
17    public function getErrorCodeFromDateException(): ?int
18    {
19        try {
20            // 存在しない日付を作成しようとして DateException を発生させる
21            new DateTime('9999-99-99');
22        } catch (DateObjectError $e) {
23            // DateException の code プロパティを取得
24            return $e->getCode();
25        }
26
27        return null; // DateException が発生しなかった場合は null を返す
28    }
29}

このサンプルコードは、PHPのDateExceptionクラスのcodeプロパティの利用例を示しています。codeプロパティは、例外発生時に設定されるエラーコードを表す整数値です。

DateExceptionExampleクラス内のgetErrorCodeFromDateExceptionメソッドは、意図的にDateObjectError（DateExceptionを継承）を発生させ、その例外オブジェクトからcodeプロパティの値を取得します。具体的には、存在しない日付（9999-99-99）でDateTimeオブジェクトを生成しようとすることで、例外を発生させています。

try-catchブロックを使用することで、例外発生時の処理を記述しています。catchブロック内では、発生したDateObjectErrorオブジェクトのgetCode()メソッドを呼び出し、エラーコードを取得しています。取得したエラーコードは、メソッドの戻り値として返されます。

もし例外が発生しなかった場合、つまりDateTimeオブジェクトが正常に生成された場合は、nullを返します。これは、例外が発生しなかったことを示すためです。

この例を通して、DateExceptionが発生した場合に、codeプロパティから具体的なエラー情報を取得し、処理に役立てることができることを理解できます。CodeIgniter等のフレームワークで日付処理を行う際にも、例外処理の一環として応用できるでしょう。

Copy
1<?php
2
3/**
4 * DateException の code プロパティのサンプルコード。
5 *
6 * DateException をキャッチし、code プロパティの値を出力します。
7 * このプロパティは、例外を表す整数型のコードを保持します。
8 */
9try {
10    throw new DateException('日付処理でエラーが発生しました。', 123);
11} catch (DateException $e) {
12    $errorCode = $e->getCode(); // 例外コードを取得
13    echo "エラーコード: " . $errorCode . PHP_EOL; // エラーコードを出力
14}

DateExceptionクラスのcodeプロパティは、発生した例外の種類を示す整数値を保持します。このサンプルコードでは、まずtry-catchブロックを使用して、DateExceptionを発生させ、それを捕捉しています。DateExceptionコンストラクタの第二引数にエラーコード（ここでは123）を指定することで、例外オブジェクトにエラーコードを設定できます。

catchブロック内では、$e->getCode()を呼び出すことで、捕捉したDateExceptionオブジェクトのcodeプロパティの値を取得しています。getCode()メソッドは引数を取らず、例外を表す整数型のコードを返します。取得したエラーコードは$errorCode変数に格納され、echo文によって標準出力に出力されます。

この例では、意図的にDateExceptionを発生させていますが、実際には日付の処理中にエラーが発生した場合などに、DateExceptionが投げられることが想定されます。codeプロパティを利用することで、発生したエラーの種類をプログラム上で判別し、適切なエラー処理を行うことが可能になります。例えば、エラーコードに応じて異なるエラーメッセージを表示したり、特定のエラーに対してのみリトライ処理を実行したりといった制御が実現できます。