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

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

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

基本的な使い方

getLineメソッドは、OutOfBoundsException例外が発生したソースコードの行番号を取得するメソッドです。OutOfBoundsExceptionは、配列などで範囲外のインデックスにアクセスしようとした場合など、無効なキーをリクエストした際にスローされる例外です。プログラムの実行中にこの例外が発生すると、どのコードが原因で問題が起きたのかを特定する必要があります。このgetLineメソッドを使用することで、例外がスローされた具体的な行番号を整数値として取得できるため、デバッグ作業を迅速かつ正確に進めることが可能になります。通常、このメソッドはtry...catchブロック内で捕捉した例外オブジェクトに対して呼び出します。例えば、getFile()メソッドでファイルパスを、getMessage()メソッドでエラーメッセージを取得し、このgetLine()メソッドで得られる行番号と組み合わせることで、エラーの原因究明に必要な詳細な情報を得ることができます。このメソッドは、基底クラスであるExceptionクラスで定義されているため、OutOfBoundsExceptionだけでなくPHPの多くの標準例外クラスで共通して利用可能です。

構文(syntax)


1<?php
2
3try {
4    // 4行目で意図的に例外をスローします
5    throw new OutOfBoundsException();
6} catch (OutOfBoundsException $e) {
7    // 例外がスローされた行番号 (この場合は 4) を取得して出力します
8    echo $e->getLine();
9}

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

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

サンプルコード

PHP OutOfBoundsException getLine で行番号を取得する


1<?php
2declare(strict_types=1);
3
4/**
5 * 配列から指定されたインデックスの要素を取得します。
6 * インデックスが存在しない場合、OutOfBoundsException をスローします。
7 *
8 * @param array<int, string> $data データ配列
9 * @param int $index 取得する要素のインデックス
10 * @return string
11 * @throws OutOfBoundsException
12 */
13function getElementByIndex(array $data, int $index): string
14{
15    if (!isset($data[$index])) {
16        // ここで例外がスローされます。
17        // getLine() は、この 'throw' 文がある行の番号を返します。
18        throw new OutOfBoundsException("インデックス {$index} は範囲外です。");
19    }
20    return $data[$index];
21}
22
23$sampleArray = ['Apple', 'Banana', 'Cherry'];
24
25try {
26    // 存在しないインデックス(5)にアクセスし、意図的に例外を発生させる
27    $element = getElementByIndex($sampleArray, 5);
28    echo $element . PHP_EOL;
29} catch (OutOfBoundsException $e) {
30    // スローされた例外をキャッチする
31    echo "エラー: " . $e->getMessage() . PHP_EOL;
32    
33    // getLine() メソッドを使い、例外がスローされた行番号を取得して表示する
34    echo "例外が発生した行番号: " . $e->getLine() . PHP_EOL;
35}

PHPのOutOfBoundsExceptionクラスに属するgetLine()メソッドは、例外がスロー（発生）されたソースコードの行番号を取得するために使用します。このメソッドは、プログラムのどこでエラーが起きたのかを特定するデバッグ作業で非常に役立ちます。

このメソッドは引数を必要としません。戻り値として、例外がthrowされた行の番号が整数(int)型で返されます。

サンプルコードでは、まずgetElementByIndex関数が配列の範囲外のインデックスにアクセスしようとした際にOutOfBoundsExceptionをスローするように定義されています。次にtryブロック内で、この関数を使って意図的に例外を発生させます。

catchブロックでは、発生した例外オブジェクトを$eという変数で捕捉（キャッチ）しています。そして、$e->getLine()を呼び出すことで、throw new OutOfBoundsException(...)と書かれた行の番号を取得し、それを出力しています。このようにgetLine()メソッドを使うことで、エラーの発生箇所を正確に把握できます。

getLine()メソッドは、例外が捕捉されたcatchブロックの行番号ではなく、throwキーワードで例外がスローされた箇所の行番号を返す点に注意してください。この機能は、エラーログを記録する際に、ファイル名を取得するgetFile()やエラー内容を示すgetMessage()と組み合わせることで、問題発生箇所を正確に特定でき、デバッグ作業が効率的になります。サンプルコードのように、配列の範囲外アクセスなどをisset()で事前にチェックし、OutOfBoundsExceptionを明示的にスローする設計は、エラーの原因を明確にし、プログラムの安定性を高めるための重要な手法です。