CachingIterator::offsetUnset

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

CachingIterator::offsetUnset — Remove an element from the cache

Description

public function CachingIterator::offsetUnset(string $key): void

Removes the element stored under key from the cache. This method is called when unset() is used on the CachingIterator with array syntax, such as unset($iterator['key']). The inner iterator is not modified.

The CachingIterator::FULL_CACHE flag must be set.

Parameters

key

The key of the element to be removed.

Return Values

No value is returned.

Errors/Exceptions

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

See Also