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

codeプロパティは、RuntimeExceptionオブジェクトが保持する例外コードを保持するプロパティです。このプロパティは、基底クラスであるExceptionクラスから継承されたものであり、プログラム実行時に発生したエラーの種類を数値で識別するために使用されます。開発者は、例外を発生させる際に、エラーメッセージと共にこの整数コードを指定することができます。主な目的は、catchブロック内で例外を捕捉した際に、エラーメッセージの文字列内容を解析することなく、コードの値によって処理を分岐させることです。例えば、同じRuntimeExceptionでも、データベース接続エラーにはコード100、ファイル書き込みエラーにはコード200を割り当てることで、コードに応じた具体的な復旧処理やログ出力を行うことが可能になります。この値は、RuntimeExceptionのインスタンスを生成する際のコンストラクタ第2引数で設定し、getCode()メソッドを通じて取得します。指定されなかった場合のデフォルト値は0です。このように、codeプロパティは、より構造化された堅牢なエラーハンドリングを実現するために重要な役割を果たします。

Copy
1<?php
2
3try {
4    // エラーコード 100 を指定して RuntimeException をスローする
5    throw new RuntimeException("何らかの実行時エラーが発生しました。", 100);
6} catch (RuntimeException $e) {
7    // 捕捉した例外の code プロパティの値を取得する
8    $errorCode = $e->getCode();
9    echo "エラーコード: " . $errorCode; // 出力: エラーコード: 100
10}
11
12?>

引数なし

引数はありません

int|string

RuntimeException クラスの code プロパティは、例外に関連付けられたエラーコードを返します。このコードは integer 型または string 型のいずれかです。