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

Copy
1<?php
2
3/**
4 * Webアプリケーションのリクエスト処理を模倣し、Exception::code プロパティの使用例を示します。
5 * CodeIgniterのようなフレームワークでも、基本的な例外処理は同様に行われます。
6 *
7 * @param string $inputData 処理する入力データ
8 * @return void
9 */
10function handleWebRequest(string $inputData): void
11{
12    echo "--- リクエスト処理を開始します ---" . PHP_EOL;
13
14    try {
15        // 入力データの検証
16        if (empty($inputData)) {
17            // 入力データが空の場合、特定のエラーコード1001を持つ例外をスロー
18            throw new Exception("入力データが提供されていません。", 1001);
19        }
20
21        if (strlen($inputData) < 3) {
22            // 入力データが短すぎる場合、特定のエラーコード1002を持つ例外をスロー
23            throw new Exception("入力データが短すぎます。", 1002);
24        }
25
26        // 検証を通過した場合の正常な処理
27        echo "入力データが正常に処理されました: " . $inputData . PHP_EOL;
28
29    } catch (Exception $e) {
30        // 例外をキャッチし、その情報（メッセージとコード）を取得
31        echo "エラーが発生しました！" . PHP_EOL;
32        echo "エラーメッセージ: " . $e->getMessage() . PHP_EOL;
33        echo "エラーコード: " . $e->getCode() . PHP_EOL; // Exception::code プロパティの値を取得
34
35        // エラーコードに基づいて異なる処理を行う例
36        switch ($e->getCode()) {
37            case 1001:
38                echo "-> ユーザーに必須データの入力を促してください。" . PHP_EOL;
39                break;
40            case 1002:
41                echo "-> 入力データの最小長要件を確認してください。" . PHP_EOL;
42                break;
43            default:
44                echo "-> 不明なエラーです。システム管理者に連絡してください。" . PHP_EOL;
45                break;
46        }
47    } finally {
48        // 例外の有無にかかわらず、常に実行される処理
49        echo "--- リクエスト処理が終了しました ---" . PHP_EOL . PHP_EOL;
50    }
51}
52
53// さまざまなシナリオで関数を実行
54handleWebRequest("Hello PHP"); // 正常な入力
55handleWebRequest("");          // 空の入力でエラーコード1001が発生
56handleWebRequest("ab");        // 短すぎる入力でエラーコード1002が発生
57handleWebRequest("Unexpected Error"); // デフォルトの例外処理 (この例では発生しないが、他のコードで発生したと仮定)

PHPのExceptionクラスに用意されているcodeプロパティは、例外が発生した際に、そのエラーの種類を識別するための整数値（エラーコード）を格納するプロパティです。このプロパティ自体に引数はありませんが、例外がスローされる際に設定されたint型の数値を取得できます。

サンプルコードでは、Webアプリケーションのリクエスト処理を模倣し、try...catchブロック内で例外処理を行っています。入力データが空の場合にはエラーコード1001、短すぎる場合にはエラーコード1002をそれぞれ指定して例外をスローしています。catchブロックでは、捕らえられた例外オブジェクトから$e->getCode()を使ってこのエラーコードを取得し、switch文でその値に応じた異なる処理を実行しています。これにより、エラーメッセージだけでなく、数値コードを使ってエラーの種類を具体的に判別し、適切なユーザーへの指示やログ記録などの対応を行うことが可能になります。

