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

Copy
1<?php
2
3namespace App\Libraries;
4
5use CodeIgniter\Exceptions\PageNotFoundException;
6
7class ErrorHandler
8{
9    /**
10     * エラーコードに基づいて、カスタムエラーページを表示します。
11     *
12     * @param int $code HTTPステータスコード
13     *
14     * @return string HTMLコンテンツ
15     */
16    public function displayErrorPage(int $code): string
17    {
18        switch ($code) {
19            case 404:
20                // 404エラーページのパスを設定します。
21                $viewPath = 'errors/404_error';
22                break;
23            case 500:
24                // 500エラーページのパスを設定します。
25                $viewPath = 'errors/500_error';
26                break;
27            default:
28                // デフォルトのエラーページのパスを設定します。
29                $viewPath = 'errors/default_error';
30                break;
31        }
32
33        // CodeIgniterビューローダーを使用してエラーページを読み込みます。
34        $view = \Config\Services::renderer();
35
36        try {
37            return $view->render($viewPath, ['code' => $code]);
38        } catch (\Exception $e) {
39            // ビューファイルが存在しない場合、例外をキャッチし、デフォルトメッセージを表示します。
40            return "<h1>エラーが発生しました。</h1><p>エラーコード: {$code}</p>";
41        }
42    }
43
44    /**
45     *  PageNotFoundException を throw するサンプル
46     *
47     *  @throws PageNotFoundException
48     */
49    public function throwNotFoundException(): void
50    {
51        throw new PageNotFoundException("指定されたページが見つかりません。");
52    }
53}
54
55// 使用例：
56// $errorHandler = new ErrorHandler();
57// echo $errorHandler->displayErrorPage(404); // 404エラーページを表示
58// try {
59//   $errorHandler->throwNotFoundException();
60// } catch (PageNotFoundException $e) {
61//   echo "例外がキャッチされました: " . $e->getMessage();
62// }

このサンプルコードは、PHPとCodeIgniterフレームワークを使用して、カスタムエラーページを表示するためのErrorHandlerクラスを定義しています。ErrorHandlerクラスは、HTTPステータスコードを受け取り、それに基づいて適切なエラーページをレンダリングするdisplayErrorPageメソッドを持っています。

displayErrorPageメソッドは、引数として整数型の$code（HTTPステータスコード）を受け取ります。この$codeの値に応じて、異なるエラーページのビューファイルが選択されます。例えば、$codeが404の場合、errors/404_errorというビューファイルが読み込まれます。CodeIgniterのビューローダーを利用して、指定されたビューファイルをレンダリングし、HTMLコンテンツを文字列として返します。もしビューファイルが存在しないなどの理由で例外が発生した場合は、エラーメッセージを表示します。

また、throwNotFoundExceptionメソッドは、PageNotFoundExceptionをスローする例を示しています。これは、指定されたページが見つからない場合に例外を発生させるために使用されます。try-catchブロックを使用することで、この例外を捕捉し、エラーメッセージを表示できます。

このコードは、Webアプリケーションにおけるエラーハンドリングの基本的な方法を示しており、システムエンジニアを目指す初心者にとって、エラー処理の概念を理解するための良い出発点となります。特に、CodeIgniterフレームワークにおけるビューのレンダリングや例外処理の方法を学ぶことができます。

Copy
1<?php
2
3/**
4 * ErrorException の code プロパティの例
5 *
6 * PHP_CodeSniffer を使用してコーディング規約を確認することを推奨します。
7 */
8try {
9    // 意図的にエラーを発生させる
10    trigger_error("This is a test error.", E_USER_WARNING);
11} catch (ErrorException $e) {
12    // ErrorException オブジェクトからエラーコードを取得
13    $errorCode = $e->getCode();
14
15    // エラーコードを表示
16    echo "Error Code: " . $errorCode . PHP_EOL;
17
18    // エラーメッセージを表示
19    echo "Error Message: " . $e->getMessage() . PHP_EOL;
20}

ErrorExceptionクラスのcodeプロパティは、発生したエラーのエラーコード（整数値）を保持します。このプロパティは、例外オブジェクトを通じてエラーの種類を識別するために使用されます。サンプルコードでは、trigger_error()関数を使用して意図的にE_USER_WARNINGレベルのエラーを発生させています。このエラーはErrorExceptionとしてキャッチされ、キャッチされた例外オブジェクトのgetCode()メソッドを呼び出すことで、エラーコードを取得しています。getCode()メソッドは引数を取らず、エラーコードの整数値を返します。取得したエラーコードは、echoステートメントによってコンソールに出力されます。このようにcodeプロパティを利用することで、発生したエラーの種類をプログラム上で判別し、適切なエラーハンドリングを行うことが可能になります。

なお、サンプルコード内には、PHP_CodeSnifferの使用を推奨するコメントが含まれています。PHP_CodeSnifferは、PHPのコーディング規約をチェックするためのツールであり、一貫性のあるコードスタイルを維持するために役立ちます。ErrorExceptionのcodeプロパティの利用と合わせて、PHP_CodeSnifferなどのツールを活用することで、より質の高いコードを作成できます。