RecursiveCachingIterator::__construct

(PHP 5 >= 5.1.0, PHP 7, PHP 8)

RecursiveCachingIterator::__construct — Construct

Description

public function RecursiveCachingIterator::__construct(Iterator $iterator, int $flags = RecursiveCachingIterator::CALL_TOSTRING)

Constructs a new RecursiveCachingIterator, which consists of a passed in iterator.

Whether the current element has children is checked when the iterator moves to it. If it does, its children are wrapped in a new RecursiveCachingIterator created with the same flags, which RecursiveCachingIterator::getChildren() returns.

Parameters

iterator

The iterator being used. It must be a RecursiveIterator.

flags

A bitmask of the CachingIterator constants, as for CachingIterator::__construct().

With CachingIterator::CATCH_GET_CHILD, an exception thrown by the RecursiveIterator::hasChildren() or RecursiveIterator::getChildren() method of the inner iterator is discarded, and the current element is treated as having no children.

Changelog

Version Description
8.0.0 Now throws a ValueError if flags contains more than one of the string conversion flags; previously, an InvalidArgumentException was thrown.

See Also