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

getCodeメソッドは、スローされた例外に設定された例外コードを取得するメソッドです。このメソッドは、PHPの例外クラスの基底であるExceptionクラスで定義されており、UnderflowExceptionクラスはそれを継承しています。例外がスローされる際、new UnderflowException("エラーメッセージ", 101)のように、コンストラクタの第二引数に整数値でコードを渡すことが可能です。try...catchブロックで例外を捕捉した後、catchブロック内でこのgetCodeメソッドを呼び出すと、その設定された整数値（この例では101）が返されます。この機能を利用することで、同じUnderflowExceptionの中でも、エラーが発生した原因や状況を数値コードによって細かく分類できます。そして、取得したコード値に基づいて処理を分岐させるなど、より詳細で柔軟なエラーハンドリングを実装することが可能になります。もし例外オブジェクトの生成時にコードが指定されなかった場合、このメソッドはデフォルト値として0を返します。

Copy
1<?php
2
3try {
4    throw new UnderflowException("An underflow error occurred.", 101);
5} catch (UnderflowException $e) {
6    // 例外コードを取得します
7    $exceptionCode = $e->getCode();
8    echo $exceptionCode;
9}
10
11?>

引数なし

引数はありません

int

このメソッドは、例外が発生した際に割り当てられたエラーコードを整数型（int）で返します。