Interface CacheAdapterInterface
Interface for cache adapters.
Cache adapters allow Guzzle to utilize various frameworks for caching HTTP responses.
Direct known implementers
Guzzle\Cache\AbstractCacheAdapter,
Guzzle\Cache\ClosureCacheAdapter
Indirect known implementers
Guzzle\Cache\DoctrineCacheAdapter,
Guzzle\Cache\NullCacheAdapter,
Guzzle\Cache\Zf2CacheAdapter
Namespace: Guzzle\Cache
Link: Inspired by Doctrine 2
Located at Guzzle/Cache/CacheAdapterInterface.php
Link: Inspired by Doctrine 2
Located at Guzzle/Cache/CacheAdapterInterface.php
Methods summary
-
publiccontains ( string $id, array $options = null )Test if an entry exists in the cache.
-
publicdelete ( string $id, array $options = null )Deletes a cache entry.
-
publicfetch ( string $id, array $options = null )Fetches an entry from the cache.
-
publicsave ( string $id, string $data, int|bool $lifeTime = false, array $options = null )Puts data into the cache.
Methods detail
Test if an entry exists in the cache.
Parameters
- $id
string
$id cache id The cache id of the entry to check for.- $options
array
$options Array of cache adapter options
Returns
booleanReturns TRUE if a cache entry exists for the given cache id, FALSE otherwise.
Deletes a cache entry.
Parameters
- $id
string
$id cache id- $options
array
$options Array of cache adapter options
Returns
booleanTRUE on success, FALSE on failure
Fetches an entry from the cache.
Parameters
- $id
string
$id cache id The id of the cache entry to fetch.- $options
array
$options Array of cache adapter options
Returns
stringThe cached data or FALSE, if no cache entry exists for the given id.
#
public
boolean
save( string $id, string $data, integer|boolean $lifeTime = false, array $options = null )
Puts data into the cache.
Parameters
- $id
string
$id The cache id- $data
string
$data The cache entry/data- $lifeTime
integer|boolean
$lifeTime The lifetime. If != false, sets a specific lifetime for this cache entry- $options
array
$options Array of cache adapter options
Returns
booleanTRUE if the entry was successfully stored in the cache, FALSE otherwise.