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

『CALL_TOSTRING定数は、RecursiveCachingIteratorクラスのインスタンス生成時に、その動作を制御するために用いるフラグを表す定数です。この定数をコンストラクタの引数に指定することで、RecursiveCachingIteratorオブジェクトが文字列として評価される際の振る舞いを変更できます。具体的には、CALL_TOSTRINGフラグが有効な場合、echo文などでオブジェクトを直接文字列として出力しようとすると、イテレータが現在指している要素の__toString()メソッドが自動的に呼び出され、その返り値が表示されます。もしこのフラグが指定されていない状態でオブジェクトを文字列に変換しようとすると、エラーが発生する可能性があります。この機能は、繰り返し処理中の現在の要素を文字列として手軽に確認したい場合や、オブジェクトの内容をログに出力する際などに特に役立ちます。このように、CALL_TOSTRINGはRecursiveCachingIteratorの利便性を高め、オブジェクトをより柔軟に扱うための重要なオプションとして機能します。

Copy
1<?php
2
3// __toString()メソッドを持つオブジェクトを含む配列を用意します
4$data = [
5    new class {
6        public function __toString(): string
7        {
8            return 'Object converted to string.';
9        }
10    }
11];
12
13$iterator = new RecursiveArrayIterator($data);
14
15// コンストラクタの第2引数(flags)に定数 RecursiveCachingIterator::CALL_TOSTRING を指定します
16$cachingIterator = new RecursiveCachingIterator(
17    $iterator,
18    RecursiveCachingIterator::CALL_TOSTRING
19);
20
21foreach ($cachingIterator as $item) {
22    // CALL_TOSTRING フラグの効果により、オブジェクトを文字列として評価すると
23    // 自動的に __toString() メソッドが呼び出されます。
24    echo $item; // 出力: Object converted to string.
25}
26
27?>

引数なし

引数はありません

int

RecursiveCachingIterator::CALL_TOSTRING は、イテレータの各要素に対して __toString() メソッドが呼び出された際の挙動を制御するための定数で、整数値を返します。