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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 存在しないメソッドが呼び出された際に、
7 * BadMethodCallException をスローして処理をデモするクラスです。
8 */
9class MethodCaller
10{
11    /**
12     * 存在しないインスタンスメソッドが呼び出されたときに自動的に実行されるマジックメソッド。
13     * ここで意図的に BadMethodCallException をスローします。
14     *
15     * @param string $name 呼び出されようとしたメソッド名
16     * @param array $arguments メソッドに渡された引数
17     * @throws BadMethodCallException 常にこの例外をスローします
18     */
19    public function __call(string $name, array $arguments): void
20    {
21        // 独自の例外コード (例: 1001) を指定して例外を生成します。
22        // 第1引数: 例外メッセージ
23        // 第2引数: 例外コード
24        $code = 1001;
25        $message = "エラー: メソッド '{$name}' は存在しないため呼び出せません。";
26        throw new BadMethodCallException($message, $code);
27    }
28}
29
30// --- メインの実行処理 ---
31
32$caller = new MethodCaller();
33
34try {
35    // 意図的に存在しないメソッド 'undefinedMethod' を呼び出し、例外を発生させる
36    $caller->undefinedMethod('param1', 'param2');
37} catch (BadMethodCallException $e) {
38    // スローされた BadMethodCallException を捕捉する
39    echo "例外がキャッチされました。" . PHP_EOL;
40
41    // getMessage() で例外メッセージを取得して表示
42    echo "メッセージ: " . $e->getMessage() . PHP_EOL;
43
44    // getCode() で例外コード (throw時に指定した 1001) を取得して表示
45    // このコードを利用して、エラーの種類に応じた分岐処理などが可能になります。
46    $exceptionCode = $e->getCode();
47    echo "例外コード: " . $exceptionCode . PHP_EOL;
48
49    if ($exceptionCode === 1001) {
50        echo "ステータス: 致命的なメソッド呼び出しエラーです。" . PHP_EOL;
51    }
52}
53

このPHPサンプルコードは、BadMethodCallExceptionクラスが持つgetCode()メソッドの具体的な使い方を示しています。getCode()メソッドは、例外が生成された際に設定された「例外コード」を取得するためのものです。このメソッドは引数を持たず、戻り値として整数(int)または文字列(string)型の例外コードを返します。

コードの流れとして、まずMethodCallerクラスに存在しないメソッド(undefinedMethod)を意図的に呼び出します。すると、クラス内の__callマジックメソッドが実行され、コンストラクタの第2引数に1001という例外コードを指定したBadMethodCallExceptionがスローされます。

try...catchブロックでこの例外を捕捉し、例外オブジェクト$eに対して$e->getCode()を呼び出すと、設定された例外コード1001が取得できます。このコードを利用することで、サンプルコードの最後にあるように、特定のエラーコードに基づいて処理を分岐させるなど、エラーの種類に応じた柔軟な対応をプログラムで実装することが可能になります。