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

『getCodeメソッドは、スローされたInvalidArgumentExceptionインスタンスに設定されている例外コードを取得するメソッドです。このメソッドは、PHPの基本的な例外クラスであるExceptionから継承されており、InvalidArgumentExceptionでも同様に使用することができます。例外コードは、人間が読むための例外メッセージとは別に、エラーの種類をプログラム上で識別するために用いられる整数値です。開発者は、InvalidArgumentExceptionをnewキーワードで生成する際に、コンストラクタの第二引数として任意の整数コードを渡すことが可能です。そして、try-catchブロックでこの例外を捕捉した際に、getCodeメソッドを呼び出すことで設定したコードを取得できます。取得したコードを利用して、switch文などでエラーの種類に応じた分岐処理を実装するなど、より柔軟で詳細なエラーハンドリングを実現するために役立ちます。もし例外の生成時にコードが指定されなかった場合、このメソッドはデフォルトで0を返します。』

Copy
1<?php
2try {
3    // 例外をスローする際に、第2引数で例外コードを指定します。
4    throw new InvalidArgumentException("引数が無効です。", 1001);
5} catch (InvalidArgumentException $e) {
6    // getCode() メソッドで例外コードを取得します。
7    $code = $e->getCode();
8    echo $code; // 1001 が出力されます。
9}
10?>

引数なし

引数はありません

int|string

このメソッドは、例外が生成された際に設定されたエラーコードを返します。エラーコードは整数または文字列として保持されている場合があります。