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

『getCodeメソッドは、スローされたUnexpectedValueExceptionオブジェクトに設定されている例外コードを取得するメソッドです。UnexpectedValueExceptionクラスは、値が期待される型のセットと一致しない場合など、予期しない値がプログラムに渡されたことを示す例外です。例外が生成される際、エラーメッセージに加えて、エラーの種類をプログラムが識別するための整数値を「例外コード」として設定できます。このgetCodeメソッドは、その設定された例外コードを取得するために使用します。取得した例外コードを利用することで、catchブロック内において、エラーの種類に基づいた条件分岐処理を実装できます。例えば、同じ例外クラスであっても、コードの値によってユーザーに表示するメッセージを変えたり、ログに出力する内容を調整したりといった、より詳細なエラーハンドリングが可能になります。このメソッドが返す値は、例外オブジェクトのコンストラクタで指定された整数値であり、もしコードが指定されていなければ0を返します。これは基底クラスであるExceptionから継承された標準的な機能であり、PHPにおける多くの例外クラスで同様に利用できます。

Copy
1<?php
2
3try {
4    // 第2引数に例外コードを指定して例外をスローします
5    throw new UnexpectedValueException('予期しない値が検出されました。', 101);
6} catch (UnexpectedValueException $e) {
7    // 捕捉した例外オブジェクトから例外コードを取得します
8    $errorCode = $e->getCode();
9    echo $errorCode;
10}
11
12?>

引数なし

引数はありません

int

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