Cache/Frontend/Class.php
Show:
inherited
inherited
Classes
Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled
with this package in the file LICENSE.txt.
It is also available through the world-wide-web at this URL:
http://framework.zend.com/license/new-bsd
If you did not receive a copy of the license and are unable to
obtain it through the world-wide-web, please send an email
to license@zend.com so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Cache
- Subpackage
- Zend_Cache_Frontend
- Version
- $Id$
\Zend_Cache_Frontend_Class
Package: Zend_Cache\Zend_Cache_Frontend
Throws
- Parent(s)
- \Zend_Cache_Core
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
mixed $_cachedEntity = nullThe cached object or the name of the cached abstract class
Default value
nullDetails- Type
- mixed
string $_cachedEntityLabel = ''The class name of the cached object or cached abstract class
Used to differentiate between different classes with the same method calls.
Default value''Details- Type
- string
int $_priority = 8Priority (used by some particular backends)
Default value
8Details- Type
- int
bool|int $_specificLifetime = falseSpecificLifetime value
false => no specific life time
Default valuefalseDetails- Type
- bool | int
array $_specificOptions = array('cached_entity' => null, 'cache_by_default' => true, 'cached_methods' => array(), 'non_cached_methods' => array())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)
Default valuearray('cached_entity' => null, 'cache_by_default' => true, 'cached_methods' => array(), 'non_cached_methods' => array())Details- Type
- array
array $_tags = array()Tags array
Default value
array()Details- Type
- array
Methods
__call(string $name, array $parameters) : mixedMain method : call the specified method or get the result from cache
Parameters
Returns
Throws
| Name | Type | Description |
|---|---|---|
| $name | string | Method name |
| $parameters | array | Method parameters |
| Type | Description |
|---|---|
| mixed | Result |
| Exception | Description |
|---|---|
| \Exception |
__construct(array $options = array()) : voidConstructor
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $options | array | Associative array of options |
| Exception | Description |
|---|---|
| \Zend_Cache_Exception |
_makeId( $name, $args) : voidZF-9970
Parameters
Details
| Name | Type | Description |
|---|---|---|
| $name | ||
| $args |
- Deprecated
makeId(string $name, array $args = array()) : stringMake a cache id from the method name and parameters
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $name | string | Method name |
| $args | array | Method parameters |
| Type | Description |
|---|---|
| string | Cache id |
setCachedEntity(mixed $cachedEntity) : voidSpecific 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
Parameters| Name | Type | Description |
|---|---|---|
| $cachedEntity | mixed |
setOption(string $name, mixed $value) : voidPublic frontend to set an option
Just a wrapper to get a specific behaviour for cached_entity
Parameters| Name | Type | Description |
|---|---|---|
| $name | string | Name of the option |
| $value | mixed | Value of the option |
| Exception | Description |
|---|---|
| \Zend_Cache_Exception |
setPriority(int $priority) : voidSet the priority (used by some particular backends)
Parameters
| Name | Type | Description |
|---|---|---|
| $priority | int | integer between 0 (very low priority) and 10 (maximum priority) |
setSpecificLifetime(bool | int $specificLifetime = false) : voidSet a specific life time
Parameters
| Name | Type | Description |
|---|---|---|
| $specificLifetime | bool | int |
setTagsArray(array $tags = array()) : voidSet the cache array
Parameters
| Name | Type | Description |
|---|---|---|
| $tags | array |