【PHP8.x】CachingIterator::CALL_TOSTRING定数の使い方

Copy
1<?php
2
3/**
4 * オブジェクトが文字列として扱われた際に呼ばれる __toString() メソッドを持つクラス。
5 */
6final class Book
7{
8    private string $title;
9
10    public function __construct(string $title)
11    {
12        $this->title = $title;
13    }
14
15    /**
16     * このオブジェクトの文字列表現を返すマジックメソッド。
17     * @return string
18     */
19    public function __toString(): string
20    {
21        return $this->title;
22    }
23}
24
25/**
26 * CachingIterator::CALL_TOSTRING の使用例を示します。
27 *
28 * このフラグを指定すると、CachingIterator のインスタンス自体を文字列として
29 * 評価しようとしたとき（例: echo）、現在の要素の __toString() メソッドが自動的に呼び出されます。
30 */
31function demonstrateCachingIteratorCallToString(): void
32{
33    // イテレーションの対象となるオブジェクトの配列を作成
34    $books = new ArrayIterator([
35        new Book('PHP Programming'),
36        new Book('Learning SQL'),
37        new Book('Design Patterns')
38    ]);
39
40    // ArrayIterator を CachingIterator でラップします。
41    // 第2引数に CachingIterator::CALL_TOSTRING フラグを渡します。
42    $iterator = new CachingIterator($books, CachingIterator::CALL_TOSTRING);
43
44    // イテレータをループ処理します
45    foreach ($iterator as $book) {
46        // CachingIterator インスタンス ($iterator) を直接 echo します。
47        // CALL_TOSTRING フラグの効果により、現在の要素である Book オブジェクトの
48        // __toString() メソッドが呼び出され、その結果（本のタイトル）が出力されます。
49        echo 'Current item from iterator: ' . $iterator . PHP_EOL;
50    }
51}
52
53// 関数を実行してデモを表示します
54demonstrateCachingIteratorCallToString();
55
56?>

CachingIterator::CALL_TOSTRINGは、CachingIteratorクラスの動作を制御するために使用される整数型の定数です。この定数をCachingIteratorのインスタンスを作成する際に設定すると、イテレータ自体を文字列として扱おうとしたときの挙動を特殊なものに変更します。

具体的には、このフラグが有効なCachingIteratorのインスタンスをechoなどで出力しようとすると、イテレータが現在指している要素の__toString()メソッドが自動的に呼び出されます。そして、その__toString()メソッドが返した文字列が、CachingIteratorインスタンス自体の文字列表現として使用されます。

サンプルコードでは、__toString()メソッドを持つBookクラスのオブジェクトを扱うイテレータをCALL_TOSTRINGフラグ付きで作成しています。foreachループの中で$iterator変数を直接echoすると、現在ループで選択されているBookオブジェクトの__toString()が実行され、戻り値である本のタイトルが出力されます。このように、現在の要素の文字列表現を簡単に取得するために利用できます。

Copy
1<?php
2
3declare(strict_types=1);
4
5/**
6 * 文字列として表現できるUserクラス
7 * このクラスのインスタンスは、文字列コンテキストで扱われると __toString() メソッドを呼び出します。
8 */
9class User
10{
11    /**
12     * @param string $name ユーザー名
13     */
14    public function __construct(private string $name)
15    {
16    }
17
18    /**
19     * オブジェクトが文字列として扱われた場合に、ユーザー名を返すマジックメソッド。
20     * @return string
21     */
22    public function __toString(): string
23    {
24        return $this->name;
25    }
26
27    /**
28     * オブジェクトのプロパティにアクセスするためのメソッド。
29     * @return string
30     */
31    public function getName(): string
32    {
33        return $this->name;
34    }
35}
36
37/**
38 * CachingIterator::CALL_TOSTRING の動作を示す関数
39 */
40function demonstrateCallToString(): void
41{
42    // __toString() メソッドを持つオブジェクトの配列を作成
43    $users = [
44        new User('Alice'),
45        new User('Bob'),
46        new User('Charlie'),
47    ];
48    $userIterator = new ArrayIterator($users);
49
50    // --- 比較のため、フラグを指定しない場合の動作 ---
51    echo '--- フラグなしの場合 ---' . PHP_EOL;
52    $iteratorWithoutFlag = new CachingIterator($userIterator);
53    foreach ($iteratorWithoutFlag as $value) {
54        // ループで取得されるのは User オブジェクトそのもの
55        echo '取得した値の型: ' . get_class($value) . PHP_EOL;
56        // プロパティにアクセスするにはメソッドを呼び出す必要がある
57        echo '名前: ' . $value->getName() . PHP_EOL;
58    }
59    echo PHP_EOL;
60
61
62    // --- CachingIterator::CALL_TOSTRING フラグを指定した場合の動作 ---
63    echo '--- CachingIterator::CALL_TOSTRING フラグありの場合 ---' . PHP_EOL;
64    // イテレータを CachingIterator でラップし、CALL_TOSTRING フラグを指定する
65    $iteratorWithFlag = new CachingIterator($userIterator, CachingIterator::CALL_TOSTRING);
66    foreach ($iteratorWithFlag as $value) {
67        // このフラグにより、ループで取得される値は User オブジェクトの
68        // __toString() メソッドが返した「文字列」になる
69        echo '取得した値の型: ' . gettype($value) . PHP_EOL;
70        echo '名前: ' . $value . PHP_EOL;
71    }
72}
73
74demonstrateCallToString();

CachingIterator::CALL_TOSTRINGは、CachingIteratorクラスの動作を制御するための整数型の定数です。この定数をCachingIteratorのコンストラクタの第2引数（フラグ）に指定すると、イテレータの挙動が変化します。

通常、イテレータは配列などの要素をそのまま返しますが、CALL_TOSTRINGフラグが指定されている場合、各要素に対して__toString()メソッドを自動的に呼び出します。そして、ループで受け取る値は、元のオブジェクトではなく、__toString()メソッドが返した文字列になります。

サンプルコードでは、__toString()メソッドを持つUserクラスのオブジェクト配列を扱っています。フラグを指定しない場合、ループで受け取る値はUserオブジェクトそのものです。一方、CachingIterator::CALL_TOSTRINGを指定すると、ループで受け取る値はUserオブジェクトの__toString()メソッドが返したユーザー名の文字列に変わります。この機能により、オブジェクトの配列を反復処理する際に、各オブジェクトを文字列として直接扱うことができ、コードを簡潔に記述できます。