【PHP8.x】__toStringメソッドの使い方

Copy
1<?php
2
3// DateError クラスの __toString メソッドのサンプルコード
4
5// DateError クラスを拡張
6class CustomDateError extends DateError {
7    public function __construct(string $message = "", int $code = 0, ?Throwable $previous = null) {
8        parent::__construct($message, $code, $previous);
9    }
10
11    // __toString メソッドをオーバーライド
12    public function __toString(): string {
13        return "Custom DateError: " . $this->getMessage() . " (Code: " . $this->getCode() . ")";
14    }
15}
16
17// CustomDateError オブジェクトを作成
18$error = new CustomDateError("Invalid date format", 100);
19
20// オブジェクトを文字列として出力
21echo $error; // 出力: Custom DateError: Invalid date format (Code: 100)
22
23?>

このサンプルコードは、PHP 8 の DateError クラスの __toString メソッドの使い方を示しています。DateError は、日付関連のエラーを表す例外クラスです。__toString メソッドは、オブジェクトを文字列として表現するために使用されます。

この例では、まず DateError クラスを拡張した CustomDateError クラスを定義しています。CustomDateError クラスでは、__toString メソッドをオーバーライドし、エラーメッセージとエラーコードを含む独自の文字列を返すようにしています。

__toString メソッドは引数を取りません。このメソッドが呼び出されると、CustomDateError オブジェクトが文字列に変換され、return で返された文字列が出力されます。

CustomDateError オブジェクトを作成し、echo ステートメントで出力しています。echo ステートメントは、オブジェクトを文字列に変換するために、自動的に __toString メソッドを呼び出します。その結果、"Custom DateError: Invalid date format (Code: 100)" という文字列が出力されます。

この例から、__toString メソッドをオーバーライドすることで、オブジェクトの文字列表現をカスタマイズできることがわかります。これは、デバッグやログ出力など、オブジェクトの内容を人間が読みやすい形で表示する必要がある場合に便利です。

Copy
1<?php
2
3// DateError クラスの __toString() メソッドの例
4
5// DateError クラス (PHP 8 以降)
6try {
7    $date = new DateTime('invalid date');
8} catch (Exception $e) {
9    if ($e instanceof DateError) {
10        // DateError オブジェクトを文字列に変換
11        echo (string)$e;
12    } else {
13        echo "An error occurred: " . $e->getMessage();
14    }
15}

PHP 8 以降で使用できる DateError クラスの __toString() メソッドについて解説します。このメソッドは、DateError オブジェクトを文字列として表現するために使用されます。PHP には、オブジェクトを文字列に変換する必要がある場合に自動的に呼び出される __toString() という特別なメソッドが存在します。DateError クラスにも同様の役割を果たすメソッドが定義されています。

サンプルコードでは、まず DateTime クラスのコンストラクタに無効な日付文字列を渡すことで、DateError 例外を発生させています。try-catch ブロックを使用することで、例外を適切に処理しています。

catch ブロック内では、捕捉した例外が DateError クラスのインスタンスであるかどうかを確認しています。$e instanceof DateError は、例外オブジェクト $e が DateError クラスのインスタンスである場合に true を返します。

DateError オブジェクトである場合、(string)$e によって $e オブジェクトが文字列に変換されます。このとき、DateError クラスの __toString() メソッドが内部的に呼び出され、DateError オブジェクトを表す文字列が生成されます。生成された文字列は echo によって出力されます。

__toString() メソッドは引数を取らず、文字列を返します。この文字列は、通常、エラーに関する何らかの説明を含む人間が読める形式になります。この例では、DateError オブジェクトを文字列として出力することで、エラーの内容を簡単に確認できます。