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

codeプロパティの使い方について、初心者にもわかりやすく解説します。

作成日: 更新日:

基本的な使い方

codeプロパティは、例外に関連付けられた整数型の例外コードを保持するプロパティです。このプロパティは、DatePeriodクラスのコンストラクタなどで無効な日付や時刻の範囲が指定された場合にスローされるDateRangeErrorオブジェクトが持つ、エラーの具体的な種類を識別するための数値です。例外をプログラム的に処理する際、例外メッセージの文字列を解析する代わりに、この整数コードを用いることで、より信頼性が高く効率的なエラーハンドリングが可能になります。例えば、try-catchブロックでDateRangeErrorを捕捉した際に、codeプロパティの値を確認し、その数値に応じて処理を分岐させることができます。このプロパティは基底クラスであるErrorクラスから継承されたものであり、DateRangeErrorが生成される際にコンストラクタの引数として明示的にコードが指定されなかった場合、デフォルト値として0が設定されます。

構文(syntax)

1<?php
2
3try {
4    // このコードは DateRangeError を発生させます
5    new DatePeriod('2023-01-10', new DateInterval('P1D'), '2023-01-01');
6} catch (DateRangeError $e) {
7    // DateRangeError オブジェクトの 'code' プロパティにアクセスします
8    $code = $e->code;
9    echo $code;
10}
11
12?>

引数(parameters)

戻り値(return)

int

DateRangeError クラスの code プロパティは、発生したエラーのコードを示す整数値を返します。

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