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

Copy
1<?php
2
3/**
4 * ClosedGeneratorException の 'line' プロパティの使用例を示す関数です。
5 * ジェネレーターが既に閉じられている状態で操作を試みると発生する例外を捕捉し、
6 * 例外が発生した行番号を表示します。
7 */
8function demonstrateClosedGeneratorExceptionLineProperty(): void
9{
10    /**
11     * 閉じられるジェネレーター関数を定義します。
12     * 'yield 1' の後、すぐに 'return' するため、一度イテレートされると閉じられます。
13     */
14    $generator = (static function () {
15        yield 1;
16        // この 'return' が実行されることでジェネレーターは閉じられた状態になります。
17        return;
18    })(); // 即時実行してジェネレーターオブジェクトを作成
19
20    // ジェネレーターを一度イテレートして、'yield 1' を実行し、その後 'return' に到達させます。
21    // これにより、$generator オブジェクトは閉じられた状態になります。
22    foreach ($generator as $value) {
23        // このループは一度だけ実行されます。
24        // echo "最初に取得した値: " . $value . "\n";
25    }
26
27    // 閉じられたジェネレーターに対して、再び操作を試みます。
28    // これは ClosedGeneratorException をスローします。
29    try {
30        // ジェネレーターが既に閉じているため、この行で ClosedGeneratorException が発生します。
31        $generator->next();
32    } catch (ClosedGeneratorException $e) {
33        // 捕捉した ClosedGeneratorException オブジェクトから 'line' プロパティにアクセスし、
34        // 例外がスローされた正確な行番号を取得して表示します。
35        echo "ClosedGeneratorException が捕捉されました。\n";
36        echo "例外が発生した行番号: " . $e->line . "\n";
37    }
38}
39
40// 上記のサンプル関数を実行します。
41demonstrateClosedGeneratorExceptionLineProperty();

このPHPサンプルコードは、ジェネレーターが既に閉じられた状態で操作しようとした際に発生するClosedGeneratorExceptionと、その例外オブジェクトが持つlineプロパティの使用方法を示しています。

まず、ジェネレーター関数を定義し、値を一度yield（生成）した後に即座に終了するよう設定します。これにより、このジェネレーターは一度イテレートされると「閉じた」状態になります。

次に、定義したジェネレーターをforeachループで一度実行し、意図的に閉じられた状態にします。その後、閉じられたジェネレーターに対してnext()メソッドを呼び出し、再び操作を試みます。ジェネレーターは既に閉じているため、この操作は許可されず、ClosedGeneratorExceptionがスローされます。

コードはtry-catchブロックを使用してこの例外を捕捉します。捕捉されたClosedGeneratorExceptionオブジェクトは、lineというプロパティを持っています。このlineプロパティは引数を取らず、例外が実際にスローされたコードの行番号を整数（int型）として返します。サンプルでは、このプロパティを利用して、例外が発生した正確な行番号を表示しています。これにより、問題の発生箇所を特定しやすくなります。

Copy
1<?php
2
3/**
4 * ジェネレータ関数を定義します。
5 * このジェネレータは単一の値を yield します。
6 */
7function createClosedGeneratorExample(): Generator
8{
9    yield 'データ';
10}
11
12try {
13    // ジェネレータインスタンスを作成します。
14    $generator = createClosedGeneratorExample();
15
16    // ジェネレータを完全に消費し、閉じられた状態にします。
17    // foreach ループが終了すると、ジェネレータは閉じられます。
18    foreach ($generator as $value) {
19        echo "ジェネレータからの値: " . $value . PHP_EOL;
20    }
21
22    // 閉じられたジェネレータに対して next() メソッドを呼び出すと、
23    // ClosedGeneratorException がスローされます。
24    // この行の番号が例外発生箇所として記録されます。
25    $generator->next(); // << この行で ClosedGeneratorException が発生します
26
27} catch (ClosedGeneratorException $e) {
28    // ClosedGeneratorException を捕捉します。
29    echo "--- ClosedGeneratorException が捕捉されました ---" . PHP_EOL;
30    echo "例外メッセージ: " . $e->getMessage() . PHP_EOL;
31    // 例外が発生したコードの行番号を取得し、表示します。
32    // ここで取得される行番号は、$generator->next(); の行を示します。
33    echo "例外発生行: " . $e->getLine() . PHP_EOL;
34
35} catch (Exception $e) {
36    // その他の予期せぬ例外を捕捉します。
37    echo "--- 予期せぬ例外が捕捉されました ---" . PHP_EOL;
38    echo "例外メッセージ: " . $e->getMessage() . PHP_EOL;
39    echo "例外発生行: " . $e->getLine() . PHP_EOL;
40}
41

このPHPコードは、ジェネレータが閉じられた後に操作しようとした際に発生するClosedGeneratorExceptionと、その例外が発生した行番号を取得する方法を示しています。

まず、createClosedGeneratorExample関数でジェネレータを作成し、foreachループでその値をすべて消費します。これにより、ジェネレータは「閉じられた」状態になります。閉じられたジェネレータに対して$generator->next();を呼び出すと、ClosedGeneratorExceptionがスローされます。

この例外をcatchブロックで捕捉した後、$e->getLine()メソッドを呼び出しています。getLine()メソッドは引数を取らず、例外がスローされたPHPコードの正確な行番号を整数値（int）として返します。これはClosedGeneratorException内部のlineプロパティの値を利用しており、エラー発生箇所の特定に非常に役立ちます。

サンプルコードを実行すると、「例外発生行:」として$generator->next();と記述された行の番号が表示され、例外がどこで発生したかを正確に確認できます。これにより、システムのデバッグやエラーハンドリングを行う際に、問題の原因を素早く特定することが可能になります。