Cache/Frontend/Class.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Cache
subpackage: Zend_Cache_Frontend
version: $Id: Class.php 22654 2010-07-22 18:44:13Z mabe $
Classes: Zend_Cache_Frontend_Class

Description

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.

Zend_Cache_Frontend_Class
jump to top

Extends from: Zend_Cache_Core
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Cache
subpackage: Zend_Cache_Frontend
Properties: $_specificOptions; $_tags; $_specificLifetime; $_cachedEntity; $_cachedEntityLabel; $_priority
Methods: __construct; setSpecificLifetime; setPriority; setOption; setCachedEntity; setTagsArray; __call; _makeId; makeId

Description

Properties

$_cachedEntity
jump to class

mixed $_cachedEntity = 'null'

The cached object or the name of the cached abstract class

Details

$_cachedEntity: mixed
visibility: private
default: null
final: false
static: false

$_cachedEntityLabel
jump to class

string $_cachedEntityLabel = ''

The class name of the cached object or cached abstract class

Used to differentiate between different classes with the same method calls.

Details

$_cachedEntityLabel: string
visibility: private
default
final: false
static: false

$_priority
jump to class

int $_priority = '8'

Priority (used by some particular backends)

Details

$_priority: int
visibility: private
default: 8
final: false
static: false

$_specificLifetime
jump to class

int $_specificLifetime = 'false'

SpecificLifetime value

false => no specific life time

Details

$_specificLifetime: int
visibility: private
default: false
final: false
static: false

$_specificOptions
jump to class

array $_specificOptions = '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)

Details

$_specificOptions: array
available options
visibility: protected
default: array
final: false
static: false

$_tags
jump to class

array $_tags = 'array'

Tags array

Details

$_tags: array
visibility: private
default: array
final: false
static: false

Methods

__call
jump to class

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

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

Arguments

$name: string
Method name
$parameters: array
Method parameters

Output

mixed: Result

Details

visibility: public
final: false
static: false

__construct
jump to class

__construct(
          array $options
              =
              array
          )
        
        :
        void

Constructor

Arguments

$options: array
Associative array of options

Details

visibility: public
final: false
static: false
throws

_makeId
jump to class

_makeId(
           $name,  $args
          )
        
        :

ZF-9970

Arguments

$name
$args

Details

visibility: private
final: false
static: false
deprecated

makeId
jump to class

makeId(
          string $name, array $args
              =
              array
          )
        
        :
        string

Make a cache id from the method name and parameters

Arguments

$name: string
Method name
$args: array
Method parameters

Output

string: Cache id

Details

visibility: public
final: false
static: false

setCachedEntity
jump to class

setCachedEntity(
          mixed $cachedEntity
          )
        
        :

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

Arguments

$cachedEntity: mixed

Details

visibility: public
final: false
static: false

setOption
jump to class

setOption(
          string $name, mixed $value
          )
        
        :
        void

Public frontend to set an option

Just a wrapper to get a specific behaviour for cached_entity

Arguments

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

Details

visibility: public
final: false
static: false
throws

setPriority
jump to class

setPriority(
          int $priority
          )
        
        :

Set the priority (used by some particular backends)

Arguments

$priority: int
integer between 0 (very low priority) and 10 (maximum priority)

Details

visibility: public
final: false
static: false

setSpecificLifetime
jump to class

setSpecificLifetime(
          int $specificLifetime
              =
              false
          )
        
        :
        void

Set a specific life time

Arguments

$specificLifetime: int

Details

visibility: public
final: false
static: false

setTagsArray
jump to class

setTagsArray(
          array $tags
              =
              array
          )
        
        :
        void

Set the cache array

Arguments

$tags: array

Details

visibility: public
final: false
static: false

API Documentation

Cache/Frontend/Class.php

Description

Zend_Cache_Frontend_Classjump to top

Description

Properties

$_cachedEntityjump to class

Details

$_cachedEntityLabeljump to class

Details

$_priorityjump to class

Details

$_specificLifetimejump to class

Details

$_specificOptionsjump to class

Details

$_tagsjump to class

Details

Methods

__calljump to class

Arguments

Output

Details

__constructjump to class

Arguments

Details

_makeIdjump to class

Arguments

Details

makeIdjump to class

Arguments

Output

Details

setCachedEntityjump to class

Arguments

Details

setOptionjump to class

Arguments

Details

setPriorityjump to class

Arguments

Details

setSpecificLifetimejump to class

Arguments

Details

setTagsArrayjump to class

Arguments

Details

Zend_Cache_Frontend_Class
jump to top

$_cachedEntity
jump to class

$_cachedEntityLabel
jump to class

$_priority
jump to class

$_specificLifetime
jump to class

$_specificOptions
jump to class

$_tags
jump to class

__call
jump to class

__construct
jump to class

_makeId
jump to class

makeId
jump to class

setCachedEntity
jump to class

setOption
jump to class

setPriority
jump to class

setSpecificLifetime
jump to class

setTagsArray
jump to class