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

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

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

基本的な使い方

getLineメソッドは、UnderflowException例外がスローされたソースコードの行番号を取得するメソッドです。このメソッドはUnderflowExceptionクラスに固有のものではなく、基底クラスであるExceptionクラスから継承された機能です。そのため、PHPにおける多くの例外オブジェクトで同様に利用することができます。UnderflowExceptionは、例えば空のデータ構造から要素を取り出そうとするなど、コンテナが空の状態で無効な操作が行われた際に発生します。デバッグの過程でこの例外が発生した際に、getLineメソッドを呼び出すことで、問題を引き起こしたコードがプログラムの何行目に記述されているかを正確に特定できます。メソッドの戻り値は、例外が発生したファイル内の行番号を示す整数値です。try-catchブロックで例外を捕捉した際に、このメソッドが返す行番号をエラーメッセージやログファイルに記録することで、開発者は問題の原因箇所を迅速に発見し、効率的に修正作業を進めることが可能になります。

構文(syntax)


1<?php
2
3try {
4    // ここで UnderflowException が発生する処理があると仮定します
5    throw new UnderflowException();
6} catch (UnderflowException $e) {
7    // 例外がスローされた行番号を取得します
8    $line = $e->getLine();
9    
10    // 取得した行番号を出力します
11    echo $line;
12}

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

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

サンプルコード

PHP UnderflowException getLine()で発生行を取得する


1<?php
2
3declare(strict_types=1);
4
5/**
6 * UnderflowExceptionとgetLine()メソッドの使用例を示すクラス
7 */
8class StackOperation
9{
10    /**
11     * 空のスタックから要素を取り出し、例外を捕捉して発生行を取得する
12     */
13    public function run(): void
14    {
15        // SplStack は後入れ先出し(LIFO)のデータ構造です。
16        $stack = new SplStack();
17
18        try {
19            // この時点でスタックは空です。
20            echo "空のスタックから要素を取り出そうとします..." . PHP_EOL;
21
22            // 空のスタックに対して pop() を呼び出すと、
23            // UnderflowException がこの行でスローされます。
24            $stack->pop();
25
26        } catch (UnderflowException $e) {
27            // スローされた UnderflowException をここで捕捉します。
28
29            // getLine() メソッドを使って、例外がスローされた行番号を取得します。
30            $errorLine = $e->getLine();
31
32            // 捕捉した例外の情報を出力します。
33            echo "エラー: UnderflowException が捕捉されました。" . PHP_EOL;
34            echo "メッセージ: " . $e->getMessage() . PHP_EOL;
35            echo "例外の発生行: " . $errorLine . "行目" . PHP_EOL;
36        }
37    }
38}
39
40// クラスのインスタンスを作成して実行します。
41$stackOperation = new StackOperation();
42$stackOperation->run();

このPHPコードは、UnderflowExceptionクラスに属するgetLine()メソッドの使用例を示しています。UnderflowExceptionは、SplStackのようなデータ構造が空の状態で、そこから要素を取り出そうとするなど、不正なアンダーフロー操作が行われた際に発生する例外です。

getLine()メソッドは、例外がスローされたソースコードの行番号を取得するために使用します。このメソッドに引数は必要なく、戻り値として行番号を表す整数(int)を返します。

サンプルコードでは、まず空のSplStackオブジェクトを作成します。次にtryブロック内で、この空のスタックに対して要素を取り出すpop()メソッドを呼び出すことで、意図的にUnderflowExceptionを発生させています。catchブロックでは、このスローされた例外を捕捉します。そして、捕捉した例外オブジェクトのgetLine()メソッドを呼び出すことで、例外が発生した具体的な行番号を取得し、エラーメッセージと共に出力しています。このようにgetLine()メソッドは、プログラムのどこで問題が起きたかを正確に特定し、デバッグ作業を効率化するのに役立ちます。

getLine()メソッドは、例外が実際に発生したソースコードの行番号を返します。この例では$stack->pop();の行が該当し、例外を捕捉したcatchブロック内の行ではない点に注意が必要です。UnderflowExceptionは、サンプルのように空のスタックからデータを取り出そうとするなど、コンテナが空の状態で要素にアクセスした場合に発生します。この例外を未然に防ぐには、pop()を実行する前に$stack->isEmpty()のようなメソッドでスタックが空でないかを確認するのが安全な方法です。取得した行番号やエラーメッセージは、デバッグ時の原因特定や、エラーログに正確な情報を記録するために非常に役立ちます。