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

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

作成日: 更新日:

基本的な使い方

『getLineメソッドは、例外がスローされたソースコードの行番号を取得するメソッドです』 このメソッドは、InvalidArgumentExceptionクラスが直接持つものではなく、その親クラスであるExceptionクラスから継承された機能です。InvalidArgumentExceptionは、関数やメソッドに渡された引数の型や値が期待されるものと異なっている、といった不正な引数が原因で発生する例外です。プログラムの実行中にこの例外が発生し、try-catch構文で捕捉された際、その例外オブジェクトに対してgetLine()メソッドを呼び出すことで、例外がどのファイルの何行目で発生したのかを正確に特定できます。この行番号情報は、エラーの原因箇所を迅速に突き止め、修正作業を行うデバッグの過程において極めて重要です。返り値は行番号を示す整数(int)となります。一般的には、例外が発生したファイル名を取得するgetFile()メソッドと組み合わせて、エラーログなどに出力するために使用されます。

構文(syntax)

1<?php
2
3function processUserInput(string $name)
4{
5    if (empty($name)) {
6        // InvalidArgumentExceptionをスローする
7        throw new InvalidArgumentException('名前は空にできません。');
8    }
9    // ...処理...
10}
11
12try {
13    processUserInput('');
14} catch (InvalidArgumentException $e) {
15    // final public getLine(): int
16    $errorLine = $e->getLine();
17
18    echo "エラーが発生した行番号: " . $errorLine;
19}

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

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

関連コンテンツ