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

『code』プロパティは、スローされた例外のエラーコードを保持するプロパティです。このプロパティには通常、例外の種類をプログラム的に識別するための整数値が格納されます。例外メッセージが主に開発者がデバッグのために読む情報であるのに対し、このエラーコードはプログラムコード内でエラーの種類に応じた処理を分岐させるために利用されます。例えば、try-catchブロック内で捕捉した例外オブジェクトのgetCode()メソッドを使い、返されたコード値によって異なるエラーハンドリングを実行するといった使い方が可能です。OverflowExceptionは、データ構造が満杯の状態で要素を追加しようとした場合などに発生する例外ですが、この例外をスローする際に、コンストラクタの第2引数として任意のエラーコードを渡すことで、このプロパティに値を設定できます。これにより、同じ種類の例外であっても、発生した状況をコードで細かく分類し、より的確なエラー処理を実装できます。このcodeプロパティは、基底クラスであるExceptionクラスで定義されており、OverflowExceptionを含む多くの例外クラスに継承されています。もしエラーコードが明示的に指定されなかった場合、このプロパティの既定値は0となります。

Copy
1<?php
2
3try {
4    // 第2引数に整数値で例外コードを指定して、OverflowExceptionをスローします。
5    throw new OverflowException("何らかのオーバーフローが発生しました。", 500);
6} catch (OverflowException $e) {
7    // 継承したgetCode()メソッド、またはcodeプロパティで値を取得します。
8    $exceptionCode = $e->getCode();
9    echo "例外コード: " . $exceptionCode;
10}

引数なし

引数はありません

int

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