Cache/Manager.php
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
- Version
- $Id$
Package: Zend_Cache- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Constants
PAGECACHE
= 'page'Constant holding reserved name for default Page Cache
PAGETAGCACHE
= 'pagetag'Constant holding reserved name for default Page Tag Cache
Properties
array $_caches = array()Array of caches stored by the Cache Manager instance
Default valuearray()Details- Type
- array
array $_optionTemplates = 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())))Array of ready made configuration templates for lazy
loading caches.
Default valuearray('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())))Details- Type
- array
Methods
_mergeOptions(array $current, array $options) : arraySimple method to merge two configuration arrays
Parameters| Name | Type | Description |
|---|
| $current | array | |
|---|
| $options | array | |
|---|
Returns 
getCache(string $name) : \Zend_Cache_CoreFetch the named cache object, or instantiate and return a cache object
using a named configuration template
Parameters| Name | Type | Description |
|---|
| $name | string | |
|---|
Returns getCacheTemplate(string $name) : arrayGet the named configuration template
Parameters| Name | Type | Description |
|---|
| $name | string | |
|---|
Returns getCaches() : arrayFetch all available caches
Returns| Type | Description |
|---|
| array | An array of all available caches with it's names as key |
hasCache(string $name) : boolCheck if the Cache Manager contains the named cache object, or a named
configuration template to lazy load the cache object
Parameters| Name | Type | Description |
|---|
| $name | string | |
|---|
Returns hasCacheTemplate(string $name) : boolCheck if the named configuration template
Parameters| Name | Type | Description |
|---|
| $name | string | |
|---|
Returns setCacheTemplate(string $name, array $options) : \Zend_Cache_ManagerSet a named configuration template from which a cache object can later
be lazy loaded
Parameters| Name | Type | Description |
|---|
| $name | string | |
|---|
| $options | array | |
|---|
ReturnsThrows setTemplateOptions(string $name, array $options) : \Zend_Cache_ManagerPass an array containing changes to be applied to a named
configuration
template
Parameters| Name | Type | Description |
|---|
| $name | string | |
|---|
| $options | array | |
|---|
ReturnsThrows| Exception | Description |
|---|
| \Zend_Cache_Exception | for invalid options format or if option templates do not have $name |
inherited
Classes