CachingIterator::setFlags

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

CachingIterator::setFlags — Set the flags for the CachingIterator object

Description

public function CachingIterator::setFlags(int $flags): void

Replaces the flags of the CachingIterator with flags.

Turning CachingIterator::FULL_CACHE on empties the cache; elements are added to it from the next move of the iterator onwards.

Return Values

No value is returned.

Errors/Exceptions

Throws a ValueError if flags contains more than one of CachingIterator::CALL_TOSTRING, CachingIterator::TOSTRING_USE_KEY, CachingIterator::TOSTRING_USE_CURRENT and CachingIterator::TOSTRING_USE_INNER.

Throws an InvalidArgumentException if CachingIterator::CALL_TOSTRING or CachingIterator::TOSTRING_USE_INNER is currently set and flags does not contain it, as these flags cannot be unset.

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.

Examples

Example #1 Turning on the full cache

<?php
$iterator = new CachingIterator(new ArrayIterator(['a', 'b', 'c']), 0);
$iterator->setFlags(CachingIterator::FULL_CACHE);

foreach ($iterator as $value) {
    // ...
}

var_dump($iterator->getCache());
?>

The above example will output:

array(3) {
  [0]=>
  string(1) "a"
  [1]=>
  string(1) "b"
  [2]=>
  string(1) "c"
}

See Also