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

codeプロパティは、スローされた例外の種類を識別するための、オプションの整数コードを保持するプロパティです。このプロパティは、PHPの全ての組み込み例外クラスの親となるExceptionクラスから継承されており、LogicExceptionもその機能を利用します。例外オブジェクトを生成する際、コンストラクタの第二引数に整数値を渡すことで、このプロパティに任意の値を設定できます。もしこの引数が省略された場合、codeプロパティのデフォルト値は0となります。プロパティに設定された値は、getCode()メソッドを通じて取得することが可能です。例外メッセージが人間が読むための説明であるのに対し、このcodeはプログラムがエラーの種類を機械的に判定するために使用されます。catchブロック内でコードの値に基づいて処理を分岐させるなど、より詳細で柔軟なエラーハンドリングを実装する際に役立ちます。これにより、例えば同じLogicExceptionの中でも、エラーの具体的な原因に応じて異なる復旧処理を行うといった制御が可能になります。

Copy
1<?php
2
3try {
4    // 第2引数で例外コードを指定して、LogicExceptionをスローします。
5    throw new LogicException('An error occurred in the application logic.', 101);
6} catch (LogicException $e) {
7    // getCode()メソッドを使用して、設定された例外コードを取得します。
8    echo $e->getCode(); // 101 が出力されます。
9}

引数なし

引数はありません

int

LogicException クラスの code プロパティは、例外発生時のエラーコードを表す整数値を返します。