CachingIterator::getCache

Retrieve the contents of the cache

&reftitle.description; public `array` `CachingIterator::getCache`

Retrieve the contents of the cache.

The `CachingIterator::FULL_CACHE` flag must be being used.

&reftitle.parameters; &no.function.parameters;
&reftitle.returnvalues;

An `array` containing the cache items.

&reftitle.errors;

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

&reftitle.examples;

### `CachingIterator::getCache` example

    <?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());
    ?>

&example.outputs;

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