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

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

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

基本的な使い方

getLineメソッドは、PHPのErrorExceptionクラスに所属し、プログラムの実行中にエラーが発生したソースコードの具体的な行番号を取得するために実行されるメソッドです。ErrorExceptionは、PHPが通常発生させるエラーを、より扱いやすい「例外」として処理するための特別なクラスです。このメソッドは、ErrorExceptionインスタンスが発生した際に、そのエラーがどのコードの行で起きたのかを示す整数値を返します。

システム開発において、プログラムに不具合やエラーが発生することは避けられません。開発者がプログラムのエラーを特定し、修正する「デバッグ」作業において、この行番号の情報は非常に重要です。例えば、ウェブアプリケーションが予期せぬ動作をした場合、getLineメソッドによってエラーが発生した正確な場所を知ることで、問題の原因を迅速に突き止め、効率的に解決できるようになります。PHP 8を含む現在のPHP環境において、堅牢なエラーハンドリングとデバッグを行うための基本的なツールの一つとして活用されています。

構文(syntax)


1<?php
2try {
3    // 例として ErrorException をスローします。
4    // この ErrorException は、通常、PHPの非致命的なエラー（E_WARNINGなど）が
5    // set_error_handler 関数によって捕捉され、カスタムな ErrorException に変換された際に作成されます。
6    throw new ErrorException("テストエラーメッセージ", 0, E_ERROR, __FILE__, __LINE__);
7} catch (ErrorException $e) {
8    // ErrorException オブジェクトから、エラーが発生した行番号を取得します。
9    $lineNumber = $e->getLine();
10}
11?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

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

サンプルコード

PHP ErrorExceptionのgetLine()でエラー行を取得する


1<?php
2
3/**
4 * カスタムエラーハンドラを設定し、PHPのエラーをErrorExceptionに変換します。
5 * これにより、通常のPHPの警告や通知をtry-catchブロックで捕捉できるようになります。
6 */
7set_error_handler(function (int $errno, string $errstr, string $errfile, int $errline): bool {
8    // error_reporting() & $errno でエラーが抑制されていないか確認します (@演算子など)
9    // 抑制されていないエラーのみErrorExceptionとしてスローします
10    if (!(error_reporting() & $errno)) {
11        return false; // PHPの標準エラーハンドラに処理を任せる
12    }
13    // ErrorExceptionをスローし、元のエラーのメッセージ、ファイル名、行番号を渡します
14    throw new ErrorException($errstr, 0, $errno, $errfile, $errline);
15});
16
17/**
18 * PHPの警告や通知を意図的に発生させる関数。
19 * この関数内で発生したエラーがErrorExceptionに変換されます。
20 */
21function causeAnError(): void
22{
23    $data = [];
24    // 存在しない配列キーにアクセスすることで、PHPのNoticeを発生させます。
25    // このNoticeはカスタムエラーハンドラによってErrorExceptionに変換されます。
26    echo $data['undefined_key']; // この行がErrorExceptionの発生源となります。
27}
28
29try {
30    // エラーを発生させる関数を呼び出します。
31    causeAnError();
32} catch (ErrorException $e) {
33    // ErrorExceptionが捕捉された場合、その詳細を出力します。
34    echo "Caught ErrorException:\n";
35    echo "Message: " . $e->getMessage() . "\n";
36    echo "File: " . $e->getFile() . "\n";
37    // getLine()メソッドを使用して、エラーが発生した元の行番号を取得します。
38    echo "Line where the error originated: " . $e->getLine() . "\n";
39} catch (Exception $e) {
40    // その他の一般的な例外を捕捉します。
41    echo "Caught general Exception: " . $e->getMessage() . "\n";
42} finally {
43    // エラーハンドラを元の状態に戻します。
44    restore_error_handler();
45}
46

このサンプルコードは、PHPの通常の警告や通知などのエラーを、プログラムで捕捉可能なErrorExceptionという例外として扱う方法を示しています。まずset_error_handler関数を使って、エラー発生時にErrorExceptionをスローするカスタムエラーハンドラを設定しています。これにより、PHPのランタイムエラーをtry-catchブロックで処理できるようになります。

causeAnError関数内では、意図的に存在しない配列キーにアクセスすることでPHPのNotice（通知）エラーを発生させています。このNoticeは、設定したカスタムエラーハンドラによってErrorExceptionに変換され、try-catchブロックで捕捉されます。

catch (ErrorException $e)ブロックでは、捕捉したErrorExceptionの詳細を表示しています。ここで登場する$e->getLine()メソッドは、このエラーが実際にPHPコードのどの行で発生したのかを示す行番号を整数値（int）で返します。引数は不要です。getLine()メソッドを利用することで、エラーの発生源を正確に特定できるため、問題のデバッグやエラーログの記録に非常に有効です。コードの最後では、エラーハンドラを元の状態に戻しています。

このコードは、PHPの通常のエラー（WarningやNoticeなど）をErrorExceptionとして捕捉するためのカスタムエラーハンドラの設定例です。set_error_handlerを設定すると、通常はPHPが報告するだけのエラーもtry-catchブロックで扱えるようになります。しかし、この設定はグローバルに影響するため、一時的に設定し、処理が終わったら必ずfinallyブロックでrestore_error_handler()を呼び出して元のエラーハンドラに戻す必要があります。ErrorException::getLine()メソッドは、元のPHPエラーがどの行で発生したかを正確に取得でき、デバッグ時に大変役立ちます。また、@演算子などで抑制されたエラーは、カスタムハンドラでは処理しないように考慮されており、意図しない例外発生を防いでいます。