このようにException::codeプロパティを活用することで、システム内で発生する様々なエラーを数値で分類し、よりきめ細かく、かつ効率的なエラーハンドリングを実装できます。CodeIgniterのようなWebフレームワークを用いたPHP開発においても、例外コードによる処理の分岐は、堅牢なアプリケーションを構築するための基本的な手法として広く利用されています。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * PHP_CodeSniffer の実行時エラーを表すカスタム例外クラス
7 */
8class CodeSnifferRunnerException extends Exception
9{
10    // エラーの種類を識別するための定数を定義します
11    public const CONFIG_NOT_FOUND = 1001;
12    public const TARGET_DIR_NOT_FOUND = 1002;
13}
14
15/**
16 * 指定された設定で PHP_CodeSniffer の実行をシミュレートします。
17 * 意図的に例外を発生させ、Exceptionクラスの `code` プロパティの利用方法を示します。
18 */
19class CodeSnifferRunner
20{
21    /**
22     * @param string $configPath 設定ファイルのパス
23     * @param string $targetPath チェック対象ディレクトリのパス
24     *
25     * @throws CodeSnifferRunnerException 条件に応じて例外をスローします
26     */
27    public function run(string $configPath, string $targetPath): void
28    {
29        echo "PHP_CodeSniffer の実行を開始します...\n";
30
31        // 設定ファイルが存在しない場合、例外コード 1001 を指定して例外をスロー
32        if (!file_exists($configPath)) {
33            throw new CodeSnifferRunnerException(
34                "設定ファイルが見つかりません: {$configPath}",
35                CodeSnifferRunnerException::CONFIG_NOT_FOUND
36            );
37        }
38
39        // 対象ディレクトリが存在しない場合、例外コード 1002 を指定して例外をスロー
40        if (!is_dir($targetPath)) {
41            throw new CodeSnifferRunnerException(
42                "チェック対象ディレクトリが見つかりません: {$targetPath}",
43                CodeSnifferRunnerException::TARGET_DIR_NOT_FOUND
44            );
45        }
46
47        // 実際にはここで PHP_CodeSniffer を実行する処理が入ります
48        echo "チェックは正常に完了しました。\n";
49    }
50}
51
52// --- 以下、実行コード ---
53
54$runner = new CodeSnifferRunner();
55$configFile = 'phpcs.xml'; // 存在しない設定ファイル
56$targetDir = './src';      // 存在しないディレクトリ
57
58try {
59    $runner->run($configFile, $targetDir);
60} catch (CodeSnifferRunnerException $e) {
61    // 発生した例外を捕捉します
62    echo "エラーが発生しました。\n";
63    echo "--------------------\n";
64
65    // Exception::getCode() で整数型の例外コードを取得し、処理を分岐します
66    // これにより、エラーメッセージの文字列に頼らずにエラーの種類を判定できます。
67    switch ($e->getCode()) {
68        case CodeSnifferRunnerException::CONFIG_NOT_FOUND:
69            echo "エラー種別: 設定ファイルエラー\n";
70            break;
71        case CodeSnifferRunnerException::TARGET_DIR_NOT_FOUND:
72            echo "エラー種別: ターゲットディレクトリのエラー\n";
73            break;
74        default:
75            echo "エラー種別: 不明なエラー\n";
76            break;
77    }
78
79    echo "例外コード: " . $e->getCode() . "\n";
80    echo "メッセージ: " . $e->getMessage() . "\n";
81    // 終了コードとして例外コードを利用することも一般的です
82    exit($e->getCode());
83}

PHP 8のExceptionクラスには、例外の種類を整数値で識別するためのcodeプロパティが標準で備わっています。このプロパティは、例外が発生した原因を数値で特定する際に利用されます。

例外を発生させる際、new Exception('エラー内容', 100)のように、コンストラクタの第2引数として整数値を渡すことで、このcodeプロパティに値を設定できます。サンプルコードでは、PHP_CodeSnifferの実行時に「設定ファイルが見つからない」場合は1001、「対象ディレクトリが見つからない」場合は1002といった独自の例外コードを設定しています。

プログラム内で例外を捕捉した際には、例外オブジェクトに対してgetCode()メソッドを呼び出すことで、設定された整数値を取得できます。この値は常にint型で返されます。取得した例外コードを利用することで、エラーメッセージの文字列内容に依存することなく、数値でエラーの種類を明確に判断し、状況に応じた処理を分岐させることが可能になります。これにより、より堅牢で保守しやすいエラーハンドリングを実現できます。