Zend_Cache_Frontend_Output Class Reference

Public Member Functions
	__construct (array $options=array())
	Constructor.
	start ($id, $doNotTestCacheValidity=false, $echoData=true)
	Start the cache.
	end ($tags=array(), $specificLifetime=false, $forcedDatas=null, $echoData=true, $priority=8)
	Stop the cache.
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.

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...)
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()
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

Returns

void

Member Function Documentation

end	(		$tags = array(),
			$specificLifetime = false,
			$forcedDatas = null,
			$echoData = true,
			$priority = 8
	)

Stop the cache.

Parameters

array	$tags	Tags array
int	$specificLifetime	If != false, set a specific lifetime for this cache record (null => infinite lifetime)
string	$forcedDatas	If not null, force written datas with this
boolean	$echoData	If set to true, datas are sent to the browser
int	$priority	integer between 0 (very low priority) and 10 (maximum priority) used by some particular backends

Returns

void

start	(		$id,
			$doNotTestCacheValidity = false,
			$echoData = true
	)

Start the cache.

Parameters

string	$id	Cache id
boolean	$doNotTestCacheValidity	If set to true, the cache validity won't be tested
boolean	$echoData	If set to true, datas are sent to the browser if the cache is hit (simply returned else)

Returns

mixed True if the cache is hit (false else) with $echoData=true (default) ; string else (datas)