category Zend
package Zend_Cache
copyright Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com)
license New BSD License

 Methods

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

getCache(string $name) : \Zend_Cache_Core

Parameters

$name

string

Returns

\Zend_Cache_Core

Get the named configuration template

getCacheTemplate(string $name) : array

Parameters

$name

string

Returns

array

Fetch all available caches

getCaches() : array

Returns

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

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

hasCache(string $name) : boolean

Parameters

$name

string

Returns

boolean

Check if the named configuration template

hasCacheTemplate(string $name) : boolean

Parameters

$name

string

Returns

boolean

Set a new cache for the Cache Manager to contain

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

Parameters

$name

string

$cache

\Zend_Cache_Core

Returns

\Zend_Cache_Manager

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

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

Parameters

$name

string

$options

array

Exceptions

\Zend_Cache_Exception

Returns

\Zend_Cache_Manager

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

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

Parameters

$name

string

$options

array

Exceptions

\Zend_Cache_Exception for invalid options format or if option templates do not have $name

Returns

\Zend_Cache_Manager

Simple method to merge two configuration arrays

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

Parameters

$current

array

$options

array

Returns

array

 Properties

 

Array of caches stored by the Cache Manager instance

$_caches : array

Default

array()
 

Array of ready made configuration templates for lazy loading caches.

$_optionTemplates : array

Default

array('default' => array('frontend' => array('name' => 'Core', 'options' => array('automatic_serialization' => true)), 'backend' => array('name' => 'File', 'options' => array())), 'page' => array('frontend' => array('name' => 'Capture', 'options' => array('ignore_user_abort' => true)), 'backend' => array('name' => 'Static', 'options' => array('public_dir' => '../public'))), 'pagetag' => array('frontend' => array('name' => 'Core', 'options' => array('automatic_serialization' => true, 'lifetime' => null)), 'backend' => array('name' => 'File', 'options' => array())))

 Constants

 

Constant holding reserved name for default Page Cache

PAGECACHE = 'page' 
 

Constant holding reserved name for default Page Tag Cache

PAGETAGCACHE = 'pagetag'