Interface CacheItemPoolInterface

CacheItemPoolInterface generates CacheItemInterface objects.

Direct known implementers

Kotchasan\Cache\Cache

Indirect known implementers

Kotchasan\Cache\ApcCache, Kotchasan\Cache\FileCache

Namespace: Psr\Cache
Located at Kotchasan/Psr/Cache/CacheItemPoolInterface.php

Methods summary
`public Psr\Cache\CacheItemInterface`	# `getItem( string $key )` Returns a Cache Item representing the specified key. Returns a Cache Item representing the specified key. This method must always return a CacheItemInterface object, even in case of a cache miss. It MUST NOT return null. The key for which to return the corresponding Cache Item. If the $key string is not a legal value a \Psr\Cache\InvalidArgumentException MUST be thrown. The corresponding Cache Item. Parameters `$key` Returns `Psr\Cache\CacheItemInterface` Throws `InvalidArgumentException`
`public array\|Traversable`	# `getItems( array $keys = array() )` Returns a traversable set of cache items. Returns a traversable set of cache items. An indexed array of keys of items to retrieve. If any of the keys in $keys are not a legal value a \Psr\Cache\InvalidArgumentException MUST be thrown. A traversable collection of Cache Items keyed by the cache keys of each item. A Cache item will be returned for each key, even if that key is not found. However, if no keys are specified then an empty traversable MUST be returned instead. Parameters `$keys` Returns array\|`Traversable` Throws `InvalidArgumentException`
`public boolean`	# `hasItem( string $key )` Confirms if the cache contains specified cache item. Confirms if the cache contains specified cache item. Note: This method MAY avoid retrieving the cached value for performance reasons. This could result in a race condition with CacheItemInterface::get(). To avoid such situation use CacheItemInterface::isHit() instead. The key for which to check existence. If the $key string is not a legal value a \Psr\Cache\InvalidArgumentException MUST be thrown. True if item exists in the cache, false otherwise. Parameters `$key` Returns boolean Throws `InvalidArgumentException`
`public boolean`	# `clear( )` Deletes all items in the pool. Deletes all items in the pool. True if the pool was successfully cleared. False if there was an error. Returns boolean
`public boolean`	# `deleteItem( string $key )` Removes the item from the pool. Removes the item from the pool. The key for which to delete If the $key string is not a legal value a \Psr\Cache\InvalidArgumentException MUST be thrown. True if the item was successfully removed. False if there was an error. Parameters `$key` Returns boolean Throws `InvalidArgumentException`
`public boolean`	# `deleteItems( array $keys )` Removes multiple items from the pool. Removes multiple items from the pool. An array of keys that should be removed from the pool. If any of the keys in $keys are not a legal value a \Psr\Cache\InvalidArgumentException MUST be thrown. True if the items were successfully removed. False if there was an error. Parameters `$keys` Returns boolean Throws `InvalidArgumentException`
`public boolean`	# `save( Psr\Cache\CacheItemInterface $item )` Persists a cache item immediately. Persists a cache item immediately. The cache item to save. True if the item was successfully persisted. False if there was an error. Parameters `$item` Returns boolean
`public boolean`	# `saveDeferred( Psr\Cache\CacheItemInterface $item )` Sets a cache item to be persisted later. Sets a cache item to be persisted later. The cache item to save. False if the item could not be queued or if a commit was attempted and failed. True otherwise. Parameters `$item` Returns boolean
`public boolean`	# `commit( )` Persists any deferred cache items. Persists any deferred cache items. True if all not-yet-saved items were successfully saved or there were none. False otherwise. Returns boolean