Class Zend_Cache_Frontend_File

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

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

Zend_Cache_Core
   |
   --Zend_Cache_Frontend_File
Variable Summary
Method Summary
 void __construct ([ $options = array()])
 mixed|false load (string $id, [boolean $doNotTestCacheValidity = false], [boolean $doNotUnserialize = false])
 void setMasterFile (string $masterFile)
 void setOption (string $name, mixed $value)
 boolean test (string $id)
Variables
array $_specificOptions = array(
'master_file' => ''
)
(line 46)

Available options

====> (string) master_file :

  • the complete path and name of the master file
  • this option has to be set !

  • 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 64)

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

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

Change the master_file option

  • access: public
void setMasterFile (string $masterFile)
  • string $masterFile: the complete path and name of the master file
setOption (line 99)

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

Test if a cache is available for the given id

  • return: True is a cache is available, false else
  • access: public
boolean 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::getIdsMatchingTags()
 Zend_Cache_Core::getIdsNotMatchingTags()
 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::setLifetime()
 Zend_Cache_Core::setOption()
 Zend_Cache_Core::test()
 Zend_Cache_Core::touch()
 Zend_Cache_Core::_log()
 Zend_Cache_Core::_loggerSanity()

Documentation generated on Fri, 08 Jan 2010 17:20:02 -0500 by phpDocumentor 1.4.3