【PHP8.x】BadFunctionCallException::codeプロパティの使い方

Copy
1<?php
2
3/**
4 * CodeIgniterのコントローラを模倣したクラス。
5 * 意図的に例外を発生させ、BadFunctionCallExceptionの`code`プロパティの
6 * 使い方をデモンストレーションします。
7 */
8class PageController
9{
10    /**
11     * CodeIgniterのフック機能をシミュレートし、動的にコールバックを実行します。
12     *
13     * @param mixed $callback 実行するコールバック関数
14     * @throws BadFunctionCallException コールバックが無効な場合にスローされます
15     */
16    private function executeHook($callback): void
17    {
18        // コールバックが呼び出し可能かチェックします。
19        // CodeIgniterのフックなどでは、設定ミスにより無効な値が渡されることがあります。
20        if (!is_callable($callback)) {
21            // 呼び出し不可能な場合、BadFunctionCallExceptionをスローします。
22            // 第2引数で、例外コード(code)を整数値で指定できます。
23            // このコードは、エラーの種類をプログラムで識別するために利用できます。
24            throw new BadFunctionCallException(
25                '指定されたフックは呼び出し可能な関数ではありません。', // メッセージ
26                1001                                               // 例外コード (code)
27            );
28        }
29
30        // 実際にコールバックを実行する (このデモでは到達しない)
31        call_user_func($callback);
32    }
33
34    /**
35     * メインの処理を実行するエントリーポイント。
36     * CodeIgniterでは、URLに応じてこの種のメソッドが呼び出されます。
37     */
38    public function index(): void
39    {
40        echo "ページの表示処理を開始します..." . PHP_EOL;
41
42        try {
43            // 'before_render'フックを実行しようとしますが、
44            // 設定ミスを想定し、無効なコールバック（ここではnull）を渡します。
45            $this->executeHook(null);
46
47        } catch (BadFunctionCallException $e) {
48            // BadFunctionCallExceptionを捕捉します。
49            echo "エラー: 処理の実行中に問題が発生しました。" . PHP_EOL;
50
51            // getCode()メソッドを使って、スローされた例外のコードを取得します。
52            $errorCode = $e->getCode();
53
54            // 取得した例外コードに基づいて、ログ出力やエラー処理を分岐させます。
55            if ($errorCode === 1001) {
56                echo "エラーコード {$errorCode}: 設定ファイルに誤りがある可能性があります。" . PHP_EOL;
57            } else {
58                echo "予期せぬエラーが発生しました。エラーコード: {$errorCode}" . PHP_EOL;
59            }
60
61            // デバッグ用に例外メッセージも表示します。
62            echo "詳細情報: " . $e->getMessage() . PHP_EOL;
63
64        } finally {
65            echo "ページの表示処理を終了します。" . PHP_EOL;
66        }
67    }
68}
69
70// CodeIgniterのフレームワークがコントローラを呼び出す処理をシミュレート
71$controller = new PageController();
72$controller->index();

このPHPサンプルコードは、BadFunctionCallExceptionが持つcodeプロパティの役割と使い方を解説するものです。codeプロパティは、例外に紐づけられた整数値の識別子で、エラーの種類をプログラムで区別するために使用されます。

このコードは、WebフレームワークCodeIgniterで起こりうる状況を模しています。executeHookメソッド内で、呼び出し不可能な関数が指定された場合にBadFunctionCallExceptionをthrowしています。その際、第2引数にエラーコードとして1001という整数値を設定しています。この値がcodeプロパティに格納されます。

try...catchブロックで例外を捕捉した後、$e->getCode()メソッドを呼び出します。このメソッドは引数を取らず、戻り値としてthrow時に設定された整数(int)を返します。サンプルでは、取得したエラーコードが1001であるかをif文で判定し、コードの値に応じた適切なエラーメッセージを表示しています。このようにcodeプロパティを利用することで、同じ種類の例外であっても、発生原因ごとに処理を分岐させる、より詳細なエラーハンドリングが可能になります。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * PHP CodeSniffer のような静的解析ツールの動作を模倣するクラスです。
7 * 特定のコーディングルール違反を検出し、BadFunctionCallException をスローします。
8 */
9class CodeStyleChecker
10{
11    /**
12     * ルール違反を識別するためのカスタムエラーコードを定義します。
13     * このコードは Exception の 'code' プロパティに格納されます。
14     */
15    private const FORBIDDEN_FUNCTION_USED = 1001;
16
17    /**
18     * 与えられたコード文字列を検査し、ルール違反があれば例外をスローします。
19     *
20     * @param string $codeContent 検査対象のコード
21     * @throws BadFunctionCallException ルールに違反する関数呼び出しが発見された場合
22     */
23    public function inspect(string $codeContent): void
24    {
25        // 'call_user_func' は予期せぬ動作を引き起こす可能性があるため、
26        // プロジェクトのコーディング規約で禁止されている、というシナリオを想定します。
27        if (str_contains($codeContent, 'call_user_func')) {
28            // ルール違反を発見した場合、メッセージとカスタムエラーコードを指定して例外をスローします。
29            throw new BadFunctionCallException(
30                '禁止されている関数 call_user_func() が使用されています。',
31                self::FORBIDDEN_FUNCTION_USED
32            );
33        }
34
35        echo "コードの検査が完了しました。問題は見つかりませんでした。\n";
36    }
37}
38
39// --- 以下、実行サンプル ---
40
41// コーディングスタイルチェッカーのインスタンスを作成します。
42$checker = new CodeStyleChecker();
43
44// 検査対象のコード（ルールに違反しているコード）
45$problematicCode = '<?php call_user_func("some_function"); ?>';
46
47try {
48    // コードの検査を実行します。例外がスローされる可能性があります。
49    echo "検査を開始します...\n";
50    $checker->inspect($problematicCode);
51} catch (BadFunctionCallException $e) {
52    // スローされた BadFunctionCallException をここで捕捉します。
53    echo "コーディングルール違反が検出されました。\n";
54
55    // getMessage() で例外メッセージを取得して表示します。
56    echo "  メッセージ: " . $e->getMessage() . "\n";
57
58    // getCode() で例外に設定された整数コードを取得して表示します。
59    // これが BadFunctionCallException の 'code' プロパティの値です。
60    echo "  エラーコード: " . $e->getCode() . "\n";
61}
62

このサンプルコードは、例外クラス BadFunctionCallException が持つ code プロパティの役割を解説しています。この code プロパティは、発生した例外の種類をプログラムが識別できるよう、開発者が任意に設定できる整数値を格納するためのものです。

コード内の CodeStyleChecker クラスは、php codesniffer のような静的解析ツールの動作を模しています。inspect メソッドは、引数で渡されたコード文字列に、プロジェクトの規約で禁止されている関数 call_user_func が含まれているかを検査します。もし含まれていた場合、エラーメッセージと共に、独自に定義したエラーコード 1001 を指定して BadFunctionCallException を発生させます。

実行部分の try...catch ブロックでは、この発生した例外を捕まえています。$e->getCode() メソッドを呼び出すことで、例外オブジェクトに設定された code プロパティの値を取得できます。getCode() メソッドは引数を取らず、戻り値として整数 (int) 型のエラーコードを返します。この仕組みにより、エラーメッセージの内容だけでなく、数値コードでエラーの種類を判別し、より的確なエラーハンドリングが可能になります。