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

getCodeメソッドは、スローされたDomainExceptionオブジェクトに設定された例外コードを取得するために使用するメソッドです。このメソッドは、PHPの全ての例外クラスの基底クラスであるExceptionクラスで定義されており、DomainExceptionクラスはこれを継承しています。例外コードとは、例外が発生した際に、その原因をより詳細に示すために開発者が任意で設定できる整数値です。例外をthrowする際に、エラーメッセージと共にこのコードを指定することができます。getCodeメソッドは引数を取らず、戻り値として整数を返します。例外がスローされた時に例外コードが指定されていればその整数値が返され、指定されていない場合はデフォルトで0が返されます。try-catch構文でDomainExceptionを捕捉した際にこのメソッドを利用することで、取得したコードの値に応じて処理を分岐させることが可能になります。例えば、同じ例外でもコードによって異なるエラーメッセージを表示したり、特定のエラーコードの場合のみ特別なログを記録したりするなど、よりきめ細やかなエラーハンドリングを実現できます。このように、getCodeメソッドは、プログラムの堅牢性を高める上で重要な役割を果たします。

Copy
1<?php
2
3try {
4    // 第2引数にエラーコード(例: 5001)を指定して、例外をスローします。
5    throw new DomainException("指定された値は範囲外です。", 5001);
6} catch (DomainException $e) {
7    // スローされた例外インスタンスから、設定されたコードを取得します。
8    $errorCode = $e->getCode();
9
10    // 取得したコードを出力します。
11    // 出力: 5001
12    echo $errorCode;
13}

引数なし

引数はありません

int|string

このメソッドは、例外オブジェクトに設定されたエラーコードを返します。エラーコードは整数または文字列のいずれかです。