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

getCodeメソッドは、スローされた例外に設定されている例外コードを取得するために使用されるメソッドです。このメソッドは、PHPのすべての例外クラスの基底となるExceptionクラスで定義されており、OverflowExceptionクラスもこれを継承しています。例外コードとは、例外が発生した具体的な原因をプログラム的に識別するための整数値であり、例外をスローする際にコンストラクタの第二引数として指定します。try...catchブロックでOverflowExceptionを捕捉した際に、このメソッドを呼び出すことで、あらかじめ設定されたコードを取得できます。取得したコードを条件分岐などで使用することにより、同じ種類の例外であっても発生箇所や原因に応じて処理を切り替えるなど、より詳細なエラーハンドリングを実装することが可能になります。これにより、アプリケーションの堅牢性を高めることができます。もし、例外がスローされる際に例外コードが明示的に指定されなかった場合、getCodeメソッドはデフォルトで0を返します。

Copy
1<?php
2try {
3    // 例外コードを指定してOverflowExceptionをスローします
4    throw new OverflowException("An overflow error has occurred.", 100);
5} catch (OverflowException $e) {
6    // 例外オブジェクトからコードを取得します
7    $exceptionCode = $e->getCode();
8    echo $exceptionCode; // 100
9}

引数なし

引数はありません

int|string

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