【PHP8.x】DateMalformedIntervalStringException::messageプロパティの使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5// このコードを実行するには、MessagePack拡張機能が必要です。
6// (例: 'pecl install msgpack' や 'apt-get install php-msgpack')
7
8/**
9 * MessagePackでシリアライズされたデータ内の日付期間文字列を処理するクラス。
10 *
11 * 不正な形式の文字列が渡された場合に発生する例外を捕捉し、
12 * そのエラーメッセージを含むレスポンスをMessagePack形式で返します。
13 */
14class IntervalProcessor
15{
16    /**
17     * MessagePack形式のバイナリデータを受け取り、日付期間の解析を試みます。
18     *
19     * @param string $packedRequest MessagePackでエンコードされたリクエストデータ
20     *        (例: ['interval_spec' => 'P1M10D'])
21     * @return string 処理結果をMessagePackでエンコードしたレスポンスデータ
22     */
23    public function process(string $packedRequest): string
24    {
25        try {
26            // MessagePackデータをデコード（アンパック）する
27            $requestData = msgpack_unpack($packedRequest);
28
29            if (!isset($requestData['interval_spec']) || !is_string($requestData['interval_spec'])) {
30                throw new InvalidArgumentException('キー "interval_spec" が存在しないか、文字列ではありません。');
31            }
32            
33            // デコードした文字列からDateIntervalオブジェクトを生成
34            // 文字列が不正な形式の場合、DateMalformedIntervalStringExceptionがスローされる
35            $interval = new DateInterval($requestData['interval_spec']);
36            
37            // 成功した場合のレスポンスを構築
38            $response = [
39                'status' => 'success',
40                'formatted' => $interval->format('%y年 %mヶ月 %d日 %h時間 %i分 %s秒'),
41            ];
42
43        } catch (DateMalformedIntervalStringException $e) {
44            // DateMalformedIntervalStringException をキャッチ
45            // ここでリファレンス情報にある 'message' プロパティ（実際には getMessage() メソッド）を使用する
46            $response = [
47                'status' => 'error',
48                'error_type' => 'DateMalformedIntervalStringException',
49                'message' => $e->getMessage(), // 例外からエラーメッセージを取得
50            ];
51        } catch (Throwable $e) {
52            // その他の予期せぬエラーをキャッチ
53            $response = [
54                'status' => 'error',
55                'error_type' => get_class($e),
56                'message' => $e->getMessage(),
57            ];
58        }
59
60        // 処理結果をMessagePack形式でエンコード（パック）して返す
61        return msgpack_pack($response);
62    }
63}
64
65// --- 実行サンプル ---
66
67$processor = new IntervalProcessor();
68
69// 1. 成功するケースのデータを作成し、MessagePackでエンコード
70$validPayload = ['interval_spec' => 'P1Y2M3DT4H5M6S'];
71$packedValidData = msgpack_pack($validPayload);
72
73echo "--- 成功ケース ---" . PHP_EOL;
74$packedSuccessResponse = $processor->process($packedValidData);
75print_r(msgpack_unpack($packedSuccessResponse));
76echo PHP_EOL;
77
78// 2. DateMalformedIntervalStringException が発生するケースのデータを作成し、MessagePackでエンコード
79$invalidPayload = ['interval_spec' => 'This is not a valid interval string'];
80$packedInvalidData = msgpack_pack($invalidPayload);
81
82echo "--- 失敗ケース (DateMalformedIntervalStringException) ---" . PHP_EOL;
83$packedErrorResponse = $processor->process($packedInvalidData);
84// エラーレスポンスをデコードすると、'message' に例外メッセージが含まれていることがわかる
85print_r(msgpack_unpack($packedErrorResponse));
86

このPHPサンプルコードは、日付や時間の期間を表すDateIntervalオブジェクトを生成する際の、エラー処理方法を示しています。

DateIntervalオブジェクトは、「P1Y2M3D」（1年2ヶ月3日の意味）のような、特定の書式に従った文字列から作られます。もし、この書式に合わない不正な文字列（例: 'This is not a valid interval string'）が渡されると、DateMalformedIntervalStringExceptionという種類の例外が発生します。

このコードではtry...catch構文を使い、この例外が発生した場合にプログラムを中断させずに処理を続行できるようにしています。例外が捕捉されると、その例外オブジェクト（コード中の変数 $e）からgetMessage()メソッドを呼び出します。これがリファレンス情報にあるmessageプロパティに相当し、引数なしで呼び出すと、エラーの原因を説明する具体的なメッセージ文字列（string）を返します。

