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

Copy
1<?php
2
3/**
4 * DateExceptionを捕捉し、例外が発生した行番号（line number）を表示する関数。
5 * 
6 * 不正な日付フォーマットをDateTimeImmutableのコンストラクタに渡すことで、
7 * 意図的にDateExceptionを発生させます。
8 * catchブロックでは、例外オブジェクトのgetLine()メソッド（lineプロパティ）を
9 * 使って、エラーが発生したソースコードの行番号を取得し、
10 * 改行（line break）を挟んでメッセージと共に出力します。
11 */
12function demonstrateDateExceptionLine(): void
13{
14    try {
15        // この行で無効な日付文字列を渡すことで、DateExceptionがスローされます。
16        // PHPエンジンは、この例外が発生した「行(line)」の番号を記憶します。
17        $date = new DateTimeImmutable('invalid-date-string');
18
19        // 例外がスローされるため、この行は実行されません。
20        echo $date->format('Y-m-d');
21
22    } catch (DateException $e) {
23        // スローされたDateExceptionオブジェクトを捕捉します。
24
25        // getLine()メソッドは、例外が発生した行番号を返します。
26        // これは $e->line プロパティにアクセスするのと同じです。
27        $errorLine = $e->getLine();
28
29        // 取得したエラー情報と行番号を、改行(line break)を付けて表示します。
30        // PHP_EOLは、実行環境に適した改行コードに置き換えられます。
31        echo "エラーが発生しました。" . PHP_EOL;
32        echo "ファイル: " . $e->getFile() . PHP_EOL;
33        echo "発生行: " . $errorLine . "行目" . PHP_EOL;
34        echo "メッセージ: " . $e->getMessage() . PHP_EOL;
35    }
36}
37
38// 関数を実行します。
39demonstrateDateExceptionLine();
40

このPHPサンプルコードは、日付や時刻の処理でエラーが発生した際に投げられるDateExceptionを捕捉し、そのエラーがソースコードの何行目で発生したかを取得して表示する例です。

tryブロックでは、DateTimeImmutableクラスにわざと不正な形式の日付文字列を渡すことで、意図的にDateExceptionを発生させています。

catchブロックでは、発生したDateExceptionオブジェクト（変数$e）を捕捉します。このオブジェクトはエラーに関する詳細情報を持っています。$e->lineプロパティ（または同じ役割を持つ$e->getLine()メソッド）にアクセスすると、例外が発生したソースコードの行番号をint型（整数）の戻り値として取得できます。

このように、エラーが発生した正確な行番号を知ることは、プログラムの不具合を修正するデバッグ作業において非常に役立ちます。コードの最後では、取得した行番号をファイル名やエラーメッセージと共に出力しています。各情報の間にPHP_EOLを挟むことで、実行環境に適した改行（line break）が挿入され、出力が読みやすくなります。

Copy
1<?php
2
3/**
4 * このスクリプトは、PHPのDateExceptionとその`line`プロパティの基本的な使い方を示します。
5 * `line`プロパティは、例外がスローされたPHPコードの行番号を整数で返します。
6 * 初心者でも理解しやすいように、意図的にDateExceptionを発生させています。
7 */
8
9try {
10    // 日付文字列とそのフォーマットを定義します。
11    $invalidDateString = "2023-13-01"; // 意図的に無効な月（13月）を設定します。
12    $dateFormat = "Y-m-d";
13
14    // `DateTime::createFromFormat` を使用して、指定されたフォーマットで日付を解析しようとします。
15    // 解析に失敗した場合、この関数は `false` を返します。
16    $dateObject = DateTime::createFromFormat($dateFormat, $invalidDateString);
17
18    // 解析が失敗したかどうかを確認します。
19    if ($dateObject === false) {
20        // この行でDateExceptionを明示的にスローします。
21        // DateExceptionの`line`プロパティは、この行番号（このthrow文のある行）を返します。
22        throw new DateException(
23            "指定された日付 '{$invalidDateString}' は形式 '{$dateFormat}' で解析できませんでした。"
24        );
25    }
26
27    // 日付が正常に解析された場合は、以下のメッセージが出力されます。
28    echo "日付は正常に解析されました: " . $dateObject->format('Y-m-d') . PHP_EOL;
29
30} catch (DateException $e) {
31    // `DateException`が捕捉された場合に、このブロックが実行されます。
32    echo "DateExceptionを捕捉しました！" . PHP_EOL;
33    echo "メッセージ: " . $e->getMessage() . PHP_EOL;
34    
35    // `getLine()`メソッドを使用して、例外がスローされたPHPコードの行番号を取得します。
36    // `PHP_EOL`は、プラットフォームに適した改行コードを出力し、表示を見やすくします。
37    echo "例外がスローされた行番号: " . $e->getLine() . PHP_EOL;
38    
39    echo "例外が発生したファイル: " . $e->getFile() . PHP_EOL;
40} catch (Exception $e) {
41    // 予期せぬ他の一般的な例外が捕捉された場合に実行されます。
42    echo "予期せぬ例外を捕捉しました！" . PHP_EOL;
43    echo "メッセージ: " . $e->getMessage() . PHP_EOL;
44    echo "行番号: " . $e->getLine() . PHP_EOL;
45}
46

このPHPサンプルコードは、日付や時刻の処理でエラーが発生した際に用いられるDateExceptionクラスと、そのlineプロパティの基本的な使い方を解説するものです。lineプロパティは、例外（エラー）がスローされたコード上の行番号を保持します。

このコードでは、tryブロック内で意図的に無効な日付文字列（13月）を定義し、日付の解析に失敗した際にthrow new DateException(...)を用いて明示的に例外を発生させています。発生した例外はcatchブロックで捕捉されます。

catchブロック内の$e->getLine()は、捕捉した例外オブジェクト$eから、エラーが発生した行番号を取得するためのメソッドです。このメソッドは引数を取らず、戻り値として行番号を整数(int)で返します。実行すると、throw new DateException(...)が記述されている行の番号が出力されます。このように、getLine()メソッドを使うことで、プログラムのどこで問題が起きたかを正確に特定でき、デバッグ作業で非常に役立ちます。また、echo文のPHP_EOLは、見やすいように改行を入れるためのPHPの定数です。