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

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

作成日: 更新日:

基本的な使い方

codeプロパティは、DateMalformedStringExceptionクラスに属し、発生した例外の種類を示す整数値を保持するプロパティです。

DateMalformedStringExceptionクラスは、PHP 8で導入された例外クラスで、日付や時刻に関連する関数やメソッド(例えばDateTimeオブジェクトの生成など)に、不正な形式の文字列が渡された場合にスローされます。つまり、プログラムが日付データを処理する際に、期待される形式とは異なる無効な文字列が入力されたときに発生するエラーを表します。

このcodeプロパティは、PHPの標準的な例外クラスであるExceptionが持つ同名のプロパティと同様に、エラーの種類をさらに細かく区別するための識別子として機能します。例えば、特定のエラーパターンに対して固有のコードが割り当てられている場合、そのコードをこのプロパティから取得できます。

システムエンジニアが堅牢なプログラムを構築する際には、try-catchブロックを使用してこのような例外を捕獲し、適切に処理することが一般的です。DateMalformedStringExceptionをキャッチした際に、このcodeプロパティの値を参照することで、どのような種類の不正な文字列が渡されたのか、より具体的なエラー原因を特定し、それに基づいて異なるエラーハンドリング(例えば、ユーザーへの詳細なエラーメッセージ表示、ログへの詳細な記録、問題のあるデータのスキップなど)を行うことが可能になります。

このプロパティの値は、例外がスローされる際にPHPの内部機構によって設定されるものであり、開発者が直接設定することは通常ありません。エラー発生時のデバッグやシステム監視において、問題の種類を素早く識別し、適切な対応を決定するための重要な情報源となります。

構文(syntax)

1<?php
2try {
3    new DateTimeImmutable('malformed date string');
4} catch (DateMalformedStringException $e) {
5    echo $e->code;
6}

引数(parameters)

戻り値(return)

int

このプロパティは、日付文字列の解析に失敗した原因を示す整数コードを返します。

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