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

Copy
1<?php
2
3/**
4 * DateInvalidOperationException の line プロパティの使用例を示します。
5 *
6 * この関数は、不変 (immutable) である DateTimeImmutable オブジェクトに対して
7 * 変更操作を試みることで、意図的に DateInvalidOperationException を発生させます。
8 * 例外が発生すると、その行 (line) で通常の処理フローが中断 (break) され、
9 * catch ブロックに処理が移ります。
10 * catch ブロックでは、例外オブジェクトの getLine() メソッドを使い、
11 * エラーが発生したコードの行番号を取得して表示します。
12 *
13 * @see https://www.php.net/manual/ja/class.dateinvalidoperationexception.php
14 */
15function demonstrate_exception_line_break(): void
16{
17    try {
18        // 不変（変更不可能）な日付オブジェクトを作成します。
19        $immutableDate = new \DateTimeImmutable('2023-10-27');
20        echo "処理を開始します。\n";
21
22        // 不変オブジェクトの状態を変更しようとすると、この行で例外がスローされます。
23        // この行でスクリプトの実行が中断され、catchブロックにジャンプします。
24        $immutableDate->setDate(2024, 1, 1);
25
26        // 上記の行で例外が発生するため、この行は実行されません。
27        echo "このメッセージは表示されません。\n";
28    } catch (\DateInvalidOperationException $e) {
29        // DateInvalidOperationException をキャッチします。
30        echo "例外をキャッチしました。\n";
31        echo "メッセージ: " . $e->getMessage() . "\n";
32
33        // getLine() メソッドで例外がスローされた行番号を取得し表示します。
34        // これは DateInvalidOperationException の line プロパティに相当します。
35        echo "エラー発生行: " . $e->getLine() . "\n";
36    } finally {
37        // 例外の有無にかかわらず、最後に必ず実行されます。
38        echo "処理を終了します。\n";
39    }
40}
41
42// 関数を実行します。
43demonstrate_exception_line_break();

PHPのDateInvalidOperationExceptionクラスが持つlineプロパティは、この例外が発生したソースコード上の行番号を整数（int）で保持します。このプロパティの値は、通常getLine()メソッドを通じて取得します。

サンプルコードでは、DateTimeImmutableオブジェクトを操作しています。このオブジェクトは「不変（immutable）」、つまり一度作成すると値を変更できない性質を持っています。コードが不変オブジェクトの日付を変更しようとする行に到達すると、DateInvalidOperationExceptionが発生します。この時点でプログラムの通常の流れは中断（break）され、直ちにcatchブロックの処理に移ります。そのため、例外発生後のコードは実行されません。

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

Copy
1<?php
2
3/**
4 * DateInvalidOperationException の発生と line プロパティの取得を示すサンプルコードです。
5 *
6 * この関数は、DateTime オブジェクトに無効な操作を実行しようとしたときに発生する
7 * DateInvalidOperationException を捕捉し、その例外が発生した行番号 (line プロパティ) を表示します。
8 *
9 * この例では、開始日が終了日よりも後の DatePeriod を作成しようとして、
10 * 無効な操作を意図的に引き起こしています。
11 */
12function demonstrateDateInvalidOperationExceptionLine(): void
13{
14    echo "--- DateInvalidOperationException の line プロパティ取得例 ---\n\n";
15
16    try {
17        // 有効な開始日と間隔を設定
18        $startDate = new DateTime('2023-01-01');
19        $interval = new DateInterval('P1M'); // 1ヶ月間隔
20
21        // 不正な終了日を設定 (開始日よりも前)
22        $endDate = new DateTime('2022-12-01');
23
24        // 無効な操作: 開始日 ($startDate) が終了日 ($endDate) より後の DatePeriod を作成しようとする
25        // この行で DateInvalidOperationException が発生します。
26        $period = new DatePeriod($startDate, $interval, $endDate); // 例外発生のトリガーとなる行
27
28        // 例外が発生した場合、この下の行は実行されません
29        echo "DatePeriod が正常に作成されました。(このメッセージは通常表示されません)\n";
30
31    } catch (DateInvalidOperationException $e) {
32        // DateInvalidOperationException を捕捉
33        echo "### DateInvalidOperationException が捕捉されました！ ###\n";
34        echo "エラーメッセージ: " . $e->getMessage() . "\n";
35        // 例外が発生したファイル内の行番号を取得し、表示します。
36        echo "例外が発生した行番号 (line プロパティ): " . $e->getLine() . "\n";
37        echo "例外が発生したファイル: " . $e->getFile() . "\n";
38        echo "---------------------------------------------------\n";
39    } catch (Throwable $e) {
40        // DateInvalidOperationException 以外の予期せぬ例外を捕捉する一般的な処理
41        echo "予期せぬエラーが発生しました:\n";
42        echo "エラーメッセージ: " . $e->getMessage() . "\n";
43        echo "行番号: " . $e->getLine() . "\n";
44    }
45
46    echo "\n--- サンプルコードの実行が終了しました ---\n";
47}
48
49// 関数を実行し、例外処理の動作を確認します。
50demonstrateDateInvalidOperationExceptionLine();

このPHPサンプルコードは、日付や時刻の操作で無効な処理が行われた際に発生するDateInvalidOperationExceptionと、その例外がコードのどの行で発生したかを示すlineプロパティの使用例です。

コードでは、tryブロックの中で意図的にエラーを引き起こしています。具体的には、開始日が終了日よりも後になるようなDatePeriodオブジェクトを作成しようとしており、この無効な操作によってDateInvalidOperationExceptionが発生します。

例外が発生すると、処理はcatchブロックに移ります。ここで、例外オブジェクトを変数$eで受け取り、$e->getLine()というメソッドを呼び出しています。このメソッドは、例外インスタンスが内部に保持しているlineプロパティの値を取得するためのものです。getLine()メソッドは引数を取らず、戻り値として例外が発生したソースコード上の行番号を整数(int)で返します。

最終的に、取得した行番号をエラーメッセージなどと共に出力します。これにより、開発者はエラーが発生した正確な場所を特定でき、プログラムの問題解決（デバッグ）を効率的に行うことができます。