Guzzle\Cache\ClosureCacheAdapter Class Reference

Inheritance diagram for Guzzle\Cache\ClosureCacheAdapter:

Public Member Functions
	__construct (array $callables)
	contains ($id, array $options=null)
	delete ($id, array $options=null)
	fetch ($id, array $options=null)
	save ($id, $data, $lifeTime=false, array $options=null)

Protected Attributes
	$callables

Detailed Description

Cache adapter that defers to closures for implementation

Definition at line 8 of file ClosureCacheAdapter.php.

Constructor & Destructor Documentation

__construct()

Guzzle\Cache\ClosureCacheAdapter::__construct

(

array

$callables

)

The callables array is an array mapping the actions of the cache adapter to callables.

• contains: Callable that accepts an $id and $options argument
• delete: Callable that accepts an $id and $options argument
• fetch: Callable that accepts an $id and $options argument
• save: Callable that accepts an $id, $data, $lifeTime, and $options argument

Parameters

array

$callables

array of action names to callable

Exceptions

Definition at line 29 of file ClosureCacheAdapter.php.

References Guzzle\Cache\ClosureCacheAdapter\$callables.

Member Function Documentation

contains()

Guzzle\Cache\ClosureCacheAdapter::contains	(		$id,
		array	$options = null
	)

Test if an entry exists in the cache.

Parameters

string	$id	cache id The cache id of the entry to check for.
array	$options	Array of cache adapter options

Returns

bool Returns TRUE if a cache entry exists for the given cache id, FALSE otherwise.

Implements Guzzle\Cache\CacheAdapterInterface.

Definition at line 41 of file ClosureCacheAdapter.php.

delete()

Guzzle\Cache\ClosureCacheAdapter::delete	(		$id,
		array	$options = null
	)

Deletes a cache entry.

Parameters

string	$id	cache id
array	$options	Array of cache adapter options

Returns

bool TRUE on success, FALSE on failure

Implements Guzzle\Cache\CacheAdapterInterface.

Definition at line 46 of file ClosureCacheAdapter.php.

fetch()

Guzzle\Cache\ClosureCacheAdapter::fetch	(		$id,
		array	$options = null
	)

Fetches an entry from the cache.

Parameters

string	$id	cache id The id of the cache entry to fetch.
array	$options	Array of cache adapter options

Returns

string The cached data or FALSE, if no cache entry exists for the given id.

Implements Guzzle\Cache\CacheAdapterInterface.

Definition at line 51 of file ClosureCacheAdapter.php.

save()

Guzzle\Cache\ClosureCacheAdapter::save	(		$id,
			$data,
			$lifeTime = false,
		array	$options = null
	)

Puts data into the cache.

Parameters

string	$id	The cache id
string	$data	The cache entry/data
int | bool	$lifeTime	The lifetime. If != false, sets a specific lifetime for this cache entry
array	$options	Array of cache adapter options

Returns

bool TRUE if the entry was successfully stored in the cache, FALSE otherwise.

Implements Guzzle\Cache\CacheAdapterInterface.

Definition at line 56 of file ClosureCacheAdapter.php.

Field Documentation

$callables

array Guzzle\Cache\ClosureCacheAdapter::$callables

protected

Mapping of method names to callables

Definition at line 16 of file ClosureCacheAdapter.php.

Referenced by Guzzle\Cache\ClosureCacheAdapter\__construct().

---

The documentation for this class was generated from the following file:

• ClosureCacheAdapter.php