Interface CacheAdapterInterface
Interface for cache adapters.
Cache adapters allow Guzzle to utilize various frameworks for caching HTTP
responses.
Methods summary
public
boolean
|
#
contains( string $id, array $options = null )
Test if an entry exists in the cache.
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
boolean Returns TRUE if a cache entry exists for the given cache id, FALSE otherwise.
|
public
boolean
|
#
delete( string $id, array $options = null )
Deletes a cache entry.
Parameters
- $id
string $id cache id
- $options
array $options Array of cache adapter options
Returns
boolean TRUE on success, FALSE on failure
|
public
string
|
#
fetch( string $id, array $options = null )
Fetches an entry from the cache.
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
string The 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.
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
boolean TRUE if the entry was successfully stored in the cache, FALSE otherwise.
|