【PHP8.x】OutOfRangeException::getLine()メソッドの使い方

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

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

基本的な使い方

getLineメソッドは、OutOfRangeException例外がスローされたソースコードの行番号を取得するメソッドです。このメソッドは、PHPの例外処理の基本となるThrowableインターフェースで定義され、Exceptionクラスから継承されているため、OutOfRangeExceptionだけでなく、他の多くの例外クラスでも同様に利用できます。OutOfRangeExceptionは、配列などで定義された範囲外のキーやインデックスにアクセスしようとした際に発生する実行時エラーです。プログラムのデバッグにおいて、エラーが発生した正確な場所を特定することは非常に重要です。try-catchブロックでOutOfRangeExceptionを捕捉した際に、このgetLineメソッドを呼び出すことで、問題が発生したコード行を特定し、迅速な原因究明と修正に役立てることができます。メソッドの返り値は、例外が生成された行番号を示す整数（int）です。このように、getLineメソッドは、コードのどこで範囲外アクセスが発生したかを突き止めるための重要なデバッグ情報を提供します。

構文(syntax)


1<?php
2
3try {
4    $array = ['apple', 'banana'];
5    $value = $array[5];
6} catch (OutOfRangeException $e) {
7    echo $e->getLine();
8}
9
10?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

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

サンプルコード

PHP OutOfRangeExceptionで例外発生行を取得する


1<?php
2
3declare(strict_types=1);
4
5/**
6 * 配列から指定されたインデックスの要素を取得する。
7 * 範囲外の場合はOutOfRangeExceptionをスローする。
8 *
9 * @param array<int, string> $data データ配列
10 * @param int $index 取得する要素のインデックス
11 * @throws OutOfRangeException インデックスが範囲外の場合
12 */
13function getItemByIndex(array $data, int $index): void
14{
15    if (!isset($data[$index])) {
16        // インデックスが配列の範囲外の場合、例外をスローする。
17        // getLine()メソッドは、この `throw` が記述されている行番号を返します。
18        throw new OutOfRangeException('指定されたインデックスは範囲外です。');
19    }
20
21    echo "要素: " . $data[$index] . PHP_EOL;
22}
23
24// サンプル配列
25$fruits = ['apple', 'orange', 'grape'];
26// 存在しないインデックスをわざと指定
27$invalidIndex = 5;
28
29try {
30    // 例外が発生する可能性のある関数を呼び出す
31    echo "インデックス {$invalidIndex} の要素を取得しようとします..." . PHP_EOL;
32    getItemByIndex($fruits, $invalidIndex);
33} catch (OutOfRangeException $e) {
34    // スローされた例外をキャッチする
35    echo 'エラーが発生しました。' . PHP_EOL;
36    echo 'メッセージ: ' . $e->getMessage() . PHP_EOL;
37
38    // getLine()メソッドで、例外がスローされた行番号を取得して表示
39    $line = $e->getLine();
40    echo "例外の発生行: {$line} 行目" . PHP_EOL;
41}

OutOfRangeException::getLine()は、例外がスロー（発生）されたソースコードの行番号を取得するためのメソッドです。このメソッドはOutOfRangeExceptionのオブジェクトに対して使用します。引数はなく、戻り値として例外が発生した行番号を整数(int)で返します。

サンプルコードでは、getItemByIndex関数が配列の範囲外のインデックスを指定された場合にOutOfRangeExceptionをスローします。プログラムの後半部分で、この関数をわざと範囲外のインデックスで呼び出し、意図的に例外を発生させています。

try...catch構文のcatchブロックでは、スローされた例外オブジェクトを$eという変数で受け取っています。そして、$e->getLine()を呼び出すことで、実際にthrow new OutOfRangeException(...)と記述された行の番号を取得し、画面に表示しています。このように、getLine()メソッドは、プログラムのどこでエラーが発生したかを正確に特定するのに役立ち、デバッグ作業を効率的に進めるために利用されます。

getLine()メソッドは、例外を処理しているcatchブロックの行番号ではなく、例外が実際にthrowされた箇所の行番号を返します。このサンプルコードでは、関数内でthrow new OutOfRangeException(...)と書かれている行が該当します。この機能は、エラーメッセージと組み合わせることで、プログラムのどこで問題が発生したのかを正確に特定するのに役立ち、デバッグ作業で非常に重要です。また、OutOfRangeExceptionのように、エラーの種類に応じた適切な例外クラスを選択することもコードの可読性を高めます。try...catch構文でエラーを捕捉しない場合、プログラムは致命的なエラーで停止してしまうため、例外が発生しうる処理は適切に囲むことが安全なコード作成に繋がります。