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

getCodeメソッドは、スローされた例外に設定されている例外コードを取得するために実行するメソッドです。このメソッドは、OutOfRangeExceptionクラスのインスタンスに対して使用します。OutOfRangeExceptionは、配列や文字列などで有効な範囲外のインデックスへアクセスしようとした際に発生する例外です。例外コードは、例外が生成される際に開発者が任意で設定できる整数値であり、エラーの種類をプログラム上で細かく識別するために利用されます。例えば、try...catch構文で例外を捕捉した際に、このgetCodeメソッドが返す値に応じて、エラー処理のロジックを分岐させることが可能になります。例外オブジェクトが new OutOfRangeException("エラーメッセージ", 101) のように、第二引数にコードを指定して生成された場合、このメソッドは 101 を返します。もし例外コードが指定されずに例外がスローされた場合は、デフォルト値として整数型の 0 を返します。このメソッドの基本的な機能は、PHPの全ての例外クラスの親であるExceptionクラスで定義されており、OutOfRangeExceptionはそれを継承して利用しています。

Copy
1<?php
2try {
3    // 第2引数に例外コード(例: 101)を指定して例外をスローする
4    throw new OutOfRangeException("指定されたインデックスは範囲外です。", 101);
5} catch (OutOfRangeException $e) {
6    // 例外オブジェクトからコードを取得する
7    $code = $e->getCode();
8    echo $code; // 101 が出力される
9}
10?>

引数なし

引数はありません

int|string

このメソッドは、例外が発生した際のコード番号または文字列を返します。