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

Copy
1<?php
2
3// このコードは、DateObjectError をキャッチし、その getLine() メソッドを使用して
4// エラーが発生した行番号を取得する方法を示します。
5//
6// 注意: DateObjectError は、PHP 8.1 以降で内部の日付関数が失敗した場合にスローされます。
7// PHP 8.0 では、これらの関数は通常 `false` を返します。
8
9/**
10 * 無効な入力で DateTimeImmutable オブジェクトを作成しようとし、
11 * 結果として発生する DateObjectError をキャッチし、
12 * getLine() を使用してエラーが発生した行番号を表示します。
13 */
14function demonstrateDateObjectErrorGetLine(): void
15{
16    echo "無効な日付文字列で DateTimeImmutable オブジェクトを作成しようとしています...\n";
17
18    try {
19        // 次の行は、PHP 8.1 以降で DateObjectError をスローすることが期待されます。
20        // これは、'not-a-date' が 'Y-m-d' フォーマットでパースできないためです。
21        $invalidDate = date_create_immutable_from_format('Y-m-d', 'not-a-date'); // エラー発生源の行
22
23        // ここにコードが到達した場合、DateObjectError はスローされませんでした。
24        // これは、date_create_immutable_from_format が失敗時に `false` を返す
25        // PHP 8.1 未満のバージョンで実行された場合に発生する可能性があります。
26        if ($invalidDate === false) {
27            echo "警告: 'date_create_immutable_from_format' が false を返しました。";
28            echo "DateObjectError は通常 PHP 8.1+ でスローされます。\n";
29        } else {
30            echo "予期せぬ結果: DateTimeImmutable オブジェクトが正常に作成されました。\n";
31        }
32
33    } catch (DateObjectError $e) {
34        // 特定の DateObjectError をキャッチします。
35        echo "DateObjectError をキャッチしました！\n";
36        echo "エラーメッセージ: " . $e->getMessage() . "\n";
37        // getLine() を使用して、例外がスローされた行番号を取得します。
38        echo "エラーが発生した行: " . $e->getLine() . "\n";
39    } catch (Throwable $e) {
40        // その他の予期せぬ例外をキャッチします。
41        echo "予期せぬ例外 (" . get_class($e) . ") をキャッチしました:\n";
42        echo "エラーメッセージ: " . $e->getMessage() . "\n";
43        echo "エラーが発生した行: " . $e->getLine() . "\n";
44    }
45}
46
47// デモンストレーション関数を実行します。
48demonstrateDateObjectErrorGetLine();
49

DateObjectError::getLine()は、PHP 8.1以降で日付関連の処理で問題が起きた際に発生するDateObjectErrorという例外から、ソースコード上のエラー発生行番号を取得するメソッドです。引数は不要で、エラーが起きた行番号を整数（int）で返します。

サンプルコードでは、存在しない日付形式でdate_create_immutable_from_format関数を実行し、意図的にDateObjectErrorを発生させています。try-catchブロックでこの例外を捕まえた後、キャッチした例外オブジェクトに対して$e->getLine()を呼び出すことで、エラーが起きた具体的な行番号が表示されます。この機能は、プログラムのどこで問題が発生したかを正確に特定し、デバッグを効率的に行うために非常に役立ちます。なお、PHP 8.0以前のバージョンでは、これらの日付関数は失敗時にfalseを返すため、DateObjectErrorは発生しない点に注意が必要です。