サンプルでは、取得したエラーメッセージを連想配列に格納し、messagepackという形式に変換して返却しています。このようにmessageプロパティを利用することで、エラーの原因を正確に把握し、APIの利用者などに分かりやすい形で通知できます。

Copy
1<?php
2
3/**
4 * メッセージキューから取得された、日付間隔を表す可能性のある文字列を処理する関数です。
5 *
6 * PHP 8 以降では、DateInterval のコンストラクタに不正な文字列が渡されると
7 * DateMalformedIntervalStringException がスローされます。
8 * この関数は、このような例外を捕捉し、例外の `message` プロパティから
9 * エラーの詳細情報を取得して表示する例を示しています。
10 *
11 * これは、メッセージキューシステムで日付データを含むメッセージを処理する
12 * ワーカープロセスでの、堅牢なエラーハンドリングの一例として考えられます。
13 *
14 * @param string $intervalString メッセージキューから取得されたと仮定する日付間隔文字列
15 * @return void
16 */
17function processMessageFromQueue(string $intervalString): void
18{
19    echo "--- Start processing message ---\n";
20    echo "Received interval string: \"{$intervalString}\"\n";
21
22    try {
23        // DateInterval オブジェクトを作成しようと試みる
24        // 不正な文字列の場合、DateMalformedIntervalStringException がスローされる
25        $interval = new DateInterval($intervalString);
26
27        // 正常にパースできた場合
28        echo "  Status: Successfully parsed interval.\n";
29        echo "  Parsed interval: " . $interval->format('%Y years, %M months, %D days, %H hours, %I minutes, %S seconds') . "\n";
30
31    } catch (DateMalformedIntervalStringException $e) {
32        // DateMalformedIntervalStringException を捕捉した場合
33        // リファレンス情報に従い、例外オブジェクトの `message` プロパティに直接アクセスして
34        // エラーメッセージを取得します。
35        echo "  Status: Failed to parse interval due to malformed string.\n";
36        echo "  Error details (from exception message property): " . $e->message . "\n";
37        echo "  Exception type: " . get_class($e) . "\n";
38
39    } catch (Exception $e) {
40        // DateMalformedIntervalStringException 以外の予期せぬ例外を捕捉した場合
41        echo "  Status: An unexpected error occurred.\n";
42        echo "  Error details: " . $e->getMessage() . "\n";
43        echo "  Exception type: " . get_class($e) . "\n";
44    }
45
46    echo "--- End processing message ---\n\n";
47}
48
49// --- メッセージキューから取得されたと仮定する文字列の例 ---
50
51// 1. 正常な日付間隔文字列の例
52// (例: 1年2ヶ月3日4時間5分6秒)
53processMessageFromQueue('P1Y2M3DT4H5M6S');
54
55// 2. フォーマットが不正な日付間隔文字列の例 (DateMalformedIntervalStringException が発生)
56//    'P' プレフィックスがないため、DateInterval コンストラクタが不正と判断します。
57processMessageFromQueue('1Y2M3DT4H5M6S');
58
59// 3. 不明な文字が含まれる不正な日付間隔文字列の例 (DateMalformedIntervalStringException が発生)
60//    'X' が不正な時間指定であるため、例外がスローされます。
61processMessageFromQueue('P1Y2M3DT4H5M6X');
62
63// 4. 全く日付間隔ではない文字列の例 (DateMalformedIntervalStringException が発生)
64processMessageFromQueue('This is not an interval string.');
65
66?>

このPHPサンプルコードは、メッセージキューなど外部から受け取った「時間の期間」を表す文字列を安全に処理する方法を示しています。中心となるのは、DateIntervalクラスのオブジェクトを生成する際の例外処理です。

processMessageFromQueue関数は、引数で受け取った文字列をnew DateInterval()で時間の期間オブジェクトに変換しようと試みます。文字列の形式が正しい場合は処理が成功しますが、PHP 8以降では、"P1Y"のような所定の形式でない文字列が渡されるとDateMalformedIntervalStringExceptionという専用の例外が発生します。

try-catch構文は、この例外が発生した場合にプログラムが停止しないよう、処理を捕捉するために使われます。捕捉した例外オブジェクトは変数 $e に格納され、そのmessageプロパティ（$e->message）を参照することで、なぜエラーになったのかという具体的な理由を文字列として取得できます。このmessageプロパティに引数はなく、戻り値としてエラーメッセージの文字列が返されます。この仕組みにより、不正なデータが原因でエラーが発生しても、その詳細を記録し、処理を継続するような堅牢なシステムを構築できます。