Docs For Class Zend_Cache_Frontend

Description

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

Located in /Cache/Frontend/File.php (line 36)

Zend_Cache_Core
   |
   --Zend_Cache_Frontend_File

Class Constant Summary

MODE_AND = 'AND'

MODE_OR = 'OR'

Variable Summary

array $_specificOptions

Method Summary

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

mixed|false load (string $id, [boolean $doNotTestCacheValidity = false], [boolean $doNotUnserialize = false])

void setMasterFile (string $masterFile)

void setMasterFiles ( $masterFiles, string $masterFile)

void setOption (string $name, mixed $value)

int|false test (string $id)

Variables

array $_specificOptions = array(
'master_file' => null,
'master_files' => null,
'master_files_mode' => 'OR',
'ignore_missing_master_files' => false
) (line 66)

Available options

====> (string) master_file :

a complete path of the master file
deprecated (see master_files)

====> (array) master_files :

an array of complete path of master files
this option has to be set !

====> (string) master_files_mode :

Zend_Cache_Frontend_File::MODE_AND or Zend_Cache_Frontend_File::MODE_OR
if MODE_AND, then all master files have to be touched to get a cache invalidation
if MODE_OR (default), then a single touched master file is enough to get a cache invalidation

====> (boolean) ignore_missing_master_files

if set to true, missing master files are ignored silently
if set to false (default), an exception is thrown if there is a missing master file

var: available options
access: protected

Redefinition of:

Zend_Cache_Core::$_specificOptions: Not used for the core, just a sort a hint to get a common setOption() method (for the core and for frontends)

Inherited Variables

Inherited from Zend_Cache_Core

Zend_Cache_Core::$_backend
Zend_Cache_Core::$_backendCapabilities
Zend_Cache_Core::$_directivesList
Zend_Cache_Core::$_extendedBackend
Zend_Cache_Core::$_options

Methods

Constructor __construct (line 89)

Constructor

throws: Zend_Cache_Exception
access: public

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

array $options: Associative array of options

Redefinition of:

Zend_Cache_Core::__construct(): Constructor

load (line 162)

Test if a cache is available for the given id and (if yes) return it (false else)

return: Cached datas
access: public

mixed|false load (string $id, [boolean $doNotTestCacheValidity = false], [boolean $doNotUnserialize = false])

string $id: Cache id
boolean $doNotTestCacheValidity: If set to true, the cache validity won't be tested
boolean $doNotUnserialize: Do not serialize (even if automatic_serialization is true) => for internal use

Redefinition of:

Zend_Cache_Core::load(): Test if a cache is available for the given id and (if yes) return it (false else)

setMasterFile (line 128)

Change the master_file option

To keep the compatibility

deprecated:
access: public

void setMasterFile (string $masterFile)

string $masterFile: the complete path and name of the master file

setMasterFiles (line 104)

Change the master_file option

access: public

void setMasterFiles ( $masterFiles, string $masterFile)

string $masterFile: the complete path and name of the master file
$masterFiles

setOption (line 143)

Public frontend to set an option

Just a wrapper to get a specific behaviour for master_file

throws: Zend_Cache_Exception
access: public

void setOption (string $name, mixed $value)

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

Redefinition of:

Zend_Cache_Core::setOption(): Public frontend to set an option

test (line 179)

Test if a cache is available for the given id

return: Last modified time of cache entry if it is available, false otherwise
access: public

int|false test (string $id)

string $id: Cache id

Redefinition of:

Zend_Cache_Core::test(): Test if a cache is available for the given id

Inherited Methods

Inherited From Zend_Cache_Core

Zend_Cache_Core::__construct()
Zend_Cache_Core::clean()
Zend_Cache_Core::getBackend()
Zend_Cache_Core::getFillingPercentage()
Zend_Cache_Core::getIds()
Zend_Cache_Core::getIdsMatchingAnyTags()
Zend_Cache_Core::getIdsMatchingTags()
Zend_Cache_Core::getIdsNotMatchingTags()
Zend_Cache_Core::getMetadatas()
Zend_Cache_Core::getOption()
Zend_Cache_Core::getTags()
Zend_Cache_Core::load()
Zend_Cache_Core::remove()
Zend_Cache_Core::save()
Zend_Cache_Core::setBackend()
Zend_Cache_Core::setConfig()
Zend_Cache_Core::setLifetime()
Zend_Cache_Core::setOption()
Zend_Cache_Core::test()
Zend_Cache_Core::touch()
Zend_Cache_Core::_id()
Zend_Cache_Core::_log()
Zend_Cache_Core::_loggerSanity()
Zend_Cache_Core::_validateIdOrTag()
Zend_Cache_Core::_validateTagsArray()

Class Constants

MODE_AND = 'AND' (line 42)

Consts for master_files_mode

MODE_OR = 'OR' (line 43)

Inherited Constants

Inherited from Zend_Cache_Core

Zend_Cache_Core::BACKEND_NOT_IMPLEMENTS_EXTENDED_IF
Zend_Cache_Core::BACKEND_NOT_SUPPORTS_TAG