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

Copy
1<?php
2
3declare(strict_types=1);
4
5namespace App\Controllers;
6
7use DateInterval;
8use DateMalformedPeriodStringException;
9use Throwable;
10
11/**
12 * CodeIgniterのコントローラーを模した、日付期間文字列を処理するクラス
13 */
14class DateProcessor
15{
16    /**
17     * 不正な日付期間文字列を処理し、例外コードを取得します。
18     *
19     * @param string $invalidPeriodString 不正な形式の日付期間文字列
20     * @return void
21     */
22    public function process(string $invalidPeriodString): void
23    {
24        try {
25            // 不正な形式の文字列からDateIntervalオブジェクトを生成しようとすると
26            // DateMalformedPeriodStringExceptionがスローされます。
27            $interval = new DateInterval($invalidPeriodString);
28            echo "成功: " . $interval->format('%y年 %m月 %d日');
29        } catch (DateMalformedPeriodStringException $e) {
30            // DateMalformedPeriodStringExceptionをキャッチします。
31            // この例外はThrowableインターフェースを実装しています。
32
33            // getCode() メソッドで例外コード(int)を取得します。
34            $exceptionCode = $e->getCode();
35
36            // 取得した情報を使ってエラーログを出力するなどの処理を想定します。
37            // ここでは画面に表示します。
38            echo "エラー: 日付期間文字列の形式が正しくありません。" . PHP_EOL;
39            echo "メッセージ: " . $e->getMessage() . PHP_EOL;
40            echo "例外コード: " . $exceptionCode . PHP_EOL; // codeプロパティの値
41            echo "ファイル: " . $e->getFile() . PHP_EOL;
42            echo "行番号: " . $e->getLine() . PHP_EOL;
43        } catch (Throwable $e) {
44            // その他の予期せぬエラー
45            echo "予期せぬエラーが発生しました: " . $e->getMessage() . PHP_EOL;
46        }
47    }
48}
49
50// CodeIgniterのルーティングから呼び出されることを想定した実行部分
51$processor = new DateProcessor();
52$invalidString = 'invalid-period-string';
53
54// メソッドを実行
55$processor->process($invalidString);
56
57/*
58実行結果の例:
59
60エラー: 日付期間文字列の形式が正しくありません。
61メッセージ: DateInterval::__construct(): Unknown or bad format (invalid-period-string)
62例外コード: 0
63ファイル: /path/to/your/script.php
64行番号: 26
65
66*/

PHP 8において、DateMalformedPeriodStringExceptionクラスは、DateIntervalオブジェクトを生成する際に、与えられた日付期間文字列の形式が不正である場合に発生する例外です。この例外は、プログラムが予期せぬ不正な入力値によって処理を継続できない状況を開発者に知らせるために使用されます。

この例外クラスはThrowableインターフェースを実装しており、そのgetCode()メソッドを通じて、例外に関する特定の識別子である「例外コード」を取得することができます。getCode()メソッドは、引数を必要とせず、整数型（int）の値を戻り値として返します。この戻り値が、参照情報で示された「code」プロパティの実際の値となります。通常、DateMalformedPeriodStringExceptionがスローされた場合の例外コードは0となりますが、これによりエラーの発生源を特定する手助けとなります。

提供されたCodeIgniterを模したサンプルコードでは、不正な日付期間文字列「invalid-period-string」をDateIntervalコンストラクタに渡した際に、このDateMalformedPeriodStringExceptionを捕捉しています。そして、$e->getCode()を呼び出すことで、この例外に紐づく整数型の例外コードを取得し、エラーメッセージと共に表示しています。この例外コードは、デバッグ時や、より詳細なエラーハンドリングを行う際に、エラーの種類を識別し、適切な処理を行うために役立ちます。

Copy
1<?php
2
3/**
4 * Demonstrates catching a DateMalformedPeriodStringException and accessing its integer code property.
5 *
6 * This function attempts to create a DatePeriod object from an invalid string,
7 * catches the specific exception thrown in PHP 8, and outputs its message and
8 * the associated error code.
9 *
10 * The code style adheres to common PHP coding standards (e.g., PSR-12),
11 * which static analysis tools like PHP_CodeSniffer are designed to enforce.
12 * While PHP_CodeSniffer itself analyzes code *before* execution, adopting good
13 * exception handling practices, as shown here, is crucial for writing robust
14 * and maintainable code that passes such checks.
15 *
16 * @param string $invalidPeriodString An intentionally malformed date period string
17 *                                    that will trigger the DateMalformedPeriodStringException.
18 * @return void
19 */
20function handleMalformedDatePeriod(string $invalidPeriodString): void
21{
22    echo "Attempting to create DatePeriod from: '{$invalidPeriodString}'\n";
23    try {
24        // DatePeriod::createFromDateString() will throw DateMalformedPeriodStringException
25        // in PHP 8 if the input string is not a valid date period format.
26        $datePeriod = DatePeriod::createFromDateString($invalidPeriodString);
27
28        // This line will only be reached if the string was unexpectedly valid.
29        echo "Successfully created DatePeriod. This indicates the string was not malformed.\n";
30    } catch (DateMalformedPeriodStringException $e) {
31        // Catch the specific exception for malformed date period strings.
32        echo "Caught DateMalformedPeriodStringException!\n";
33        echo "  Message: " . $e->getMessage() . "\n";
34        // The 'code' property provides an integer that categorizes the error.
35        echo "  Error Code: " . $e->getCode() . "\n";
36    } catch (Throwable $e) {
37        // Catch any other unexpected exceptions to prevent script termination
38        // and provide helpful debugging information.
39        echo "Caught an unexpected generic exception: " . $e->getMessage() . "\n";
40        echo "  Error Code: " . $e->getCode() . "\n";
41    }
42    echo "---------------------------------------------------\n";
43}
44
45// --- Example Usage ---
46// These examples use strings that will intentionally trigger the exception.
47
48// 1. A completely arbitrary, non-parseable string.
49handleMalformedDatePeriod("not a valid date period string");
50
51// 2. A string that starts like a duration but is malformed ('X' is invalid).
52handleMalformedDatePeriod("P1X");
53
54// 3. A malformed recurrence rule for DatePeriod.
55handleMalformedDatePeriod("R/2023-01-01/invalid-format");

PHP 8のDateMalformedPeriodStringExceptionは、DatePeriod::createFromDateString()のようなメソッドに、日付期間として解釈できない不正な文字列が渡された場合に発生する例外クラスです。このクラスが持つcodeプロパティは、発生したエラーの種類を示す整数値（int）を返します。このプロパティには引数はありません。

サンプルコードでは、handleMalformedDatePeriod関数が不正な日付期間文字列を引数に取り、try-catchブロックでDateMalformedPeriodStringExceptionを捕捉する様子を示しています。例外が発生すると、$e->getMessage()でエラーメッセージを、そして$e->getCode()でそのエラーを示す整数値を取得し、出力しています。このようにエラーコードを利用することで、プログラムはエラーの種類に応じて異なる処理を実行したり、より詳細なエラーログを記録したりすることが可能になります。

適切な例外処理の実装は、PHP_CodeSnifferなどの静的解析ツールが求めるコード品質を向上させ、予期せぬ状況にも対応できる堅牢なシステムを構築するために非常に重要です。