Docs For Class Zend_Cache

Description

copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: New BSD License

Direct descendents

Class	Description
Zend_Cache_Backend_TwoLevels
Zend_Cache_Backend_ZendServer
Zend_Cache_Backend_Test
Zend_Cache_Backend_Xcache
Zend_Cache_Backend_Apc
Zend_Cache_Backend_Memcached
Zend_Cache_Backend_File
Zend_Cache_Backend_ZendPlatform	Impementation of Zend Cache Backend using the Zend Platform (Output Content Caching)
Zend_Cache_Backend_BlackHole
Zend_Cache_Backend_Sqlite
Zend_Cache_Backend_Static

Variable Summary

array $_directives

array $_options

Method Summary

void __construct ([ $options = array()])

int getLifetime (int $specificLifetime)

string getTmpDir ()

boolean isAutomaticCleaningAvailable ()

void setDirectives (array $directives)

void setOption (string $name, mixed $value)

boolean _isGoodTmpDir ($dir $dir)

void _log (string $message, [ $priority = 4])

void _loggerSanity ()

Variables

array $_directives = array(
'lifetime' => 3600,
'logging' => false,
'logger' => null
) (line 44)

Frontend or Core directives

=====> (int) lifetime :

Cache lifetime (in seconds)
If null, the cache is valid forever

=====> (int) logging :

if set to true, a logging is activated throw Zend_Log

var: directives
access: protected

Redefined in descendants as:

Zend_Cache_Backend_Test::$_directives : Frontend or Core directives

array $_options = array() (line 55)

Available options

var: available options
access: protected

Redefined in descendants as:

Zend_Cache_Backend_TwoLevels::$_options : Available options
Zend_Cache_Backend_ZendServer::$_options : Available options
Zend_Cache_Backend_Test::$_options : Available options
Zend_Cache_Backend_Xcache::$_options : Available options
Zend_Cache_Backend_Memcached::$_options : Available options
Zend_Cache_Backend_File::$_options : Available options
Zend_Cache_Backend_Sqlite::$_options : Available options
Zend_Cache_Backend_Static::$_options : Static backend options

Methods

Constructor __construct (line 64)

Constructor

throws: Zend_Cache_Exception
access: public

void __construct ([ $options = array()])

array $options: Associative array of options

Redefined in descendants as:

Zend_Cache_Backend_TwoLevels::__construct() : Constructor
Zend_Cache_Backend_ZendServer_ShMem::__construct() : Constructor
Zend_Cache_Backend_ZendServer_Disk::__construct() : Constructor
Zend_Cache_Backend_Test::__construct() : Constructor
Zend_Cache_Backend_Xcache::__construct() : Constructor
Zend_Cache_Backend_Apc::__construct() : Constructor
Zend_Cache_Backend_Memcached::__construct() : Constructor
Zend_Cache_Backend_File::__construct() : Constructor
Zend_Cache_Backend_ZendPlatform::__construct() : Constructor Validate that the Zend Platform is loaded and licensed
Zend_Cache_Backend_Sqlite::__construct() : Constructor

getLifetime (line 123)

Get the life time

if $specificLifetime is not false, the given specific life time is used else, the global lifetime is used

return: Cache life time
access: public

int getLifetime (int $specificLifetime)

int $specificLifetime

getTmpDir (line 152)

Determine system TMP directory and detect if we have read access

inspired from Zend_File_Transfer_Adapter_Abstract

throws: Zend_Cache_Exception if unable to determine directory
access: public

string getTmpDir ()

isAutomaticCleaningAvailable (line 139)

Return true if the automatic cleaning is available for the backend

DEPRECATED : use getCapabilities() instead

deprecated:
access: public

boolean isAutomaticCleaningAvailable ()

Redefined in descendants as:

Zend_Cache_Backend_Test::isAutomaticCleaningAvailable() : Return true if the automatic cleaning is available for the backend
Zend_Cache_Backend_Xcache::isAutomaticCleaningAvailable() : Return true if the automatic cleaning is available for the backend
Zend_Cache_Backend_Apc::isAutomaticCleaningAvailable() : Return true if the automatic cleaning is available for the backend
Zend_Cache_Backend_Memcached::isAutomaticCleaningAvailable() : Return true if the automatic cleaning is available for the backend

setDirectives (line 78)

Set the frontend directives

throws: Zend_Cache_Exception
access: public

void setDirectives (array $directives)

array $directives: Assoc of directives

Redefined in descendants as:

Zend_Cache_Backend_Test::setDirectives() : Set the frontend directives
Zend_Cache_Backend_Memcached::setDirectives() : Set the frontend directives

setOption (line 103)

Set an option

throws: Zend_Cache_Exception
access: public

void setOption (string $name, mixed $value)

string $name
mixed $value

Redefined in descendants as:

Zend_Cache_Backend_Static::setOption() : Interceptor child method to handle the case where an Inner Cache object is being set since it's not supported by the standard backend interface

_isGoodTmpDir (line 206)

Verify if the given temporary directory is readable and writable

return: true if the directory is ok
access: protected

boolean _isGoodTmpDir ($dir $dir)

$dir $dir: temporary directory

_log (line 251)

Log a message at the WARN (4) priority.

throws: Zend_Cache_Exception
access: protected

void _log (string $message, [ $priority = 4])

string $message
$priority

_loggerSanity (line 224)

Make sure if we enable logging that the Zend_Log class is available.

Create a default log object if none is set.

throws: Zend_Cache_Exception
access: protected

void _loggerSanity ()

Zend_Cache_Backend