【PHP8.x】lineプロパティの使い方

Copy
1<?php
2
3/**
4 * DateObjectError の line プロパティの使用例を示します。
5 *
6 * この関数は、不正な日付文字列から DateTimeImmutable オブジェクトを生成することで、
7 * 意図的に DateObjectError を発生させます。
8 * catch ブロックで例外を捕捉し、line プロパティ (getLine() メソッド経由) を使って
9 * エラーが発生したソースコードの行番号を取得して表示します。
10 *
11 * キーワード「line break」は、各出力の末尾に改行 (PHP_EOL) を追加することで表現しています。
12 *
13 * @note このサンプルコードは PHP 8.3 以降で正しく動作します。
14 */
15function showErrorLineNumberExample(): void
16{
17    try {
18        // 不正な日付文字列をコンストラクタに渡します。
19        // PHP 8.3以降では、この行で DateObjectError がスローされます。
20        $date = new \DateTimeImmutable('this-is-not-a-valid-date');
21
22        // エラーが発生した場合、この行は実行されません。
23        echo '日付オブジェクトが正常に作成されました。' . PHP_EOL;
24
25    } catch (\DateObjectError $e) {
26        // スローされた DateObjectError 例外をここで捕捉します。
27        echo 'エラーが発生しました。詳細は以下の通りです。' . PHP_EOL;
28        echo '------------------------------------------' . PHP_EOL;
29
30        // getMessage() でエラーメッセージを取得して表示します。
31        echo 'メッセージ: ' . $e->getMessage() . PHP_EOL;
32
33        // getFile() でエラーが発生したファイル名を取得して表示します。
34        echo 'ファイル名: ' . $e->getFile() . PHP_EOL;
35
36        // getLine() でエラーが発生した行番号 (line プロパティの値) を取得して表示します。
37        echo '発生行番号: ' . $e->getLine() . PHP_EOL;
38
39        echo '------------------------------------------' . PHP_EOL;
40    }
41}
42
43// DateObjectError クラスは PHP 8.3 で導入されたため、
44// 実行前にクラスの存在を確認し、互換性を保ちます。
45if (class_exists('DateObjectError')) {
46    showErrorLineNumberExample();
47} else {
48    echo 'このサンプルコードを実行するには PHP 8.3 以降が必要です。' . PHP_EOL;
49    echo '現在の PHP バージョン: ' . PHP_VERSION . PHP_EOL;
50}
51

このPHPサンプルコードは、DateObjectErrorクラスが持つlineプロパティの使い方を説明するものです。lineプロパティは、日付や時刻に関連する処理でエラーが発生した際に、そのエラーがソースコードの何行目で起きたかという行番号を保持します。

コードでは、tryブロック内でnew DateTimeImmutable('this-is-not-a-valid-date')のように、意図的に不正な形式の日付文字列をコンストラクタに渡しています。PHP 8.3以降では、この処理が失敗するとDateObjectErrorという種類の例外（エラー）が発生し、プログラムの実行が中断されます。

発生した例外は続くcatchブロックで捕捉されます。捕捉した例外オブジェクト（変数$e）に対し$e->getLine()メソッドを呼び出すことで、lineプロパティに格納されているエラー発生箇所の行番号を取得できます。このメソッドは引数を取らず、戻り値として行番号を整数（int）で返します。これにより、開発者はエラーの原因となったコードを正確に特定でき、デバッグ作業を効率的に進めることが可能になります。

キーワードの「php line break」は、コード内でecho文の最後にPHP_EOLを付け加えることで、出力結果を改行している部分に対応します。

Copy
1<?php
2
3/**
4 * 日付処理中のエラーを捕捉し、エラーメッセージと発生行を改行付きで出力します。
5 *
6 * PHP 8のDateObjectErrorクラスはThrowableインターフェースを実装しており、
7 * lineプロパティを持ちます。この例では、DateObjectErrorの直接的な発生が難しいため、
8 * Throwableを実装するValueErrorを意図的に発生させてそのline情報を取得します。
9 * DateObjectErrorも同様にgetLine()メソッドで発生行を取得できます。
10 */
11function handleDateRelatedErrorWithLineInfo(): void
12{
13    // PHP_EOLはOSに応じた改行コードを出力します
14    echo "--- エラー処理デモンストレーション ---" . PHP_EOL;
15
16    try {
17        // この行で無効な日付文字列をDateTimeコンストラクタに渡し、ValueErrorを発生させる
18        // このコードの行番号がエラー発生行として報告されます
19        new DateTime('invalid_date_format_example');
20    } catch (Throwable $e) {
21        // Throwableを捕捉することで、DateObjectErrorを含む全てのエラーを扱える
22        echo "エラーが発生しました！" . PHP_EOL;
23        echo "メッセージ: " . $e->getMessage() . PHP_EOL;
24        echo "発生ファイル: " . $e->getFile() . PHP_EOL;
25        // DateObjectError::line（またはThrowable::getLine()）でエラー発生行を取得
26        echo "発生行: " . $e->getLine() . PHP_EOL;
27        echo "--- 処理終了 ---" . PHP_EOL;
28    }
29}
30
31// 関数を実行
32handleDateRelatedErrorWithLineInfo();

このPHPサンプルコードは、日付や時刻の処理中にエラーが発生した際に、そのエラーがコードの何行目で起きたかを取得し、表示する方法を解説するものです。

PHP 8のDateObjectErrorクラスは、エラーが発生した行番号を保持するlineというプロパティを持っています。この情報には、引数が不要で、戻り値として行番号を整数(int)で返すgetLine()メソッドを通じてアクセスするのが一般的です。

サンプルコードでは、tryブロックの中で、わざと不正な日付文字列をDateTimeクラスに渡してエラーを発生させています。catch (Throwable $e)ブロックがそのエラーを捕捉します。ThrowableはDateObjectErrorを含むPHPの様々なエラーをまとめて扱えるため、汎用的なエラー処理に役立ちます。捕捉したエラー情報を持つ変数$eに対し、$e->getLine()を実行することで、エラーが発生した具体的な行番号を取得し、画面に出力しています。

また、echo文の中でPHP_EOLという定数を使うことで、実行環境（OS）に合わせた適切な改行を挿入し、出力を読みやすくしています。このようにエラーの発生箇所を正確に特定する機能は、プログラムの不具合を修正するデバッグ作業において非常に重要です。