CacheItemPoolInterface generates CacheItemInterface objects.

The primary purpose of Cache\CacheItemPoolInterface is to accept a key from
the Calling Library and return the associated Cache\CacheItemInterface object.
It is also the primary point of interaction with the entire cache collection.
All configuration and initialization of the Pool is left up to an
Implementing Library.

AbstractInterface
Methods
public abstract clear()
 

Deletes all items in the pool.

  • return bool True if the pool was successfully cleared. False if there was an error.
public abstract commit()
 

Persists any deferred cache items.

  • return bool True if all not-yet-saved items were successfully saved or there were none. False otherwise.
public abstract deleteItem( $key)
 

Removes the item from the pool.

  • throws Psr\Cache\InvalidArgumentException If the $key string is not a legal value a \Psr\Cache\InvalidArgumentException MUST be thrown.
  • return bool True if the item was successfully removed. False if there was an error.
public abstract deleteItems(array $keys)
 

Removes multiple items from the pool.

  • throws Psr\Cache\InvalidArgumentException If any of the keys in $keys are not a legal value a \Psr\Cache\InvalidArgumentException MUST be thrown.
  • return bool True if the items were successfully removed. False if there was an error.
public abstract getItem( $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.

public abstract getItems(array $keys = [])
 

Returns a traversable set of cache items.

  • throws Psr\Cache\InvalidArgumentException If any of the keys in $keys are not a legal value a \Psr\Cache\InvalidArgumentException MUST be thrown.
  • return array|\Traversable 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.
public abstract hasItem( $key)
 

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.

  • throws Psr\Cache\InvalidArgumentException If the $key string is not a legal value a \Psr\Cache\InvalidArgumentException MUST be thrown.
  • return bool True if item exists in the cache, false otherwise.
public abstract save(Psr\Cache\CacheItemInterface $item)
 

Persists a cache item immediately.

  • return bool True if the item was successfully persisted. False if there was an error.
public abstract saveDeferred(Psr\Cache\CacheItemInterface $item)
 

Sets a cache item to be persisted later.

  • return bool False if the item could not be queued or if a commit was attempted and failed. True otherwise.
© 2020 Bruce Wells
Search Namespaces \ Classes
ConfigurationNumbers (0-9.) only