【PHP8.x】DateObjectError::__toString()メソッドの使い方

Copy
1<?php
2
3/**
4 * DateObjectError::__toString() メソッドと、配列処理中に発生するエラーのデモンストレーションです。
5 * このメソッドは、DateObjectError オブジェクトが文字列として扱われる際に自動的に呼び出されます。
6 *
7 * @param array<string> $dateStrings 処理する日付文字列の配列
8 */
9function processDateStrings(array $dateStrings): void
10{
11    foreach ($dateStrings as $index => $dateString) {
12        echo "要素 {$index} ('{$dateString}') を処理中... ";
13        try {
14            // 日付文字列から DateTimeImmutable オブジェクトを作成しようとします。
15            // PHP 8以降では、DateTimeImmutable のコンストラクタは無効な日付に対して
16            // DateObjectError (またはその親クラスである ValueError) をスローします。
17            $dateTime = new DateTimeImmutable($dateString);
18            echo "成功: " . $dateTime->format('Y-m-d H:i:s') . "\n";
19
20        } catch (DateObjectError $e) {
21            // DateObjectError が捕捉された場合、そのオブジェクトを直接 echo することで
22            // __toString() メソッドが自動的に呼び出され、エラーメッセージが返されます。
23            echo "エラー捕捉: " . $e . "\n"; 
24            // 上記は $e->getMessage() と同様の出力をしますが、
25            // オブジェクトを文字列として扱った際に__toString()が呼ばれることを示します。
26        } catch (Throwable $e) {
27            // DateObjectError 以外の予期せぬエラーも捕捉します。
28            echo "予期せぬエラー捕捉: " . $e->getMessage() . "\n";
29        }
30    }
31}
32
33// サンプルデータ: 有効な日付と無効な日付を含む配列
34$sampleDateArray = [
35    "2023-01-15",
36    "yesterday",
37    "invalid date format", // これが無効な日付としてDateObjectErrorを引き起こします
38    "tomorrow",
39    "2024-02-29",
40    "not a date at all",   // これも無効な日付としてDateObjectErrorを引き起こします
41];
42
43// 関数を実行して、DateObjectError の動作と配列処理を示します。
44processDateStrings($sampleDateArray);
45

DateObjectError::__toString()は、PHP 8以降で導入されたDateObjectErrorクラスの特別なメソッドです。このメソッドは引数を取らず、DateObjectErrorオブジェクトが文字列として扱われる（例えばechoされる）際に、自動的に呼び出されてエラーの内容を表す文字列を返します。

提供されたサンプルコードでは、日付文字列の配列を順に処理し、DateTimeImmutableオブジェクトを作成しようとしています。配列の中に「invalid date format」のような無効な日付文字列が含まれている場合、DateTimeImmutableのコンストラクタはDateObjectErrorをスローします。

try-catchブロックを使ってこのエラーを捕捉した際、catch (DateObjectError $e)ブロック内でecho $e;と記述することで、DateObjectErrorオブジェクト自体を文字列として出力しようとしています。このとき、PHPは自動的にDateObjectError::__toString()メソッドを呼び出し、エラーメッセージを文字列として取得して画面に表示します。これにより、エラーの詳細が簡潔に分かりやすく出力され、プログラムのデデバッグやエラー処理の実装に役立ちます。