Zend_Cache_Backend_ZendPlatform Class Reference

Public Member Functions
	__construct (array $options=array())
	Constructor Validate that the Zend Platform is loaded and licensed.
	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.
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.
Public Member Functions inherited from Zend_Cache_Backend_Interface
	setDirectives ($directives)
	Set the frontend directives.

Public Attributes
const	TAGS_PREFIX = "internal_ZPtag:"
	internal ZP prefix

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

Constructor & Destructor Documentation

__construct

(

array

$options = array()

)

Constructor Validate that the Zend Platform is loaded and licensed.

Parameters

array

$options

Associative array of options

Exceptions

Zend_Cache_Exception

Returns

void

Member Function Documentation

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

Clean some cache records.

Available modes are : Zend_Cache::CLEANING_MODE_ALL (default) => remove all cache entries ($tags is not used) Zend_Cache::CLEANING_MODE_OLD => remove too old cache entries ($tags is not used) This mode is not supported in this backend Zend_Cache::CLEANING_MODE_MATCHING_TAG => remove cache entries matching all given tags ($tags can be an array of strings or a single string) Zend_Cache::CLEANING_MODE_NOT_MATCHING_TAG => unsupported Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG => remove cache entries matching any given tags ($tags can be an array of strings or a single string)

Parameters

string	$mode	Clean mode
array	$tags	Array of tags

Exceptions

Zend_Cache_Exception

Returns

boolean True if no problem

Implements Zend_Cache_Backend_Interface.

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 Cached data (or false)

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	Data 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 false (a cache is not available) or "last modified" timestamp (int) of the available cache record

Implements Zend_Cache_Backend_Interface.

Member Data Documentation

const TAGS_PREFIX = "internal_ZPtag:"

internal ZP prefix