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

Copy
1<?php
2
3namespace App\Exceptions;
4
5use CodeIgniter\Exceptions\RequestParseBodyException;
6
7class CustomRequestParseBodyException extends RequestParseBodyException
8{
9    /**
10     * カスタムエラーコード
11     *
12     * @var int
13     */
14    protected $customCode;
15
16    /**
17     * コンストラクタ
18     *
19     * @param string $message エラーメッセージ
20     * @param int $code エラーコード (RequestParseBodyException::code を利用可能)
21     * @param \Throwable|null $previous 前のエラー
22     */
23    public function __construct(string $message = '', int $code = 0, \Throwable $previous = null)
24    {
25        parent::__construct($message, $code, $previous);
26
27        $this->customCode = $code; // エラーコードをカスタムプロパティに保存
28    }
29
30    /**
31     * エラーコードを取得する
32     *
33     * @return int エラーコード
34     */
35    public function getCustomCode(): int
36    {
37        return $this->customCode;
38    }
39
40    /**
41     * RequestParseBodyExceptionのcodeプロパティの値を返す
42     *
43     * @return int
44     */
45    public function getRequestParseBodyCode(): int
46    {
47        return $this->code;
48    }
49}
50
51// 使用例
52try {
53    throw new CustomRequestParseBodyException('JSONの解析に失敗しました。', JSON_ERROR_SYNTAX);
54} catch (CustomRequestParseBodyException $e) {
55    echo 'エラーメッセージ: ' . $e->getMessage() . PHP_EOL;
56    echo 'カスタムエラーコード: ' . $e->getCustomCode() . PHP_EOL;
57    echo 'RequestParseBodyExceptionのエラーコード: ' . $e->getRequestParseBodyCode() . PHP_EOL;
58}

このサンプルコードは、CodeIgniter4フレームワークにおけるRequestParseBodyExceptionクラスのcodeプロパティの使い方を示すものです。RequestParseBodyExceptionは、リクエストボディの解析に失敗した場合に発生する例外クラスです。codeプロパティは、その例外が発生した際のエラーコードを保持する整数型のプロパティです。

この例では、RequestParseBodyExceptionを拡張したCustomRequestParseBodyExceptionクラスを定義しています。コンストラクタでエラーメッセージ、エラーコード、前の例外を受け取り、親クラスのコンストラクタを呼び出して例外を初期化しています。また、受け取ったエラーコードをカスタムプロパティcustomCodeに保存しています。

getRequestParseBodyCodeメソッドは、親クラスであるRequestParseBodyExceptionのcodeプロパティの値を返します。これにより、例外発生時の詳細なエラー情報を取得できます。

サンプルコードの後半では、CustomRequestParseBodyExceptionを発生させ、キャッチしています。キャッチした例外オブジェクトからgetMessageメソッドでエラーメッセージ、getCustomCodeメソッドでカスタムエラーコード、getRequestParseBodyCodeメソッドでRequestParseBodyExceptionのエラーコードを取得し、それぞれ表示しています。

このように、codeプロパティを利用することで、例外発生時の状況をより詳細に把握し、適切なエラー処理を行うことができます。システムエンジニアを目指す方は、例外処理におけるエラーコードの重要性を理解し、効果的に活用できるようにしましょう。

Copy
1<?php
2
3/**
4 * RequestParseBodyException を拡張したサンプルクラス。
5 * 'code' プロパティにアクセスする例を示す。
6 */
7class CustomRequestParseBodyException extends RequestParseBodyException
8{
9    /**
10     * エラーコードを取得する。
11     *
12     * @return int エラーコード
13     */
14    public function getErrorCode(): int
15    {
16        return $this->code;
17    }
18}
19
20/**
21 * 例外を発生させ、エラーコードを取得する関数。
22 *
23 * @return int エラーコード。例外が発生しない場合は0を返す。
24 */
25function handleRequest(): int
26{
27    try {
28        throw new CustomRequestParseBodyException("Invalid request body", 400);
29    } catch (CustomRequestParseBodyException $e) {
30        // 'code' プロパティにアクセスしてエラーコードを取得
31        return $e->getErrorCode();
32    }
33    return 0; // 例外が発生しない場合
34}
35
36// 関数の実行例
37$errorCode = handleRequest();
38echo "Error Code: " . $errorCode . PHP_EOL;
39
40?>

PHP 8におけるRequestParseBodyExceptionクラスのcodeプロパティは、例外発生時のエラーコードを保持する整数型のプロパティです。このプロパティは、例外オブジェクトが生成された際に設定されたエラーコードを後から参照するために使用されます。

サンプルコードでは、RequestParseBodyExceptionを継承したCustomRequestParseBodyExceptionクラスを作成し、codeプロパティにアクセスするgetErrorCodeメソッドを定義しています。getErrorCodeメソッドは、$this->codeを通じてエラーコードを取得し、それを返します。

handleRequest関数は、CustomRequestParseBodyExceptionをスローするtry-catchブロックを実装しています。catchブロックでは、例外オブジェクト $e の getErrorCode メソッドを呼び出し、エラーコードを取得しています。取得したエラーコードは関数の戻り値として返されます。もし例外が発生しなかった場合は、0を返します。

この例では、例外発生時に設定されたエラーコードをcodeプロパティを通して取得し、エラー処理に利用する方法を示しています。RequestParseBodyExceptionが発生した場合、codeプロパティを参照することで、問題の原因を特定し、適切な対応を行うことができます。このcodeプロパティは、PHP Codesnifferのようなコーディング標準ツールによって、アクセス制御や命名規則が適切かどうかチェックされることがあります。