【PHP8.x】OverflowException::lineプロパティの使い方

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * OverflowExceptionを意図的に発生させ、
7 * 捕捉した例外情報からエラーが発生した行番号(line)を取得し、
8 * サーバーのログにその情報を送信（記録）するサンプルコードです。
9 */
10function send_error_log_with_line_number(): void
11{
12    try {
13        // サイズが2の固定長配列を作成します。
14        $fixedArray = new SplFixedArray(2);
15        $fixedArray[0] = 'value 1';
16        $fixedArray[1] = 'value 2';
17
18        // 3番目の要素を追加しようとすると、配列の容量を超えてしまうため、
19        // この行で OverflowException がスローされます。
20        $fixedArray[2] = 'value 3';
21
22    } catch (OverflowException $e) {
23        // catchブロックで例外を捕捉します。
24
25        // $e->getLine() を使って、例外がスローされた行番号を取得します。
26        $errorLine = $e->getLine();
27
28        // エラーメッセージを組み立てます。
29        $logMessage = sprintf(
30            "エラーが発生しました。ファイル: %s, 行番号: %d, メッセージ: %s",
31            $e->getFile(),
32            $errorLine,
33            $e->getMessage()
34        );
35
36        // error_log() 関数を使って、サーバーのログファイルに情報を「送信」します。
37        error_log($logMessage);
38
39        // 実行結果を画面に表示します。
40        echo "配列の容量を超えました。エラー情報をログに送信しました。" . PHP_EOL;
41        echo "エラー発生行: " . $errorLine . "行目" . PHP_EOL;
42    }
43}
44
45// 関数を実行します。
46send_error_log_with_line_number();
47
48?>

このサンプルコードは、PHPでOverflowExceptionという例外が発生した際に、エラーがどの行で起きたかの情報を取得し、その情報をログとしてサーバーに送信（記録）する方法を示しています。コードはtry...catch構文を使い、まずtryブロック内で意図的にエラーを発生させます。ここでは、サイズが2の固定長配列に対し、3番目の要素を追加しようとすることで、容量オーバーを示すOverflowExceptionを発生させています。

次にcatchブロックで、発生した例外オブジェクトを捕捉します。ここで重要なのが$e->getLine()メソッドです。このメソッドは、引数を取らず、戻り値として例外がスローされたソースコード上の行番号を整数(int)で返します。取得した行番号は、ファイル名やエラーメッセージと組み合わせることで、より詳細なログ情報を作成するために利用されます。

最後に、作成したログメッセージをerror_log()関数を使ってサーバーのログファイルに書き込みます。この操作が、ログ情報をサーバーに「送信」する処理に相当します。このようにgetLine()メソッドを活用することで、エラー発生箇所の特定が容易になり、デバッグ作業の効率化に繋がります。

Copy
1<?php
2
3/**
4 * 固定サイズのスタックを表すクラス。
5 */
6class FixedSizeStack
7{
8    private array $stack;
9    private int $maxSize;
10
11    public function __construct(int $size)
12    {
13        $this->stack = [];
14        $this->maxSize = $size;
15    }
16
17    /**
18     * スタックに値を追加します。
19     * 容量を超えた場合は OverflowException をスローします。
20     *
21     * @param mixed $value
22     * @throws OverflowException
23     */
24    public function push(mixed $value): void
25    {
26        if (count($this->stack) >= $this->maxSize) {
27            // 容量オーバー時に例外をスローする
28            throw new OverflowException("スタックの容量を超えました。");
29        }
30        $this->stack[] = $value;
31        echo "{$value} を追加しました。\n";
32    }
33}
34
35// 例外処理の開始
36try {
37    // 容量が2のスタックを作成
38    $stack = new FixedSizeStack(2);
39
40    $stack->push('item1');
41    $stack->push('item2');
42    
43    // この行で OverflowException が発生する
44    $stack->push('item3'); 
45    
46} catch (OverflowException $e) {
47    // 例外をキャッチし、エラー情報を連携して出力する
48    // $e->getLine() を使って例外が発生した行番号を取得
49    $lineNumber = $e->getLine();
50    
51    echo "\nエラーが発生しました。\n";
52    echo "メッセージ: " . $e->getMessage() . "\n";
53    echo "ファイル: " . $e->getFile() . "\n";
54    echo "発生行番号: " . $lineNumber . "\n"; // line プロパティの情報を取得・連携
55}

このPHPコードは、OverflowExceptionが発生した際に、lineプロパティの情報を取得してエラー発生箇所を特定する方法を示しています。OverflowExceptionは、データ構造の容量オーバーなど、実行時のエラーを表す例外です。この例外オブジェクトは、エラーに関する情報を持っており、getLine()メソッドを呼び出すことでlineプロパティに格納された情報を取得できます。

getLine()メソッドは引数を取らず、例外がスローされたソースコードの行番号を整数(int)で返します。

サンプルコードでは、容量が2の固定サイズスタックに3つの値を追加しようとしています。3回目のpushメソッドが呼び出された行で容量オーバーとなり、OverflowExceptionが発生します。try...catch構文によってこの例外が捕捉され、catchブロック内で$e->getLine()が実行されます。これにより、例外が発生した具体的な行番号が取得されます。取得した行番号は、エラーメッセージやファイル名といった他の情報と連携して出力され、デバッグ作業を効率的に進めるために役立てられます。