API Documentation

Zend/Cache/Frontend/Class.php

Show: inherited
Table of Contents

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Cache  
Subpackage
Zend_Cache_Frontend  
Version
$Id: Class.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Cache_Frontend_Class

Package: Zend\Cache\Zend\Cache\Frontend

Parent(s)
\Zend_Cache_Core
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprivatemixed  $_cachedEntity= 'null'

The cached object or the name of the cached abstract class

Default valuenullDetails
Type
mixed
Propertyprivatestring  $_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
Propertyprivateint  $_priority= '8'

Priority (used by some particular backends)

Default value8Details
Type
int
Propertyprivateint  $_specificLifetime= 'false'

SpecificLifetime value

false => no specific life time

Default valuefalseDetails
Type
int
Propertyprotectedarray  $_specificOptions= 'array( 'cached_entity' => null'

Available options

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' => nullDetails
Type
array
Propertyprivatearray  $_tags= 'array()'

Tags array

Default valuearray()Details
Type
array

Methods

methodpublic__call( string $name, array $parameters ) : mixed

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

Parameters
Name Type Description
$name string

Method name

$parameters array

Method parameters

Returns
Type Description
mixed Result
methodpublic__construct( array $options = array() ) : void

Constructor

Parameters
Name Type Description
$options array

Associative array of options

Throws
Exception Description
\Zend_Cache_Exception
methodprivate_makeId(  $name,  $args ) : void

ZF-9970

Parameters
Name Type Description
$name
$args
Details
Deprecated
 
methodpublicmakeId( string $name, array $args = array() ) : string

Make a cache id from the method name and parameters

Parameters
Name Type Description
$name string

Method name

$args array

Method parameters

Returns
Type Description
string Cache id
methodpublicsetCachedEntity( mixed $cachedEntity ) : void

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

Parameters
Name Type Description
$cachedEntity mixed
methodpublicsetOption( string $name, mixed $value ) : void

Public 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

Throws
Exception Description
\Zend_Cache_Exception
methodpublicsetPriority( int $priority ) : void

Set the priority (used by some particular backends)

Parameters
Name Type Description
$priority int

integer between 0 (very low priority) and 10 (maximum priority)

methodpublicsetSpecificLifetime( int $specificLifetime = false ) : void

Set a specific life time

Parameters
Name Type Description
$specificLifetime int
methodpublicsetTagsArray( array $tags = array() ) : void

Set the cache array

Parameters
Name Type Description
$tags array
Documentation was generated by DocBlox 0.15.1.