Guzzle\Plugin\Cache\DefaultCacheStorage Class Reference

Inheritance diagram for Guzzle\Plugin\Cache\DefaultCacheStorage:

Public Member Functions
	__construct ($cache, $keyPrefix='', $defaultTtl=3600)
	cache (RequestInterface $request, Response $response)
	delete (RequestInterface $request)
	fetch (RequestInterface $request)
	purge ($url)

Protected Member Functions
	getBodyKey ($url, EntityBodyInterface $body)
	getCacheKey (RequestInterface $request)

Protected Attributes
	$cache
	$defaultTtl
	$keyPrefix

Detailed Description

Default cache storage implementation

Definition at line 16 of file DefaultCacheStorage.php.

Constructor & Destructor Documentation

__construct()

Guzzle\Plugin\Cache\DefaultCacheStorage::__construct	(		$cache,
			$keyPrefix = '',
			$defaultTtl = 3600
	)

Parameters

mixed	$cache	Cache used to store cache data
string	$keyPrefix	Provide an optional key prefix to prefix on all cache keys
int	$defaultTtl	Default cache TTL

Definition at line 41 of file DefaultCacheStorage.php.

References Guzzle\Plugin\Cache\DefaultCacheStorage\$cache, Guzzle\Plugin\Cache\DefaultCacheStorage\$defaultTtl, Guzzle\Plugin\Cache\DefaultCacheStorage\$keyPrefix, Guzzle\Plugin\Cache\DefaultCacheStorage\cache(), and Guzzle\Cache\CacheAdapterFactory\fromCache().

Member Function Documentation

cache()

Guzzle\Plugin\Cache\DefaultCacheStorage::cache	(	RequestInterface	$request,
		Response	$response
	)

Cache an HTTP request

Parameters

RequestInterface	$request	Request being cached
Response	$response	Response to cache

Implements Guzzle\Plugin\Cache\CacheStorageInterface.

Definition at line 48 of file DefaultCacheStorage.php.

References Guzzle\Plugin\Cache\DefaultCacheStorage\$defaultTtl, Guzzle\Plugin\Cache\DefaultCacheStorage\getBodyKey(), Guzzle\Plugin\Cache\DefaultCacheStorage\getCacheKey(), Guzzle\Http\Message\MessageInterface\getParams(), and Guzzle\Http\Message\RequestInterface\getUrl().

Referenced by Guzzle\Plugin\Cache\DefaultCacheStorage\__construct(), Guzzle\Plugin\Cache\DefaultCacheStorage\delete(), and Guzzle\Plugin\Cache\DefaultCacheStorage\fetch().

delete()

Guzzle\Plugin\Cache\DefaultCacheStorage::delete

(

RequestInterface

$request

)

Deletes cache entries that match a request

Parameters

RequestInterface

$request

Request to delete from cache

Implements Guzzle\Plugin\Cache\CacheStorageInterface.

Definition at line 111 of file DefaultCacheStorage.php.

References Guzzle\Plugin\Cache\DefaultCacheStorage\cache(), and Guzzle\Plugin\Cache\DefaultCacheStorage\getCacheKey().

fetch()

Guzzle\Plugin\Cache\DefaultCacheStorage::fetch

(

RequestInterface

$request

)

Get a Response from the cache for a request

Parameters

RequestInterface

$request

Returns

null|Response

Implements Guzzle\Plugin\Cache\CacheStorageInterface.

Definition at line 132 of file DefaultCacheStorage.php.

References Guzzle\Plugin\Cache\DefaultCacheStorage\cache(), and Guzzle\Plugin\Cache\DefaultCacheStorage\getCacheKey().

getBodyKey()

Guzzle\Plugin\Cache\DefaultCacheStorage::getBodyKey (   $url, EntityBodyInterface  $body  )

protected

Create a cache key for a response's body

Parameters

string	$url	URL of the entry
EntityBodyInterface	$body	Response body

Returns

string

Definition at line 213 of file DefaultCacheStorage.php.

References Guzzle\Http\EntityBodyInterface\getContentMd5().

Referenced by Guzzle\Plugin\Cache\DefaultCacheStorage\cache().

getCacheKey()

Guzzle\Plugin\Cache\DefaultCacheStorage::getCacheKey ( RequestInterface  $request )

protected

Hash a request URL into a string that returns cache metadata

Parameters

RequestInterface

$request

Returns

string

Definition at line 190 of file DefaultCacheStorage.php.

References Guzzle\Http\Message\RequestInterface\getMethod(), Guzzle\Http\Message\MessageInterface\getParams(), and Guzzle\Http\Message\RequestInterface\getUrl().

Referenced by Guzzle\Plugin\Cache\DefaultCacheStorage\cache(), Guzzle\Plugin\Cache\DefaultCacheStorage\delete(), and Guzzle\Plugin\Cache\DefaultCacheStorage\fetch().

purge()

Guzzle\Plugin\Cache\DefaultCacheStorage::purge

(

$url

)

Purge all cache entries for a given URL

Parameters

string

$url

Implements Guzzle\Plugin\Cache\CacheStorageInterface.

Definition at line 125 of file DefaultCacheStorage.php.

Field Documentation

$cache

CacheAdapterInterface Guzzle\Plugin\Cache\DefaultCacheStorage::$cache

protected

Cache used to store cache data

Definition at line 28 of file DefaultCacheStorage.php.

Referenced by Guzzle\Plugin\Cache\DefaultCacheStorage\__construct().

$defaultTtl

int Guzzle\Plugin\Cache\DefaultCacheStorage::$defaultTtl

protected

Default cache TTL

Definition at line 34 of file DefaultCacheStorage.php.

Referenced by Guzzle\Plugin\Cache\DefaultCacheStorage\__construct(), and Guzzle\Plugin\Cache\DefaultCacheStorage\cache().

$keyPrefix

string Guzzle\Plugin\Cache\DefaultCacheStorage::$keyPrefix

protected

Definition at line 22 of file DefaultCacheStorage.php.

Referenced by Guzzle\Plugin\Cache\DefaultCacheStorage\__construct().

---

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

• DefaultCacheStorage.php