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

Copy
1<?php
2
3/**
4 * __toString() メソッドを持つサンプルクラス
5 *
6 * このクラスのインスタンスが文字列として扱われると、
7 * __toString() メソッドが自動的に呼び出されます。
8 */
9class ToStringObject
10{
11    private string $value;
12
13    public function __construct(string $value)
14    {
15        $this->value = $value;
16    }
17
18    public function __toString(): string
19    {
20        return "Object({$this->value})";
21    }
22}
23
24// 再帰的な構造を持つサンプルデータ配列
25// 文字列と ToStringObject のインスタンスが含まれています。
26$data = [
27    'Apple',
28    'Banana',
29    new ToStringObject('Orange'),
30    [
31        'Red',
32        new ToStringObject('Green'),
33        'Blue',
34    ],
35];
36
37try {
38    // RecursiveArrayIterator は、多次元配列を再帰的に反復処理します。
39    $arrayIterator = new RecursiveArrayIterator($data);
40
41    // RecursiveCachingIterator は、イテレータの機能を拡張します。
42    // 第2引数に RecursiveCachingIterator::CALL_TOSTRING フラグを渡すことで、
43    // イテレータの要素が文字列として評価される際に、その要素の
44    // __toString() メソッドを呼び出すように設定します。
45    $cachingIterator = new RecursiveCachingIterator(
46        $arrayIterator,
47        RecursiveCachingIterator::CALL_TOSTRING
48    );
49
50    // RecursiveIteratorIterator は、再帰的なイテレータをフラットなリストとして扱えるようにします。
51    $iterator = new RecursiveIteratorIterator($cachingIterator);
52
53    // イテレータをループ処理して各要素を出力します。
54    foreach ($iterator as $key => $value) {
55        // echo は値を文字列として出力するため、$value が ToStringObject のインスタンスの場合、
56        // CALL_TOSTRING フラグの効果により __toString() メソッドが呼び出されます。
57        echo "{$key}: {$value}" . PHP_EOL;
58    }
59} catch (Exception $e) {
60    echo 'エラー: ' . $e->getMessage();
61}
62
63?>

RecursiveCachingIterator::CALL_TOSTRINGは、イテレータがオブジェクトを扱う際の挙動を指定するための定数です。この定数をフラグとして設定すると、オブジェクトを文字列として評価する際に、そのオブジェクトが持つ__toString()メソッドが自動的に呼び出されるようになります。__toString()は、オブジェクトが文字列として扱われたときにどのような文字列を返すかを定義する特殊なメソッドです。

サンプルコードでは、__toString()メソッドを持つToStringObjectクラスを定義しています。このクラスのインスタンスを含む多次元配列をイテレータで処理する際に、RecursiveCachingIteratorの第2引数としてCALL_TOSTRINGを指定しています。

これにより、foreachループ内でechoを使って各要素を出力する際、値がToStringObjectのインスタンスであれば、自動的に__toString()メソッドが実行されます。その結果、オブジェクトそのものではなく、「Object(Orange)」のような__toString()が返す文字列が出力されます。この定数自体は引数を持たず、その値は整数（int）型で、イテレータの挙動を制御するフラグとして機能します。

Copy
1<?php
2
3/**
4 * __toStringメソッドを持つサンプルクラス
5 */
6class Book
7{
8    public function __construct(private string $title)
9    {
10    }
11
12    /**
13     * このオブジェクトが文字列として扱われたときに呼び出されるマジックメソッド
14     *
15     * @return string
16     */
17    public function __toString(): string
18    {
19        return $this->title;
20    }
21}
22
23/**
24 * RecursiveCachingIterator::CALL_TOSTRING の使用例を示す関数
25 *
26 * このフラグを指定すると、イテレータがオブジェクトを指している場合に、
27 * そのオブジェクトの __toString() メソッドが自動的に呼び出され、
28 * 結果の文字列が値として返されます。
29 */
30function demonstrateCallToString(): void
31{
32    // 再帰的な構造を持つデータ (子配列を含む)
33    $data = [
34        new Book('PHP 8入門'),
35        'デザインパターン',
36        [
37            new Book('アルゴリズム図鑑'),
38            new Book('データベース設計'),
39        ],
40    ];
41
42    // 配列を再帰的に走査するためのイテレータを作成
43    $arrayIterator = new RecursiveArrayIterator($data);
44
45    // RecursiveCachingIteratorでラップし、CALL_TOSTRINGフラグを指定
46    // これにより、Bookオブジェクトが文字列に変換される
47    $cachingIterator = new RecursiveCachingIterator(
48        $arrayIterator,
49        RecursiveCachingIterator::CALL_TOSTRING
50    );
51
52    // 再帰的なイテレータをフラットに（一次元的に）処理するためのイテレータ
53    $iterator = new RecursiveIteratorIterator($cachingIterator);
54
55    echo "ライブラリ一覧:" . PHP_EOL;
56    foreach ($iterator as $item) {
57        // CALL_TOSTRINGのおかげで、Bookオブジェクトは__toString()の結果（タイトル）として出力される
58        echo "- " . $item . PHP_EOL;
59    }
60}
61
62// 関数を実行して結果を表示
63demonstrateCallToString();
64
65/*
66実行結果:
67
68ライブラリ一覧:
69- PHP 8入門
70- デザインパターン
71- アルゴリズム図鑑
72- データベース設計
73
74*/

RecursiveCachingIterator::CALL_TOSTRINGは、イテレータ（データを順番に処理するための仕組み）を扱うRecursiveCachingIteratorクラスで使用する設定値（定数）です。この定数を指定すると、イテレータが処理する要素がオブジェクトだった場合に、そのオブジェクトが持つ__toString()メソッドを自動的に呼び出し、その結果（文字列）を値として返却するようになります。__toString()は、オブジェクトが文字列として扱われたときに自動的に実行される特別なメソッドです。

サンプルコードでは、本のタイトルを持つBookオブジェクトと、通常の文字列が混在した入れ子構造の配列を扱っています。RecursiveCachingIteratorを作成する際に、第2引数としてCALL_TOSTRINGが指定されています。

これにより、foreachループで各要素を取り出す際、要素がBookオブジェクトであっても、自動的にBookクラスの__toString()メソッドが呼び出されます。その結果、オブジェクトは本のタイトル文字列に変換されるため、もともと文字列だった「デザインパターン」のような要素と区別なく、統一的に文字列として出力できます。

このようにCALL_TOSTRINGは、オブジェクトと文字列が混在するデータ構造をシンプルに扱いたい場合に非常に便利な機能です。