php8.5
Home/ Manual/ spl / cachingiterator/ CachingIterator::getCache

CachingIterator::getCache

PHP function Edit on GitHub ✎

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

Retrieve the contents of the cache

Description

CachingIterator::getCache(): array

Retrieve the contents of the cache.

Note

The CachingIterator::FULL_CACHE flag must be being used.

Parameters Parameters

Return Values

An array containing the cache items.

Errors/Exceptions

Throws a BadMethodCallException when the CachingIterator::FULL_CACHE flag is not being used.

Examples

CachingIterator::getCache example

php
<?php
$iterator = new ArrayIterator(array(1, 2, 3));
$cache    = new CachingIterator($iterator, CachingIterator::FULL_CACHE);

$cache->next();
$cache->next();
var_dump($cache->getCache());

$cache->next();
var_dump($cache->getCache());
?>

The above example will output:

output
array(2) {
  [0]=>
  int(1)
  [1]=>
  int(2)
}
array(3) {
  [0]=>
  int(1)
  [1]=>
  int(2)
  [2]=>
  int(3)
}

Source: reference/spl/cachingiterator/getcache.xml · from the official PHP manual (php/doc-en)