Class Zend_Cache_Frontend_Class

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

Located in /Cache/Frontend/Class.php (line 34)

Zend_Cache_Core
   |
   --Zend_Cache_Frontend_Class
Variable Summary
Method Summary
 void __construct ([ $options = array()])
 void setCachedEntity (mixed $cachedEntity)
 void setOption (string $name, mixed $value)
 void setPriority (int $priority)
 void setSpecificLifetime ([int $specificLifetime = false])
 void setTagsArray ([array $tags = array()])
 mixed __call (string $name, array $parameters)
Variables
array $_specificOptions = array(
'cached_entity' => null,
'cache_by_default' => true,
'cached_methods' => array(),'non_cached_methods'=>array())
(line 54)

Available options

====> (mixed) cached_entity :

  • if set to a class name, we will cache an abstract class and will use only static calls
  • if set to an object, we will cache this object methods
====> (boolean) cache_by_default :
  • if true, method calls will be cached by default
====> (array) cached_methods :
  • an array of method names which will be cached (even if cache_by_default = false)
====> (array) non_cached_methods :
  • an array of method names which won't be cached (even if cache_by_default = true)

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

Constructor

  • throws: Zend_Cache_Exception
  • access: public
void __construct ([ $options = array()])
  • array $options: Associative array of options

Redefinition of:
Zend_Cache_Core::__construct()
Constructor
setCachedEntity (line 167)

Specific method to set the cachedEntity

if set to a class name, we will cache an abstract class and will use only static calls if set to an object, we will cache this object methods

  • access: public
void setCachedEntity (mixed $cachedEntity)
  • mixed $cachedEntity
setOption (line 150)

Public frontend to set an option

Just a wrapper to get a specific behaviour for cached_entity

  • 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
setPriority (line 135)

Set the priority (used by some particular backends)

  • access: public
void setPriority (int $priority)
  • int $priority: integer between 0 (very low priority) and 10 (maximum priority)
setSpecificLifetime (line 125)

Set a specific life time

  • access: public
void setSpecificLifetime ([int $specificLifetime = false])
  • int $specificLifetime
setTagsArray (line 188)

Set the cache array

  • access: public
void setTagsArray ([array $tags = array()])
  • array $tags
__call (line 200)

Main method : call the specified method or get the result from cache

  • return: Result
  • access: public
mixed __call (string $name, array $parameters)
  • string $name: Method name
  • array $parameters: Method parameters

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:14:39 -0500 by phpDocumentor 1.4.3