Zend_Cache_Frontend_Class Class Reference

Public Member Functions
	__construct (array $options=array())
	Constructor.
	setSpecificLifetime ($specificLifetime=false)
	Set a specific life time.
	setPriority ($priority)
	Set the priority (used by some particular backends)
	setOption ($name, $value)
	Public frontend to set an option.
	setCachedEntity ($cachedEntity)
	Specific method to set the cachedEntity.
	setTagsArray ($tags=array())
	Set the cache array.
	__call ($name, $parameters)
	Main method : call the specified method or get the result from cache.
	makeId ($name, array $args=array())
	Make a cache id from the method name and parameters.
Public Member Functions inherited from Zend_Cache_Core
	__construct ($options=array())
	Constructor.
	setConfig (Zend_Config $config)
	Set options using an instance of type Zend_Config.
	setBackend (Zend_Cache_Backend $backendObject)
	Set the backend.
	getBackend ()
	Returns the backend.
	setOption ($name, $value)
	Public frontend to set an option.
	getOption ($name)
	Public frontend to get an option value.
	setLifetime ($newLifetime)
	Force a new lifetime.
	load ($id, $doNotTestCacheValidity=false, $doNotUnserialize=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 for the given id.
	save ($data, $id=null, $tags=array(), $specificLifetime=false, $priority=8)
	Save some data in a cache.
	remove ($id)
	Remove a cache.
	clean ($mode= 'all', $tags=array())
	Clean cache entries.
	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.
	getIds ()
	Return an array of stored cache ids.
	getTags ()
	Return an array of stored 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.

Protected Attributes
	$_specificOptions
	$_tags = array()
	$_specificLifetime = false
	$_cachedEntity = null
	$_cachedEntityLabel = ''
	$_priority = 8
Protected Attributes inherited from Zend_Cache_Core
	$_backend = null
	Backend Object.
	$_options
	$_specificOptions = array()
	Not used for the core, just a sort a hint to get a common setOption() method (for the core and for frontends)
	$_extendedBackend = false
	True if the backend implements Zend_Cache_Backend_ExtendedInterface.
	$_backendCapabilities = array()

Additional Inherited Members
Public Attributes inherited from Zend_Cache_Core
const	BACKEND_NOT_SUPPORTS_TAG = 'tags are not supported by the current backend'
	Messages.
const	BACKEND_NOT_IMPLEMENTS_EXTENDED_IF = 'Current backend doesn\'t implement the Zend_Cache_Backend_ExtendedInterface, so this method is not available'
Protected Member Functions inherited from Zend_Cache_Core
	_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.
	_id ($id)
	Make and return a cache id.
Static Protected Member Functions inherited from Zend_Cache_Core
static	_validateIdOrTag ($string)
	Validate a cache id or a tag (security, reliable filenames, reserved prefixes...)
static	_validateTagsArray ($tags)
	Validate a tags array (security, reliable filenames, reserved prefixes...)
Static Protected Attributes inherited from Zend_Cache_Core
static	$_directivesList = array('lifetime', 'logging', 'logger')
	Array of options which have to be transfered to backend.

Constructor & Destructor Documentation

__construct

(

array

$options = array()

)

Constructor.

Parameters

array

$options

Associative array of options

Exceptions

Zend_Cache_Exception

Member Function Documentation

__call	(		$name,
			$parameters
	)

Main method : call the specified method or get the result from cache.

Parameters

string	$name	Method name
array	$parameters	Method parameters

Returns

mixed Result

Exceptions

Exception

makeId	(		$name,
		array	$args = array()
	)

Make a cache id from the method name and parameters.

Parameters

string	$name	Method name
array	$args	Method parameters

Returns

string Cache id

setCachedEntity

(

$cachedEntity

)

Specific method to set the cachedEntity.

if set to a class name, we will cache an abstract class and will use only static calls if set to an object, we will cache this object methods

Parameters

mixed

$cachedEntity

setOption	(		$name,
			$value
	)

Public frontend to set an option.

Just a wrapper to get a specific behaviour for cached_entity

Parameters

string	$name	Name of the option
mixed	$value	Value of the option

Exceptions

Zend_Cache_Exception

Returns

void

setPriority

(

$priority

)

Set the priority (used by some particular backends)

Parameters

int

$priority

integer between 0 (very low priority) and 10 (maximum priority)

setSpecificLifetime

(

$specificLifetime = false

)

Set a specific life time.

Parameters

bool | int

$specificLifetime

Returns

void

setTagsArray

(

$tags = array()

)

Set the cache array.

Parameters

array

$tags

Returns

void

Member Data Documentation

$_cachedEntity = null

protected

$_cachedEntityLabel = ''

protected

$_priority = 8

protected

$_specificLifetime = false

protected

$_specificOptions

protected

Initial value:

= array(
        'cached_entity'      => null,
        'cache_by_default'   => true,
        'cached_methods'     => array(),
        'non_cached_methods' => array()
    )

$_tags = array()

protected