【PHP8.x】DateMalformedIntervalStringException::getCode()メソッドの使い方

Copy
1<?php
2
3/**
4 * このコードは、不正な日付期間文字列が与えられた場合に発生する
5 * DateMalformedIntervalStringException を捕捉し、その例外コードを取得する方法を示します。
6 */
7function demonstrateDateMalformedIntervalExceptionCode(): void
8{
9    echo "不正な日付期間文字列で DateInterval を生成しようとします。\n";
10
11    try {
12        // 不正な期間文字列を DateInterval コンストラクタに渡すことで、
13        // DateMalformedIntervalStringException を意図的に発生させます。
14        new DateInterval('P1BadIntervalString');
15        echo "DateInterval が正常に生成されました。(この行は通常実行されません)\n";
16    } catch (DateMalformedIntervalStringException $e) {
17        // DateMalformedIntervalStringException が捕捉されました。
18        echo "DateMalformedIntervalStringException が捕捉されました。\n";
19        echo "エラーメッセージ: " . $e->getMessage() . "\n";
20        
21        // getCode() メソッドを使用して、例外の数値コードを取得します。
22        // PHP の組み込み例外では、通常この値は 0 です。
23        $exceptionCode = $e->getCode();
24        echo "例外コード: " . $exceptionCode . "\n";
25    } catch (Exception $e) {
26        // その他の予期せぬ例外を捕捉します。
27        echo "予期せぬ例外が捕捉されました: " . $e->getMessage() . "\n";
28        echo "例外コード: " . $e->getCode() . "\n";
29    }
30
31    echo "\nプログラムの実行を続行します。\n";
32}
33
34// 関数を実行して、サンプルコードの動作を確認します。
35demonstrateDateMalformedIntervalExceptionCode();
36
37?>

PHP 8 の DateMalformedIntervalStringException::getCode() メソッドは、日付期間の形式が不正な場合に発生する例外から、エラーの識別コードを取得するために使われます。

このメソッドは引数を必要とせず、呼び出すと整数（int型）の値を返します。PHPの標準的な組み込み例外では、このメソッドは通常 0 を返しますが、特定の状況下やカスタム例外では異なるコードが設定されることもあります。

サンプルコードでは、new DateInterval('P1BadIntervalString') のように、意図的に誤った形式の日付期間文字列を渡すことで DateMalformedIntervalStringException を発生させています。try-catch ブロックでこの例外を捕捉した後、例外オブジェクト $e に対して $e->getCode() を呼び出すことで、その例外に関連付けられた数値のコードを取得し、表示しています。これにより、プログラムがどのような種類の例外に遭遇したかを数値で確認し、エラーハンドリングの際に役立てることができます。

Copy
1<?php
2
3/**
4 * 不正な形式の期間文字列を処理し、例外のエラーコードを取得するサンプル関数
5 *
6 * @param string $intervalString 処理する期間文字列
7 * @return void
8 */
9function displayIntervalErrorCode(string $intervalString): void
10{
11    try {
12        // 不正な形式の期間文字列から DateInterval を生成しようとすると、
13        // DateMalformedIntervalStringException がスローされる
14        $interval = DateInterval::createFromDateString($intervalString);
15
16        // この行は、例外がスローされなかった場合にのみ実行される
17        echo "期間の生成に成功しました。\n";
18
19    } catch (DateMalformedIntervalStringException $e) {
20        // スローされた例外をキャッチする
21        echo "例外がキャッチされました。\n";
22        echo "メッセージ: " . $e->getMessage() . "\n";
23
24        // getCode() メソッドで例外に関連付けられたエラーコードを取得する
25        // DateMalformedIntervalStringException の場合、通常は 0 が返される
26        $errorCode = $e->getCode();
27        echo "エラーコード: " . $errorCode . "\n";
28
29    } catch (Throwable $t) {
30        // その他の予期せぬエラーをキャッチする
31        echo "予期せぬエラーが発生しました: " . $t->getMessage() . "\n";
32    }
33}
34
35// 不正な形式の文字列を渡して関数を実行
36displayIntervalErrorCode('this is not a valid interval');
37
38?>

DateMalformedIntervalStringException::getCode() メソッドは、PHPで日付や期間を扱う際に、不正な形式の期間文字列が与えられた場合に発生する DateMalformedIntervalStringException という例外から、関連付けられたエラーコードを取得するために用いられます。このメソッドは引数を一切取らず、整数型 (int) の値を戻り値として返します。

サンプルコードでは、displayIntervalErrorCode 関数が不正な期間文字列（例: 'this is not a valid interval'）を処理しようとしています。DateInterval::createFromDateString に無効な値が渡されると、DateMalformedIntervalStringException がスローされます。これを try-catch ブロックで捕捉し、発生した例外オブジェクト $e に対して $e->getCode() メソッドを呼び出しています。

この呼び出しによって、例外に関連付けられたエラーコードが取得され、画面に表示されます。DateMalformedIntervalStringException の場合、通常、この getCode() メソッドは 0 を返します。これは、特定の期間文字列の形式エラーに対しては、PHP内部で個別の数値コードが細かく割り当てられていないことを示しています。このメソッドを利用することで、例外発生時の状況を数値で把握し、より詳細なエラー処理やログ記録に役立てることができます。