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

Copy
1<?php
2
3/**
4 * この関数はPHPのExceptionクラスのgetCode()メソッドの使用例を示します。
5 * 例外を意図的に発生させ、その例外コードを捕捉して表示します。
6 */
7function demonstrateExceptionCode(): void
8{
9    try {
10        // 新しいExceptionオブジェクトをスローします。
11        // 第2引数として、この例外に紐付ける数値コード（ここでは 1001）を指定します。
12        throw new Exception("ファイルが見つかりませんでした。", 1001);
13
14    } catch (Exception $e) {
15        // 例外が捕捉された場合、Exceptionオブジェクトから情報を取得します。
16
17        echo "捕捉された例外情報:" . PHP_EOL;
18        echo "-------------------" . PHP_EOL;
19
20        // getMessage() メソッドで例外のメッセージを取得します。
21        echo "メッセージ: " . $e->getMessage() . PHP_EOL;
22
23        // getCode() メソッドで例外に設定された数値コードを取得します。
24        // これはリファレンス情報で示されている getCode メソッドです。
25        echo "コード: " . $e->getCode() . PHP_EOL;
26
27        // 例外が発生したファイル名と行番号も取得できます。
28        echo "ファイル: " . $e->getFile() . PHP_EOL;
29        echo "行: " . $e->getLine() . PHP_EOL;
30    }
31}
32
33// 関数を実行して、例外処理の動作を確認します。
34demonstrateExceptionCode();
35
36?>

PHP 8のException::getCode()メソッドは、プログラム実行中に発生した例外に関する数値コードを取得するために使用されます。このメソッドはExceptionクラスに属し、例外が発生した際にその種類や原因を識別するための特定の整数値を返します。引数はなく、常に整数型（int）の値を戻り値として返します。

サンプルコードでは、demonstrateExceptionCode関数内で意図的にExceptionをスローしています。throw new Exception("ファイルが見つかりませんでした。", 1001);のように、Exceptionオブジェクトを生成する際に、第2引数として任意の数値コード（ここでは1001）を指定できます。この数値コードは、開発者が独自に定義し、様々なエラーの種類を区別するために利用されます。

try...catchブロックで例外が捕捉された際、catchブロック内の$e変数には発生したExceptionオブジェクトが格納されます。$e->getCode()を呼び出すことで、この例外オブジェクトに紐付けられた数値コード「1001」を取得し、画面に表示しています。これにより、どの種類の例外が発生したかをプログラム的に判断し、それに応じた適切なエラー処理を実行することが可能になります。getMessage()で例外メッセージを、getFile()やgetLine()で発生箇所を取得できることも、例外処理における重要な側面です。