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

getCodeメソッドは、スローされたBadFunctionCallExceptionに設定された例外コードを取得するために使用されるメソッドです。このメソッドは、PHPのすべての例外クラスの基底となるExceptionクラスで定義されており、BadFunctionCallExceptionクラスはこれを継承して利用します。例外コードとは、例外が発生した際に、そのエラーの種類を数値で区別するために開発者が任意で設定できる整数値です。try...catchブロックでBadFunctionCallExceptionを捕捉した際に、このメソッドを呼び出すことで、例外オブジェクトに格納されているコードを取得できます。例外がスローされる際にコードが明示的に指定されていない場合、デフォルトで0が返されます。BadFunctionCallExceptionは、存在しない関数を呼び出そうとした場合や、関数に渡す引数が不足している場合など、関数呼び出しに問題がある場合に発生します。PHPエンジンが内部的にこの例外をスローする場合、例外コードは通常0となりますが、開発者が意図的に特定のコードを設定してスローすることも可能です。このメソッドを使うことで、エラー処理の分岐をより詳細に制御することができます。

Copy
1<?php
2
3try {
4    // 例として、例外コードを101としてBadFunctionCallExceptionをスローします
5    throw new BadFunctionCallException('This is a bad function call.', 101);
6} catch (BadFunctionCallException $e) {
7    // getCode()メソッドを使って、設定された例外コードを取得します
8    $exceptionCode = $e->getCode();
9    var_dump($exceptionCode); // int(101)
10}

引数なし

引数はありません

mixed

このメソッドは、例外が発生した原因となったコードを表す整数値を返します。