【PHP8.x】getLineメソッドの使い方

getLineメソッドの使い方について、初心者にもわかりやすく解説します。

作成日: 2025年09月11日更新日: 2025年10月16日

基本的な使い方

getLineメソッドは、PHP 8で導入されたClosedGeneratorExceptionクラスに属し、例外が発生したソースコードの行番号を取得するために使用されるメソッドです。ClosedGeneratorExceptionは、PHPのジェネレータが既に閉じられた（処理が完了したか、エラーで終了した）後に、さらにそのジェネレータに対して値の送信などの操作を試みた場合に発生する特定の例外を表します。

このgetLineメソッドを使用することで、ClosedGeneratorExceptionが発生した際に、プログラムのどの行で問題が起きたのかを正確に把握することができます。これは、システムエンジニアがプログラムのエラーを特定し、デバッグ（問題解決）作業を進める上で非常に重要な情報となります。

具体的には、例外オブジェクトからこのメソッドを呼び出すことで、問題の原因となっているソースコードの行番号を整数値として取得できます。例えば、ジェネレータの誤った使用によってこの例外が発生した場合、getLineメソッドの戻り値を見ることで、どの行のコードが閉じたジェネレータにアクセスしようとしたのかを素早く特定できます。このメソッドは引数を取らず、例外が発生した行番号を返します。このように、getLineメソッドは、開発者が効率的にプログラムの不具合を修正し、安定したシステムを構築するために不可欠な機能を提供しています。

構文(syntax)


1<?php
2$exception = new ClosedGeneratorException();
3$line = $exception->getLine();

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

このメソッドは、例外が発生したソースコードの行番号を整数型で返します。

サンプルコード

PHP例外 getLine 行番号を取得する


1<?php
2
3/**
4 * ClosedGeneratorException::getLine() メソッドの使用例を示します。
5 * この例外は、既に閉じられたジェネレータから値を読み取ろうとしたときに発生します。
6 * getLine() メソッドは、例外がスローされたコードの行番号を整数 (int) で返します。
7 */
8
9/**
10 * シンプルなジェネレータ関数を定義します。
11 * @return Generator
12 */
13function simpleGenerator(): Generator
14{
15    yield 1;
16    yield 2;
17    // このジェネレータは、完全にイテレートされると閉じられた状態になります。
18}
19
20/**
21 * ClosedGeneratorException::getLine() の動作をデモンストレーションします。
22 */
23function demonstrateClosedGeneratorExceptionGetLine(): void
24{
25    try {
26        // ジェネレータを作成します。
27        $generator = simpleGenerator();
28
29        echo "ジェネレータを完全にイテレートします..." . PHP_EOL;
30        // ジェネレータを完全にイテレートすることで、閉じられた状態にします。
31        foreach ($generator as $value) {
32            echo "取得した値: " . $value . PHP_EOL;
33        }
34
35        echo "\n閉じられたジェネレータにアクセスを試みます (ここで例外が発生します)..." . PHP_EOL;
36        // 閉じられたジェネレータに対して値を読み取ろうとすると、
37        // ClosedGeneratorException がスローされます。
38        // 以下の行が例外発生行として報告されます。
39        $generator->current(); 
40
41    } catch (ClosedGeneratorException $e) {
42        // ClosedGeneratorException を捕捉します。
43        echo "\nClosedGeneratorException を捕捉しました。" . PHP_EOL;
44        echo "エラーメッセージ: " . $e->getMessage() . PHP_EOL;
45        // getLine() メソッドで例外が発生したコードの行番号を取得します。
46        echo "例外発生行 (getLine): " . $e->getLine() . " 行目" . PHP_EOL;
47        // 例外が発生したファイル名も表示すると、より理解しやすくなります。
48        echo "例外発生ファイル (getFile): " . basename($e->getFile()) . PHP_EOL;
49    } catch (Throwable $e) {
50        // 予期せぬその他の例外を捕捉します。
51        echo "\n予期せぬ例外を捕捉しました: " . $e->getMessage() . PHP_EOL;
52    }
53}
54
55// デモンストレーション関数を実行します。
56demonstrateClosedGeneratorExceptionGetLine();

PHP 8のClosedGeneratorException::getLine()メソッドは、既に閉じられたジェネレータに対して値を読み取ろうとした際に発生するClosedGeneratorExceptionのデバッグを支援します。ジェネレータは一度最後までイテレートされるか、明示的に閉じられると、それ以降はアクセスできなくなります。この閉じられたジェネレータにアクセスしようとするとClosedGeneratorExceptionがスローされます。

getLine()メソッドは引数を取りません。このメソッドを呼び出すと、例外がスローされたPHPコードの正確な行番号を整数（int）として返します。

サンプルコードでは、まずsimpleGenerator関数でジェネレータを作成し、foreachループを使って最後までイテレートすることで、意図的にジェネレータを閉じます。その後に$generator->current()を呼び出すことで、閉じられたジェネレータへのアクセスを試み、ClosedGeneratorExceptionを発生させています。catchブロック内で$e->getLine()を呼び出すことで、例外が実際に発生したコードの行番号が正確に表示されることを確認できます。これにより、問題の箇所を素早く特定し、デバッグ作業を効率的に進めることが可能になります。

このサンプルコードは、閉じられたジェネレータにアクセスしようとした際に発生するClosedGeneratorExceptionを捕捉し、getLine()メソッドで例外発生箇所の行番号を取得する方法を示しています。ジェネレータは一度完全にイテレートされると閉じられた状態になり、その後に再度値を読み取ろうとすると本例外が発生しますので、ジェネレータのライフサイクルに注意してください。getLine()は例外が起きた具体的な行番号を整数で返しますが、デバッグ時にはgetFile()メソッドも併用してファイル名と行番号の両方を確認すると、より正確に問題箇所を特定できます。予期せぬエラーでプログラムが停止するのを防ぐため、本コードのようにtry-catchブロックで適切に例外処理を行うことが重要です。