Controller/Action/Helper/Cache.php
inherited
Classes
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 [email protected] 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_Controller
- Version
- $Id: Cache.php 24853 2012-05-31 23:19:27Z adamlundrigan $
\Zend_Controller_Action_Helper_Cache
- Parent(s)
- \Zend_Controller_Action_Helper_Abstract
- Category
- Zend
- Copyright
- Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
\Zend_Controller_Action $_actionController = null$_actionController
Inherited from: \Zend_Controller_Action_Helper_Abstract::$$_actionControllernullDetails- Type
- \Zend_Controller_Action
- Inherited_from
- \Zend_Controller_Action_Helper_Abstract::$$_actionController
array $_caching = array()Indexed map of Actions to attempt Page caching on by Controller
array()Details- Type
- array
array $_extensions = array()Indexed map of Extensions by Controller and Action
array()Details- Type
- array
mixed $_frontController = nullnullDetails- Type
- mixed
- Inherited_from
- \Zend_Controller_Action_Helper_Abstract::$$_frontController
\Zend_Cache_Manager $_manager = nullLocal Cache Manager object used by Helper
nullDetails- Type
- \Zend_Cache_Manager
$_obStarted = falseTrack output buffering condition
falseDetails- Type
- n/a
array $_tags = array()Indexed map of Tags by Controller and Action
array()Details- Type
- array
Methods
__call(string $method, array $args) : mixedProxy non-matched methods back to Zend_Cache_Manager where appropriate
| Name | Type | Description |
|---|---|---|
| $method | string | |
| $args | array |
| Type | Description |
|---|---|
| mixed |
_encodeCacheId(string $requestUri) : stringEncode a Cache ID as hexadecimal.
This is a workaround because Backend ID validation is trapped in the Frontend classes. Will try to get this reversed for ZF 2.0 because it's a major annoyance to have IDs so restricted!
| Name | Type | Description |
|---|---|---|
| $requestUri | string |
| Type | Description |
|---|---|
| string |
direct(array $actions, array $tags = array(), $extension = null) : voidTell the helper which actions are cacheable and under which tags (if applicable) they should be recorded with
| Name | Type | Description |
|---|---|---|
| $actions | array | |
| $tags | array | |
| $extension |
getActionController() : \Zend_Controller_ActionRetrieve current action controller
Inherited from: \Zend_Controller_Action_Helper_Abstract::getActionController()| Type | Description |
|---|---|
| \Zend_Controller_Action |
getCacheableActions() : arrayReturn a list of actions for the current Controller marked for caching
| Type | Description |
|---|---|
| array |
getCacheableTags() : arrayReturn a list of tags set for all cacheable actions
| Type | Description |
|---|---|
| array |
getFrontController() : \Zend_Controller_FrontRetrieve front controller instance
Inherited from: \Zend_Controller_Action_Helper_Abstract::getFrontController()| Type | Description |
|---|---|
| \Zend_Controller_Front |
getManager() : \Zend_Cache_ManagerGet the Cache Manager instance or instantiate the object if not exists.
Attempts to load from bootstrap if available.
| Type | Description |
|---|---|
| \Zend_Cache_Manager |
getName() : string
| Type | Description |
|---|---|
| string |
getRequest() : \Zend_Controller_Request_Abstract
| Type | Description |
|---|---|
| \Zend_Controller_Request_Abstract | $request |
getResponse() : \Zend_Controller_Response_Abstract
| Type | Description |
|---|---|
| \Zend_Controller_Response_Abstract | $response |
init() : voidHook into action controller initialization
Inherited from: \Zend_Controller_Action_Helper_Abstract::init()postDispatch() : voidHook into action controller postDispatch() workflow
Inherited from: \Zend_Controller_Action_Helper_Abstract::postDispatch()preDispatch() : voidCommence page caching for any cacheable actions
removePage(string $relativeUrl, bool $recursive = false) : mixedRemove a specific page cache static file based on its relative URL from the application's public directory.
The file extension is not required here; usually matches the original REQUEST_URI that was cached.
| Name | Type | Description |
|---|---|---|
| $relativeUrl | string | |
| $recursive | bool |
| Type | Description |
|---|---|
| mixed |
removePagesTagged(array $tags) : mixedRemove a specific page cache static file based on its relative URL from the application's public directory.
The file extension is not required here; usually matches the original REQUEST_URI that was cached.
| Name | Type | Description |
|---|---|---|
| $tags | array |
| Type | Description |
|---|---|
| mixed |
setActionController(\Zend_Controller_Action $actionController = null) : \Zend_Controller_ActionHelper_AbstractsetActionController()
Inherited from: \Zend_Controller_Action_Helper_Abstract::setActionController()| Name | Type | Description |
|---|---|---|
| $actionController | \Zend_Controller_Action |
| Type | Description |
|---|---|
| \Zend_Controller_ActionHelper_Abstract | Provides a fluent interface |
setManager(\Zend_Cache_Manager $manager) : voidSet an instance of the Cache Manager for this helper
| Name | Type | Description |
|---|---|---|
| $manager | \Zend_Cache_Manager |