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

『codeプロパティは、例外が発生した際の詳細な理由を示す整数値（例外コード）を保持するプロパティです。このプロパティは、InvalidArgumentExceptionクラスが継承しているPHPの基底例外クラスであるExceptionクラスで定義されています。InvalidArgumentExceptionは、メソッドや関数に渡された引数が期待される型や値と一致しない場合にスローされる例外ですが、codeプロパティを利用することで、その不正の内容をより具体的に区別できます。例えば、引数の値が範囲外である場合はコード1、形式が不正である場合はコード2といったように、開発者が任意の整数値を割り当てることが可能です。この値は、例外インスタンスを生成する際のコンストラクタの第二引数で設定し、指定しない場合は0となります。catchブロックで例外を捕捉した際には、getCode()メソッドを呼び出すことでこの値を取得でき、コードの値に応じた分岐処理を行うなど、より詳細なエラーハンドリングを実現するために役立ちます。

Copy
1<?php
2
3try {
4    // 第2引数で例外コードを指定して、InvalidArgumentExceptionをスローします。
5    throw new InvalidArgumentException("引数の値が不正です。", 400);
6} catch (InvalidArgumentException $e) {
7    // getCode()メソッドで、設定した例外コードを取得します。
8    $exceptionCode = $e->getCode();
9    echo $exceptionCode; // 400 が出力されます。
10}

引数なし

引数はありません

int

このプロパティは、例外が発生した原因を示す整数コードを返します。