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

作成日: 更新日:

codeプロパティは、発生したエラーや例外の種類を識別するための数値(エラーコード)を保持するプロパティです。このプロパティは、PHP 8 における TypeError クラスに属しています。TypeError は、関数やメソッドの引数に期待される型と異なる値が渡された場合など、プログラムの型に関する規則が守られなかったときに発生する、PHPの内部的なエラーの一種です。

エラーコードは、単なるメッセージだけでは伝わりにくいエラーの具体的な種類や原因を、数値によって一意に識別するために利用されます。これにより、開発者はエラーハンドリングの際に、エラーコードの値に応じて適切な回復処理やログ記録を行うことが可能となり、より堅牢なプログラムを構築する手助けとなります。

TypeError のようにPHPの内部で発生するエラーの場合、codeプロパティには通常、特別なエラーコードが割り当てられていないため 0 が格納されることが多いです。しかし、開発者が独自のカスタムエラークラスを定義し、それを TypeError のように扱う場合や、特定のライブラリが TypeError を拡張して利用する場合には、エラーの種類を細かく区別するために任意の整数値を設定することもできます。

この code プロパティの値は、エラーオブジェクトから getCode() メソッドを呼び出すことで取得できます。エラーが発生した原因を数値的に把握することは、問題の特定と解決を迅速に行う上で非常に重要な情報を提供します。

基本的な使い方

構文(syntax)

1<?php
2$error = new TypeError("無効な型が指定されました。", 500);
3echo $error->code;

引数(parameters)

戻り値(return)

int

このプロパティは、発生したTypeErrorのエラーコードを整数型で返します。

【PHP8.x】codeプロパティの使い方 | いっしー@Webエンジニア