Zend_Cache_Backend_ExtendedInterface Interface Reference

Inheritance diagram for Zend_Cache_Backend_ExtendedInterface:

Public Member Functions
	getIds ()
	getTags ()
	getIdsMatchingTags ($tags=array())
	getIdsNotMatchingTags ($tags=array())
	getIdsMatchingAnyTags ($tags=array())
	getFillingPercentage ()
	getMetadatas ($id)
	touch ($id, $extraLifetime)
	getCapabilities ()
Public Member Functions inherited from Zend_Cache_Backend_Interface
	setDirectives ($directives)
	load ($id, $doNotTestCacheValidity=false)
	test ($id)
	save ($data, $id, $tags=array(), $specificLifetime=false)
	remove ($id)
	clean ($mode=Zend_Cache::CLEANING_MODE_ALL, $tags=array())

Detailed Description

Definition at line 34 of file ExtendedInterface.php.

Member Function Documentation

getCapabilities()

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

Implemented in Zend_Cache_Backend_Memcached, Zend_Cache_Backend_Libmemcached, Zend_Cache_Backend_File, Database, Zend_Cache_Backend_TwoLevels, Zend_Cache_Backend_Test, Zend_Cache_Backend_Apc, Zend_Cache_Backend_WinCache, Eaccelerator, AbstractDecorator, MongoDb, RemoteSynchronizedCache, and Zend_Cache_Backend_BlackHole.

getFillingPercentage()

getFillingPercentage

(

)

Return the filling percentage of the backend storage

Returns

int integer between 0 and 100

Implemented in Zend_Cache_Backend_TwoLevels, Database, Zend_Cache_Backend_File, Zend_Cache_Backend_Memcached, Zend_Cache_Backend_Libmemcached, Zend_Cache_Backend_Test, RemoteSynchronizedCache, AbstractDecorator, Zend_Cache_Backend_Apc, Zend_Cache_Backend_WinCache, MongoDb, Zend_Cache_Backend_BlackHole, and Eaccelerator.

getIds()

getIds

(

)

Return an array of stored cache ids

Returns

array array of stored cache ids (string)

Implemented in Zend_Cache_Backend_TwoLevels, Zend_Cache_Backend_File, Zend_Cache_Backend_Memcached, Database, Zend_Cache_Backend_Libmemcached, Zend_Cache_Backend_Test, Zend_Cache_Backend_Apc, Zend_Cache_Backend_WinCache, Eaccelerator, RemoteSynchronizedCache, AbstractDecorator, Zend_Cache_Backend_BlackHole, and MongoDb.

getIdsMatchingAnyTags()

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)

Implemented in Zend_Cache_Backend_TwoLevels, Database, Zend_Cache_Backend_File, Zend_Cache_Backend_Memcached, Zend_Cache_Backend_Libmemcached, Zend_Cache_Backend_Test, Zend_Cache_Backend_Apc, Zend_Cache_Backend_WinCache, Eaccelerator, RemoteSynchronizedCache, AbstractDecorator, Zend_Cache_Backend_BlackHole, and MongoDb.

getIdsMatchingTags()

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)

Implemented in Zend_Cache_Backend_TwoLevels, Zend_Cache_Backend_File, Zend_Cache_Backend_Memcached, Database, Zend_Cache_Backend_Libmemcached, Zend_Cache_Backend_Test, Zend_Cache_Backend_Apc, Zend_Cache_Backend_WinCache, RemoteSynchronizedCache, Eaccelerator, AbstractDecorator, Zend_Cache_Backend_BlackHole, and MongoDb.

getIdsNotMatchingTags()

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)

Implemented in Zend_Cache_Backend_TwoLevels, Database, Zend_Cache_Backend_File, Zend_Cache_Backend_Memcached, Zend_Cache_Backend_Libmemcached, Zend_Cache_Backend_Test, Zend_Cache_Backend_Apc, Zend_Cache_Backend_WinCache, Eaccelerator, RemoteSynchronizedCache, AbstractDecorator, Zend_Cache_Backend_BlackHole, and MongoDb.

getMetadatas()

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)

Implemented in Zend_Cache_Backend_Memcached, Zend_Cache_Backend_TwoLevels, Zend_Cache_Backend_Libmemcached, Database, Zend_Cache_Backend_File, Zend_Cache_Backend_Test, Zend_Cache_Backend_Apc, Zend_Cache_Backend_WinCache, Eaccelerator, AbstractDecorator, RemoteSynchronizedCache, MongoDb, and Zend_Cache_Backend_BlackHole.

getTags()

getTags

(

)

Return an array of stored tags

Returns

array array of stored tags (string)

Implemented in Zend_Cache_Backend_TwoLevels, Zend_Cache_Backend_File, Zend_Cache_Backend_Memcached, Database, Zend_Cache_Backend_Libmemcached, Zend_Cache_Backend_Test, Zend_Cache_Backend_Apc, Zend_Cache_Backend_WinCache, RemoteSynchronizedCache, Eaccelerator, AbstractDecorator, Zend_Cache_Backend_BlackHole, and MongoDb.

touch()

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

Implemented in Zend_Cache_Backend_Memcached, Zend_Cache_Backend_Libmemcached, Zend_Cache_Backend_TwoLevels, Database, Zend_Cache_Backend_File, Zend_Cache_Backend_Test, Zend_Cache_Backend_Apc, Zend_Cache_Backend_WinCache, Eaccelerator, AbstractDecorator, RemoteSynchronizedCache, MongoDb, and Zend_Cache_Backend_BlackHole.

---

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

• vendor/magento/zendframework1/library/Zend/Cache/Backend/ExtendedInterface.php