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

Copy
1<?php
2
3/**
4 * 指定された配列の各要素が有効な評点（1から5の整数）であるか検証するクラス
5 */
6class ScoreValidator
7{
8    /**
9     * 評点の配列を検証します。
10     * 無効な値が含まれている場合、DomainExceptionをスローします。
11     *
12     * @param array $scores 評点の配列
13     * @return void
14     * @throws DomainException 配列に1から5以外の値が含まれている場合
15     */
16    public function validate(array $scores): void
17    {
18        foreach ($scores as $score) {
19            // is_int()で整数かチェックし、値が1から5の範囲にあるかチェック
20            if (!is_int($score) || $score < 1 || $score > 5) {
21                // 値が有効なドメイン（範囲）にないため、DomainExceptionをスロー
22                throw new DomainException(
23                    "無効な評点が見つかりました: {$score}。評点は1から5の整数である必要があります。"
24                );
25            }
26        }
27    }
28}
29
30// 検証用のデータ（無効な値 '6' を含む）
31$userScores = [5, 4, 3, 5, 6, 4];
32$validator = new ScoreValidator();
33
34try {
35    echo "評点配列を検証します..." . PHP_EOL;
36    $validator->validate($userScores);
37    echo "すべての評点は有効です。" . PHP_EOL;
38} catch (DomainException $e) {
39    // catchした例外オブジェクトをechoで出力すると、
40    // __toString() メソッドが暗黙的に呼び出され、
41    // 例外情報が整形された文字列として表示されます。
42    echo "エラーが発生しました:" . PHP_EOL;
43    echo $e;
44}

このPHPサンプルコードは、配列内の各評点が1から5の整数であるかを検証し、範囲外の値が見つかった場合にDomainExceptionという例外（エラーの一種）を発生させる例です。DomainExceptionは、値が期待される有効な範囲や集合に属していないことを示すために使用されます。

このコードの重要な点は、catchブロックで捕捉した例外オブジェクト $e を echo で出力している部分です。PHPでは、オブジェクトを文字列として扱おうとすると、内部で自動的に __toString() という特別なメソッドが呼び出されます。

DomainExceptionクラスに定義されている __toString() メソッドは、引数なしで呼び出され、戻り値としてエラーに関する詳細情報を含む文字列（string）を返します。この文字列には、例外のメッセージ、エラーが発生したファイル名、行番号、そして処理の呼び出し履歴（スタックトレース）などが、人間が読みやすい形式で整形されて含まれています。

そのため、echo $e; と記述するだけで、デバッグに役立つ詳細なエラー情報が画面に表示される仕組みになっています。

Copy
1<?php
2
3/**
4 * ユーザーの年齢を検証し、無効な場合はDomainExceptionをスローする関数
5 *
6 * @param int $age 検証する年齢
7 * @return void
8 * @throws DomainException 年齢が有効な範囲（0-150）にない場合
9 */
10function validateUserAge(int $age): void
11{
12    if ($age < 0 || $age > 150) {
13        // 値が定義された有効な範囲（ドメイン）にないため、DomainExceptionをスローする
14        throw new DomainException("年齢は0歳から150歳の間でなければなりません。入力された値: {$age}");
15    }
16}
17
18try {
19    // 無効な年齢で関数を呼び出し、意図的に例外を発生させる
20    validateUserAge(-10);
21} catch (DomainException $e) {
22    // catchブロックで例外オブジェクトを捕捉する
23    // 例外オブジェクトを文字列として出力しようとすると、
24    // 内部的に __toString() メソッドが自動的に呼び出される。
25    // このメソッドは、例外に関する詳細情報（メッセージ、ファイル、行番号、スタックトレース）を
26    // 整形された文字列として返す。
27    echo $e;
28
29    // 上記の `echo $e;` は、明示的に `__toString()` を呼び出す以下のコードと等価です。
30    // echo $e->__toString();
31}
32

DomainExceptionクラスの__toString()メソッドは、例外オブジェクトを文字列として扱おうとしたときに、そのオブジェクトの情報を文字列形式で提供するためのものです。このメソッドに引数はなく、戻り値として例外の詳細情報を含む文字列（string）を返します。

サンプルコードでは、まずvalidateUserAge関数が年齢を検証します。引数$ageが有効な範囲（0〜150歳）外の場合、「値が定義された有効な領域（ドメイン）にない」ことを示すDomainExceptionが生成され、スローされます。

try-catchブロックでは、この例外を意図的に発生させ、catchブロックで$eという変数に例外オブジェクトを捕捉しています。ここでecho $e;を実行すると、PHPはオブジェクト$eを文字列として出力しようとします。その際、内部で自動的に$eの__toString()メソッドが呼び出されます。

その結果、__toString()メソッドが返却する、例外メッセージ、エラーが発生したファイル名、行番号、そして処理の呼び出し履歴（スタックトレース）といったデバッグに役立つ情報が、整形された一つの文字列として画面に出力されます。このように、echo $e;と記述するだけで、例外の詳細を簡単に確認できます。