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

Copy
1<?php
2
3/**
4 * PharException::getLine() メソッドのサンプルコード
5 *
6 * このコードは、Pharアーカイブの操作中に発生するPharExceptionを意図的に発生させ、
7 * その例外オブジェクトから getLine() メソッドを使用して、エラーが発生した行番号を取得する方法を示します。
8 * システムエンジニアを目指す初心者の方にも理解しやすいように、詳細なコメントを付けています。
9 */
10
11// 意図的にPharExceptionを発生させるための準備
12// ここでは、Pharとして無効な内容を持つファイルを一時的に作成します。
13$invalidPharFile = 'invalid_example.phar';
14
15try {
16    // 1. 不正なPharファイルを作成
17    // Pharアーカイブではない適当なテキストを書き込むことで、
18    // `new Phar()` がこのファイルを有効なPharとして認識できず、
19    // PharExceptionをスローする状況を作り出します。
20    file_put_contents($invalidPharFile, 'This is not a valid PHAR archive content.');
21
22    echo "不正なPharファイル '{$invalidPharFile}' を作成しました。\n";
23    echo "このファイルを使ってPharをロードしようとし、意図的にPharExceptionを発生させます。\n\n";
24
25    // 2. ここでPharExceptionが発生します
26    // 存在しないか、または不正なPharファイルをロードしようとすると、
27    // PHPのPhar拡張機能がPharExceptionをスローします。
28    // この行の実行が、PharExceptionをトリガーする原因となります。
29    $phar = new Phar($invalidPharFile);
30
31    // 例外が発生した場合、この下のコードは実行されません。
32    echo "この行は実行されません。\n";
33
34} catch (PharException $e) {
35    // 3. PharExceptionを捕捉した場合の処理
36    echo "--- PharExceptionが捕捉されました！ ---\n";
37    echo "エラーメッセージ: " . $e->getMessage() . "\n";
38    
39    // getLine() メソッドを呼び出し、例外が発生したPHPコードの行番号を取得します。
40    // PharExceptionはPhar拡張機能の内部でスローされることが多いため、
41    // ここで表示される行番号は、このスクリプトファイル内ではなく、
42    // PHPのPhar拡張機能のソースコード内の行番号である可能性が高いです。
43    echo "エラーが発生した行: " . $e->getLine() . "\n";
44    
45    // getFile() メソッドで、エラーが発生したファイルパスも取得できます。
46    echo "エラーが発生したファイル: " . $e->getFile() . "\n";
47
48    // getTraceAsString() でスタックトレースを表示すると、例外発生までの呼び出し履歴が分かります。
49    echo "\nスタックトレース:\n" . $e->getTraceAsString() . "\n";
50
51} catch (Exception $e) {
52    // 4. PharException以外の予期せぬ例外を捕捉した場合の処理
53    echo "--- 予期せぬ一般例外が捕捉されました！ ---\n";
54    echo "エラーメッセージ: " . $e->getMessage() . "\n";
55    echo "エラーが発生した行: " . $e->getLine() . "\n";
56    echo "エラーが発生したファイル: " . $e->getFile() . "\n";
57
58} finally {
59    // 5. 例外の発生有無にかかわらず、最後に必ず実行される処理
60    // 作成した不正なPharファイルをクリーンアップ（削除）します。
61    if (file_exists($invalidPharFile)) {
62        unlink($invalidPharFile);
63        echo "\n不正なPharファイル '{$invalidPharFile}' を削除しました。\n";
64    }
65    echo "サンプルコードの実行が終了しました。\n";
66}

PharException::getLine()メソッドは、PHPのPharアーカイブを扱う際にPharExceptionという特定の例外が発生した場合に、その例外がPHPコードのどの行で発生したかを取得するためのものです。このメソッドは引数を一切必要とせず、例外が発生した行番号を整数型（int）で返します。

サンプルコードでは、Pharとして無効なファイルを作成し、new Phar()でそのファイルをロードしようとすることで、意図的にPharExceptionを発生させています。try-catchブロックでこの例外を捕捉した後、catch (PharException $e)ブロック内で$e->getLine()を呼び出すことで、エラーが起きたPHPコードの正確な行番号を取得しています。これにより、システムエンジニアがプログラムの問題箇所を特定し、デバッグする際の重要な情報となります。

このメソッドが返す行番号は、Phar拡張機能の内部コード内で例外がスローされた位置を示す場合もあれば、直接ユーザーが書いたコードの行を示す場合もあります。このように、getLine()は例外発生時の状況を把握し、エラーの原因究明を効率的に進めるために不可欠な役割を果たすメソッドです。