Zend_Cache_Backend_BlackHole Class Reference

Public Member Functions
	load ($id, $doNotTestCacheValidity=false)
	Test if a cache is available for the given id and (if yes) return it (false else)
	test ($id)
	Test if a cache is available or not (for the given id)
	save ($data, $id, $tags=array(), $specificLifetime=false)
	Save some string datas into a cache record.
	remove ($id)
	Remove a cache record.
	clean ($mode=Zend_Cache::CLEANING_MODE_ALL, $tags=array())
	Clean some cache records.
	getIds ()
	Return an array of stored cache ids.
	getTags ()
	Return an array of stored tags.
	getIdsMatchingTags ($tags=array())
	Return an array of stored cache ids which match given tags.
	getIdsNotMatchingTags ($tags=array())
	Return an array of stored cache ids which don't match given tags.
	getIdsMatchingAnyTags ($tags=array())
	Return an array of stored cache ids which match any given tags.
	getFillingPercentage ()
	Return the filling percentage of the backend storage.
	getMetadatas ($id)
	Return an array of metadatas for the given cache id.
	touch ($id, $extraLifetime)
	Give (if possible) an extra lifetime to the given cache id.
	getCapabilities ()
	Return an associative array of capabilities (booleans) of the backend.
	___expire ($id)
	PUBLIC METHOD FOR UNIT TESTING ONLY !
Public Member Functions inherited from Zend_Cache_Backend
	__construct (array $options=array())
	Constructor.
	setDirectives ($directives)
	Set the frontend directives.
	setOption ($name, $value)
	Set an option.
	getOption ($name)
	Returns an option.
	getLifetime ($specificLifetime)
	Get the life time.
	isAutomaticCleaningAvailable ()
	Return true if the automatic cleaning is available for the backend.
	getTmpDir ()
	Determine system TMP directory and detect if we have read access.

Additional Inherited Members
Protected Member Functions inherited from Zend_Cache_Backend
	_isGoodTmpDir ($dir)
	Verify if the given temporary directory is readable and writable.
	_loggerSanity ()
	Make sure if we enable logging that the Zend_Log class is available.
	_log ($message, $priority=4)
	Log a message at the WARN (4) priority.
Protected Attributes inherited from Zend_Cache_Backend
	$_directives
	$_options = array()

Member Function Documentation

___expire

(

$id

)

PUBLIC METHOD FOR UNIT TESTING ONLY !

Force a cache record to expire

Parameters

string

$id

cache id

clean	(		$mode = Zend_Cache::CLEANING_MODE_ALL,
			$tags = array()
	)

Clean some cache records.

Available modes are : 'all' (default) => remove all cache entries ($tags is not used) 'old' => remove too old cache entries ($tags is not used) 'matchingTag' => remove cache entries matching all given tags ($tags can be an array of strings or a single string) 'notMatchingTag' => remove cache entries not matching one of the given tags ($tags can be an array of strings or a single string) 'matchingAnyTag' => remove cache entries matching any given tags ($tags can be an array of strings or a single string)

Parameters

string	$mode	clean mode
	tags	array $tags array of tags

Returns

boolean true if no problem

Implements Zend_Cache_Backend_Interface.

getCapabilities

(

)

Return an associative array of capabilities (booleans) of the backend.

The array must include these keys :

• automatic_cleaning (is automating cleaning necessary)
• tags (are tags supported)
• expired_read (is it possible to read expired cache records (for doNotTestCacheValidity option for example))
• priority does the backend deal with priority when saving
• infinite_lifetime (is infinite lifetime can work with this backend)
• get_list (is it possible to get the list of cache ids and the complete list of tags)

Returns

array associative of with capabilities

Implements Zend_Cache_Backend_ExtendedInterface.

getFillingPercentage

(

)

Return the filling percentage of the backend storage.

Returns

int integer between 0 and 100

Exceptions

Zend_Cache_Exception

Implements Zend_Cache_Backend_ExtendedInterface.

getIds

(

)

Return an array of stored cache ids.

Returns

array array of stored cache ids (string)

Implements Zend_Cache_Backend_ExtendedInterface.

getIdsMatchingAnyTags

(

$tags = array()

)

Return an array of stored cache ids which match any given tags.

In case of multiple tags, a logical AND is made between tags

Parameters

array

$tags

array of tags

Returns

array array of any matching cache ids (string)

Implements Zend_Cache_Backend_ExtendedInterface.

getIdsMatchingTags

(

$tags = array()

)

Return an array of stored cache ids which match given tags.

In case of multiple tags, a logical AND is made between tags

Parameters

array

$tags

array of tags

Returns

array array of matching cache ids (string)

Implements Zend_Cache_Backend_ExtendedInterface.

getIdsNotMatchingTags

(

$tags = array()

)

Return an array of stored cache ids which don't match given tags.

In case of multiple tags, a logical OR is made between tags

Parameters

array

$tags

array of tags

Returns

array array of not matching cache ids (string)

Implements Zend_Cache_Backend_ExtendedInterface.

getMetadatas

(

$id

)

Return an array of metadatas for the given cache id.

The array must include these keys :

• expire : the expire timestamp
• tags : a string array of tags
• mtime : timestamp of last modification time

Parameters

string

$id

cache id

Returns

array array of metadatas (false if the cache id is not found)

Implements Zend_Cache_Backend_ExtendedInterface.

getTags

(

)

Return an array of stored tags.

Returns

array array of stored tags (string)

Implements Zend_Cache_Backend_ExtendedInterface.

load	(		$id,
			$doNotTestCacheValidity = false
	)

Test if a cache is available for the given id and (if yes) return it (false else)

Parameters

string	$id	cache id
boolean	$doNotTestCacheValidity	if set to true, the cache validity won't be tested

Returns

string|false cached datas

Implements Zend_Cache_Backend_Interface.

remove

(

$id

)

Remove a cache record.

Parameters

string

$id

cache id

Returns

boolean true if no problem

Implements Zend_Cache_Backend_Interface.

save	(		$data,
			$id,
			$tags = array(),
			$specificLifetime = false
	)

Save some string datas into a cache record.

Note : $data is always "string" (serialization is done by the core not by the backend)

Parameters

string	$data	Datas to cache
string	$id	Cache id
array	$tags	Array of strings, the cache record will be tagged by each string entry
int	$specificLifetime	If != false, set a specific lifetime for this cache record (null => infinite lifetime)

Returns

boolean true if no problem

Implements Zend_Cache_Backend_Interface.

test

(

$id

)

Test if a cache is available or not (for the given id)

Parameters

string

$id

cache id

Returns

mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record

Implements Zend_Cache_Backend_Interface.

touch	(		$id,
			$extraLifetime
	)

Give (if possible) an extra lifetime to the given cache id.

Parameters

string	$id	cache id
int	$extraLifetime

Returns

boolean true if ok

Implements Zend_Cache_Backend_ExtendedInterface.