Class ClosureCacheAdapter

Cache adapter that defers to closures for implementation

Guzzle\Cache\ClosureCacheAdapter implements Guzzle\Cache\CacheAdapterInterface

Namespace: Guzzle\Cache
Located at Guzzle/Cache/ClosureCacheAdapter.php

Methods summary

public __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
public contains ( string $id, array $options = null )

Test if an entry exists in the cache.
public delete ( string $id, array $options = null )

Deletes a cache entry.
public fetch ( string $id, array $options = null )

Fetches an entry from the cache.
public save ( string $id, string $data, int|bool $lifeTime = false, array $options = null )

Puts data into the cache.

Methods detail


                     public


__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

$callables: array
$callables array of action names to callable

Throws

InvalidArgumentException
if the callable is not callable


                     public 
                    boolean


contains( string $id, array $options = null )

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.

Implementation of

Guzzle\Cache\CacheAdapterInterface::contains()


                     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

Implementation of

Guzzle\Cache\CacheAdapterInterface::delete()


                     public 
                    string


fetch( string $id, array $options = null )

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.

Implementation of

Guzzle\Cache\CacheAdapterInterface::fetch()


                     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

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

Implementation of

Guzzle\Cache\CacheAdapterInterface::save()

Magic methods summary

Properties summary

`protected array`	`$callables`	# Mapping of method names to callables

Namespaces

Classes

Interfaces

Class ClosureCacheAdapter

Methods summary

Methods detail

Parameters

Throws

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Parameters

Returns

Implementation of

Magic methods summary

Properties summary