【PHP8.x】codeプロパティの使い方

作成日: 更新日:

『codeプロパティは、例外の種類を識別するための整数コードを保持するプロパティです。このプロパティは、発生した例外がどのような種類のものであるかをプログラム的に区別するために使用されます。例えば、ファイル関連のエラーやデータベース関連のエラーなど、複数のエラーが発生しうる処理において、エラーメッセージの文字列だけでなく、この数値コードによって具体的なエラー原因を特定できます。try-catch構文のcatchブロック内で、捕捉したExceptionオブジェクトからgetCode()メソッドを呼び出すことで、このコードを取得できます。取得したコードの値に応じて、エラーログの出力内容を変えたり、ユーザーへの通知メッセージを切り替えたりするなど、条件分岐による詳細なエラーハンドリングが可能になります。Exceptionオブジェクトを生成する際に、コンストラクタの第二引数に整数値を渡すことで、このcodeプロパティに値を設定できます。引数を省略した場合、codeプロパティのデフォルト値は0になります。このプロパティは、より堅牢で詳細な例外処理を実装するための重要な要素です。

基本的な使い方

構文(syntax)

1<?php
2
3try {
4    // 第2引数で例外コードを指定してExceptionをスローする
5    throw new Exception("エラーメッセージ", 404);
6} catch (Exception $e) {
7    // 捕捉したExceptionオブジェクトのcodeプロパティにアクセスする
8    $errorCode = $e->code;
9    echo $errorCode; // 404が出力される
10}

引数(parameters)

戻り値(return)

int

Exception クラスの code プロパティは、例外が発生した際に付与された整数コードを返します。このコードは、例外の種類や発生場所を特定するのに役立ちます。

【PHP8.x】codeプロパティの使い方 | いっしー@Webエンジニア