CachingIterator::__construct
新しい CachingIterator オブジェクトを作成する
説明
public CachingIterator::__construct(Iterator $iterator, int $flags = CachingIterator::CALL_TOSTRING)
iterator を 1 要素先読みしながら反復処理する
CachingIterator を作成します。
パラメータ
-
iterator
-
キャッシュしたいイテレータ。
-
flags
-
CachingIterator の定数のビットマスク。
CachingIterator::CALL_TOSTRING、
CachingIterator::TOSTRING_USE_KEY、
CachingIterator::TOSTRING_USE_CURRENT、
CachingIterator::TOSTRING_USE_INNER
のうち、指定できるのはひとつまでです。
CachingIterator::__toString は指定したフラグに応じた文字列を返し、
どれも指定しない場合は例外をスローします。
CachingIterator::FULL_CACHE を指定すると、
これまでに反復処理したすべての要素を保持します。
保持した要素には、配列構文や
CachingIterator::getCache でアクセスできます。
エラー / 例外
flags に
CachingIterator::CALL_TOSTRING、
CachingIterator::TOSTRING_USE_KEY、
CachingIterator::TOSTRING_USE_CURRENT、
CachingIterator::TOSTRING_USE_INNER
のうち複数が含まれている場合、
ValueError をスローします。
注意
警告
デフォルトの CachingIterator::CALL_TOSTRING では、
CachingIterator::__toString をコールするかどうかにかかわらず、
イテレータが要素に移動した時点でその要素を文字列に変換します。
要素が配列の場合は E_WARNING が発生し、
__toString() を実装していないオブジェクトの場合は
Error がスローされます。
こうした要素を反復処理するには、flags に
CachingIterator::CALL_TOSTRING を含まない値 (0 など) を渡してください。
参考
- CachingIterator::setFlags
- CachingIterator::__toString
- RecursiveCachingIterator::__construct