Cache/Manager.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
version: $Id$
Classes: Zend_Cache_Manager

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_Manager
jump to top

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
Constants: PAGECACHE; PAGETAGCACHE
Properties: $_caches; $_optionTemplates
Methods: setCache; hasCache; getCache; getCaches; setCacheTemplate; hasCacheTemplate; getCacheTemplate; setTemplateOptions; _mergeOptions

Description

Constants

PAGECACHE
jump to class

 PAGECACHE = 'page'

Constant holding reserved name for default Page Cache

Details

value: page

PAGETAGCACHE
jump to class

 PAGETAGCACHE = 'pagetag'

Constant holding reserved name for default Page Tag Cache

Details

value: pagetag

Properties

$_caches
jump to class

array $_caches = 'array'

Array of caches stored by the Cache Manager instance

Details

$_caches: array
visibility: protected
default: array
final: false
static: false

$_optionTemplates
jump to class

array $_optionTemplates = 'array'

Array of ready made configuration templates for lazy loading caches.

Details

$_optionTemplates: array
visibility: protected
default: array
final: false
static: false

Methods

_mergeOptions
jump to class

_mergeOptions(
          array $current, array $options
          )
        
        :
        array

Simple method to merge two configuration arrays

Arguments

$current: array
$options: array

Output

array

Details

visibility: protected
final: false
static: false

getCache
jump to class

getCache(
          string $name
          )
        
        :
        Zend_Cache_Core

Fetch the named cache object, or instantiate and return a cache object using a named configuration template

Arguments

$name: string

Output

Zend_Cache_Core

Details

visibility: public
final: false
static: false

getCacheTemplate
jump to class

getCacheTemplate(
          string $name
          )
        
        :
        array

Get the named configuration template

Arguments

$name: string

Output

array

Details

visibility: public
final: false
static: false

getCaches
jump to class

getCaches(
          
          )
        
        :
        array

Fetch all available caches

Output

array: An array of all available caches with it's names as key

Details

visibility: public
final: false
static: false

hasCache
jump to class

hasCache(
          string $name
          )
        
        :
        bool

Check if the Cache Manager contains the named cache object, or a named configuration template to lazy load the cache object

Arguments

$name: string

Output

bool

Details

visibility: public
final: false
static: false

hasCacheTemplate
jump to class

hasCacheTemplate(
          string $name
          )
        
        :
        bool

Check if the named configuration template

Arguments

$name: string

Output

bool

Details

visibility: public
final: false
static: false

setCache
jump to class

setCache(
          string $name, Zend_Cache_Core $cache
          )
        
        :
        Zend_Cache_Manager

Set a new cache for the Cache Manager to contain

Arguments

$name: string
$cache: Zend_Cache_Core

Output

Zend_Cache_Manager

Details

visibility: public
final: false
static: false

setCacheTemplate
jump to class

setCacheTemplate(
          string $name, array $options
          )
        
        :
        Zend_Cache_Manager

Set a named configuration template from which a cache object can later be lazy loaded

Arguments

$name: string
$options: array

Output

Zend_Cache_Manager

Details

visibility: public
final: false
static: false

setTemplateOptions
jump to class

setTemplateOptions(
          string $name, array $options
          )
        
        :
        Zend_Cache_Manager

Pass an array containing changes to be applied to a named configuration template

Arguments

$name: string
$options: array

Output

Zend_Cache_Manager

Details

visibility: public
final: false
static: false
throws: for invalid options format or if option templates do not have $name

API Documentation

Cache/Manager.php

Description

Zend_Cache_Managerjump to top

Description

Constants

PAGECACHEjump to class

Details

PAGETAGCACHEjump to class

Details

Properties

$_cachesjump to class

Details

$_optionTemplatesjump to class

Details

Methods

_mergeOptionsjump to class

Arguments

Output

Details

getCachejump to class

Arguments

Output

Details

getCacheTemplatejump to class

Arguments

Output

Details

getCachesjump to class

Output

Details

hasCachejump to class

Arguments

Output

Details

hasCacheTemplatejump to class

Arguments

Output

Details

setCachejump to class

Arguments

Output

Details

setCacheTemplatejump to class

Arguments

Output

Details

setTemplateOptionsjump to class

Arguments

Output

Details

Zend_Cache_Manager
jump to top

PAGECACHE
jump to class

PAGETAGCACHE
jump to class

$_caches
jump to class

$_optionTemplates
jump to class

_mergeOptions
jump to class

getCache
jump to class

getCacheTemplate
jump to class

getCaches
jump to class

hasCache
jump to class

hasCacheTemplate
jump to class

setCache
jump to class

setCacheTemplate
jump to class

setTemplateOptions
jump to class