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

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 配列をラップし、文字列に変換可能な機能を提供するクラス
7 */
8class ArrayStringifier
9{
10    /**
11     * @param array<int, mixed> $items 内部で保持する配列
12     * @throws LengthException 配列の要素数が5を超えた場合にスローされる
13     */
14    public function __construct(private array $items)
15    {
16        if (count($this->items) > 5) {
17            // 配列の長さが不正な場合に LengthException をスローする
18            throw new LengthException('配列の要素数は5個以下にしてください。');
19        }
20    }
21
22    /**
23     * オブジェクトが文字列として扱われた際に、配列の内容を文字列で返すマジックメソッド
24     *
25     * @return string 配列をカンマ区切りの文字列に変換したもの
26     */
27    public function __toString(): string
28    {
29        return 'ArrayItems: [' . implode(', ', $this->items) . ']';
30    }
31}
32
33// try-catch ブロックを使って例外処理を実装
34try {
35    // 正常なケース: 要素数が5以下の配列でオブジェクトを生成
36    $validArray = new ArrayStringifier([1, 2, 3, 4, 5]);
37
38    // オブジェクトを echo すると、__toString() メソッドが自動的に呼び出される
39    echo $validArray . PHP_EOL;
40
41    // 例外が発生するケース: 要素数が6個の配列でオブジェクトを生成
42    echo "6個の要素でオブジェクトを生成しようとします..." . PHP_EOL;
43    $invalidArray = new ArrayStringifier([1, 2, 3, 4, 5, 6]);
44    echo $invalidArray . PHP_EOL;
45
46} catch (LengthException $e) {
47    // LengthException がスローされた場合、ここで捕捉する
48    echo "エラーが発生しました。" . PHP_EOL;
49
50    // 例外オブジェクトを echo すると、そのクラスの __toString() メソッドが呼び出され、
51    // 例外情報が整形された文字列として出力される
52    echo $e;
53    echo PHP_EOL;
54}

このサンプルコードは、例外オブジェクトが持つ__toString()メソッドの挙動を示しています。__toString()は、オブジェクトがechoなどで文字列として扱われる際に自動的に呼び出される、PHPの「マジックメソッド」です。引数はなく、戻り値としてそのオブジェクトを表現する文字列(string)を返します。

LengthExceptionクラスは、PHPに組み込まれている例外クラスの一つで、__toString()メソッドを継承しています。このメソッドが呼び出されると、例外クラス名、エラーメッセージ、例外が発生したファイル名と行番号、スタックトレースといったデバッグに役立つ情報が整形された文字列として返されます。

サンプルコードでは、配列の要素数が5個を超えた場合にLengthExceptionを発生させています。try-catchブロックでこの例外を捕捉し、catchブロック内のecho $e;という処理に注目してください。ここで、捕捉した例外オブジェクト$eが文字列として扱われるため、LengthExceptionの__toString()メソッドが自動的に呼び出されます。その結果、コンストラクタで設定したエラーメッセージを含む、詳細な例外情報が画面に出力されます。このように、例外オブジェクトを直接echoするだけで、エラー内容を簡単に確認することができます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * パスワードの長さを検証する関数。
7 *
8 * @param string $password 検証するパスワード。
9 * @throws LengthException パスワードが8文字未満の場合。
10 */
11function validatePasswordLength(string $password): void
12{
13    $minLength = 8;
14    if (strlen($password) < $minLength) {
15        // 文字列の長さが要件を満たさない場合、LengthExceptionをスローする。
16        throw new LengthException("パスワードは{$minLength}文字以上である必要があります。");
17    }
18    echo 'パスワードは有効です。' . PHP_EOL;
19}
20
21try {
22    // 短すぎるパスワードを渡し、意図的に例外を発生させる。
23    validatePasswordLength('pass');
24} catch (LengthException $e) {
25    // 例外オブジェクトを文字列として出力する。
26    // この時、内部的に __toString() メソッドが自動的に呼び出され、
27    // 例外の詳細情報（メッセージ、ファイル名、行番号、スタックトレース）が
28    // 整形された文字列として返される。
29    echo $e;
30}

LengthException::__toString()は、LengthExceptionクラスのオブジェクトが文字列として扱われる際に、PHPによって自動的に呼び出される特殊なメソッドです。これは「マジックメソッド」の一種で、オブジェクトを文字列に変換する際の動作を定義します。

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

サンプルコードでは、validatePasswordLength関数が短いパスワードに対してLengthExceptionをスローしています。try...catchブロックでこの例外オブジェクト（変数$e）を捕捉し、echo $e;で出力しようとしています。オブジェクトを直接echoしようとすると、PHPは内部で自動的に__toString()メソッドを呼び出します。その結果、$eが保持している例外の詳細情報が、整形された文字列として画面に表示されます。このように、__toString()メソッドは、デバッグ時に例外オブジェクトの内容を手軽に確認するための便利な機能を提供します。