【PHP8.x】getCodeメソッドの使い方

Copy
1<?php
2
3/**
4 * DateInvalidOperationException を捕捉し、そのエラーコードを取得するサンプル関数。
5 *
6 * この関数は、DateTime オブジェクトに対して無効な日付設定を試み、
7 * DateInvalidOperationException がスローされるシナリオを示します。
8 * 例外が捕捉された際に、`getCode()` メソッドを使って例外に紐づく数値コードを取得し表示します。
9 */
10function demonstrateDateInvalidOperationExceptionGetCode(): void
11{
12    try {
13        // 現在の日付で DateTime オブジェクトを初期化します。
14        $date = new DateTime('2023-01-01');
15        echo "初期日付: " . $date->format('Y-m-d') . PHP_EOL;
16
17        // 存在しない日付（例: 2月30日）を設定しようとすると、
18        // DateInvalidOperationException がスローされます。
19        echo "無効な日付（2月30日）を設定しようとします..." . PHP_EOL;
20        $date->setDate(2023, 2, 30);
21
22        // 例外がスローされるため、この行は通常実行されません。
23        echo "日付設定成功 (このメッセージは通常表示されません)" . PHP_EOL;
24
25    } catch (DateInvalidOperationException $e) {
26        // DateInvalidOperationException を捕捉します。
27        echo "DateInvalidOperationException が捕捉されました。" . PHP_EOL;
28        echo "エラーメッセージ: " . $e->getMessage() . PHP_EOL;
29        
30        // getCode() メソッドを呼び出し、例外のエラーコードを取得します。
31        // DateInvalidOperationException の場合、PHPの内部で定義されたコード（通常は0）を返します。
32        $errorCode = $e->getCode();
33        echo "エラーコード: " . $errorCode . PHP_EOL;
34
35    } catch (Exception $e) {
36        // その他の予期せぬ例外を捕捉します。
37        echo "予期せぬエラーが発生しました: " . $e->getMessage() . PHP_EOL;
38        echo "エラーコード: " . $e->getCode() . PHP_EOL;
39    }
40}
41
42// サンプル関数を実行します。
43demonstrateDateInvalidOperationExceptionGetCode();

DateInvalidOperationException::getCode()は、PHPのDateTimeオブジェクトなどを用いた日付操作において、無効な処理が行われた際にスローされるDateInvalidOperationException例外から、そのエラーコードを取得するためのメソッドです。

このメソッドは引数を必要とせず、呼び出すことで例外に紐づけられた整数値（int）を戻り値として返します。この整数値は、発生したエラーの種類をプログラム側で識別するために利用できます。

提示されたサンプルコードでは、DateTimeオブジェクトに対して存在しない日付（2023年2月30日）を設定しようとします。これによりDateInvalidOperationExceptionが発生し、try-catchブロックで捕捉されます。catchブロック内で$e->getCode()を呼び出すことで、この例外のエラーコードを取得し表示しています。DateInvalidOperationExceptionの場合、PHP内部で定義されたコードが返され、多くの場合0となります。これにより、日付操作に関する具体的なエラー内容を数値として確認できるため、エラーハンドリングの際に役立ちます。