【PHP8.x】getCodeメソッドの使い方

getCodeメソッドは、スローされた例外に設定されている例外コードを取得するメソッドです。このメソッドはRangeExceptionクラスに固有のものではなく、すべての例外クラスの基底となるExceptionクラスから継承されています。例外コードは、例外の種類をプログラムで識別するために使用される整数値で、通常は例外オブジェクトが生成される際にコンストラクタの第二引数として設定されます。try...catchブロックでRangeExceptionオブジェクトを捕捉した際に、このメソッドを呼び出すことで、設定された整数コードを取得できます。取得したコードの値に応じてエラー処理を分岐させるなど、より詳細で柔軟な例外ハンドリングを実装することが可能になります。もし例外が生成される際にコードが明示的に指定されなかった場合、このメソッドはデフォルト値として0を返します。戻り値は整数型（int）です。

Copy
1<?php
2
3try {
4    // 例外コード 100 を持つ RangeException をスローします。
5    throw new RangeException("値が範囲外です。", 100);
6} catch (RangeException $e) {
7    // 捕捉した例外のコードを取得して出力します。
8    echo $e->getCode(); // 100
9}

引数なし

引数はありません

int

このメソッドは、例外が発生した際のコード番号を整数型で返します。