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

codeプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

『codeプロパティは、スローされたOutOfRangeException例外に固有の整数コードを保持するプロパティです。このプロパティは、例外が発生した具体的な原因をプログラム上で識別するために使用されます。OutOfRangeExceptionは、配列などで範囲外のインデックスにアクセスしようとした際などに発生する例外ですが、同じ例外の中でも状況に応じて異なるエラーコードを割り当てることができます。このcodeプロパティは、PHPの全ての例外の基底クラスであるExceptionクラスから継承されたものであり、デフォルト値は0です。例外オブジェクトを生成する際、コンストラクタの第二引数に任意の整数値を渡すことで、このプロパティに値を設定できます。try...catch構文で例外を捕捉した際には、getCode()メソッドを呼び出すことで設定された値を取得できます。取得したエラーコードをif文やswitch文で評価することにより、コードの値に応じた具体的なエラー処理、例えばユーザーへの通知内容の変更や、ログ記録の詳細度の調整などを実装でき、より堅牢なプログラムを構築することが可能になります。』

構文(syntax)

1<?php
2
3try {
4    // 例外コード 404 を指定して OutOfRangeException をスローする
5    throw new OutOfRangeException("インデックスが範囲外です。", 404);
6} catch (OutOfRangeException $e) {
7    // 捕捉した例外のコードを取得して出力する
8    // public int getCode(void)
9    echo $e->getCode();
10}
11
12?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

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

関連コンテンツ

関連プログラミング言語