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

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

作成日: 更新日:

基本的な使い方

『codeプロパティは、例外に関する追加情報を示す整数値である例外コードを保持するプロパティです。』このプロパティはBadMethodCallExceptionクラスが直接定義しているものではなく、PHPの全ての例外の元となるExceptionクラスから継承されたものです。したがって、BadMethodCallExceptionを含むほとんどの例外オブジェクトで利用することができます。例外コードの主な目的は、同じ種類の例外の中でも、発生した状況に応じてエラーを数値で細かく分類することです。開発者はBadMethodCallExceptionのインスタンスを生成する際、コンストラクタの第二引数に任意の整数を指定することで、独自の例外コードを設定できます。このコードを指定しない場合、デフォルト値として0が設定されます。例外を補足するcatchブロック内では、getCode()メソッドを使ってこの値を取得できます。取得したコードの値に応じて処理を分岐させることで、より詳細で柔軟なエラーハンドリングを実装することが可能になります。

構文(syntax)

1<?php
2
3try {
4    // 例外コード 100 を指定して BadMethodCallException をスローします。
5    throw new BadMethodCallException("メソッドの呼び出しに失敗しました。", 100);
6} catch (BadMethodCallException $e) {
7    // 捕捉した例外インスタンスから、設定された例外コードを取得します。
8    // public readonly int $code;
9    $errorCode = $e->getCode();
10
11    echo "例外コード: " . $errorCode; // 出力: 例外コード: 100
12}
13
14?>

引数(parameters)

引数なし

引数はありません

戻り値(return)

int

BadMethodCallException クラスの code プロパティは、例外が発生した際の識別コードを表す整数値を返します。