CachingIterator::offsetGet

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

CachingIterator::offsetGet — Return an element from the cache

Description

public function CachingIterator::offsetGet(string $key): mixed

Returns the element stored under key in the cache. This method is called when the CachingIterator is read with array syntax, such as $iterator['key'].

The CachingIterator::FULL_CACHE flag must be set.

Parameters

key

The key of the element to retrieve.

Return Values

Returns the cached element, or null if there is no element with the given key in the cache.

Errors/Exceptions

Throws a BadMethodCallException if the CachingIterator::FULL_CACHE flag is not set.

Emits an E_WARNING if there is no element with the given key in the cache.

Examples

Example #1 Accessing elements that have been iterated over

<?php
$iterator = new CachingIterator(
    new ArrayIterator(['apple' => 3, 'banana' => 5, 'cherry' => 7]),
    CachingIterator::FULL_CACHE
);

foreach ($iterator as $fruit => $count) {
    if ($fruit === 'banana') {
        break;
    }
}

var_dump($iterator['apple']);
var_dump(isset($iterator['cherry']));
?>

The above example will output:

int(3)
bool(false)

See Also