Docs For Class Zend_Controller_Action_Helper

Description

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

Located in /Controller/Action/Helper/Cache.php (line 43)

Zend_Controller_Action_Helper_Abstract
   |
   --Zend_Controller_Action_Helper_Cache

Variable Summary

array $_caching

array $_extensions

Zend_Cache_Manager $_manager

mixed $_obStarted

array $_tags

Method Summary

void direct ( $actions, [ $tags = array()], [ $extension = null])

array getCacheableActions ()

array getCacheableTags ()

Zend_Cache_Manager getManager ()

void preDispatch ()

mixed removePage (string $relativeUrl, [bool $recursive = false])

mixed removePagesTagged ( $tags)

void setManager ( $manager)

string _encodeCacheId (string $requestUri)

mixed __call (string $method, array $args)

Variables

array $_caching = array() (line 59)

Indexed map of Actions to attempt Page caching on by Controller

access: protected

array $_extensions = array() (line 73)

Indexed map of Extensions by Controller and Action

access: protected

Zend_Cache_Manager $_manager = null (line 52)

Local Cache Manager object used by Helper

access: protected

mixed $_obStarted = false (line 78)

Track output buffering condition

access: protected

array $_tags = array() (line 66)

Indexed map of Tags by Controller and Action

access: protected

Inherited Variables

Inherited from Zend_Controller_Action_Helper_Abstract

Zend_Controller_Action_Helper_Abstract::$_actionController
Zend_Controller_Action_Helper_Abstract::$_frontController

Methods

direct (line 88)

Tell the helper which actions are cacheable and under which tags (if applicable) they should be recorded with

access: public

void direct ( $actions, [ $tags = array()], [ $extension = null])

array $actions
array $tags
$extension

getCacheableActions (line 245)

Return a list of actions for the current Controller marked for caching

access: public

array getCacheableActions ()

getCacheableTags (line 255)

Return a list of tags set for all cacheable actions

access: public

array getCacheableTags ()

getManager (line 224)

Get the Cache Manager instance or instantiate the object if not exists. Attempts to load from bootstrap if available.

access: public

Zend_Cache_Manager getManager ()

preDispatch (line 165)

Commence page caching for any cacheable actions

access: public

void preDispatch ()

Redefinition of:

Zend_Controller_Action_Helper_Abstract::preDispatch(): Hook into action controller preDispatch() workflow

removePage (line 130)

Remove 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.

access: public

mixed removePage (string $relativeUrl, [bool $recursive = false])

string $relativeUrl
bool $recursive

removePagesTagged (line 154)

Remove 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.

access: public

mixed removePagesTagged ( $tags)

array $tags

setManager (line 212)

Set an instance of the Cache Manager for this helper

access: public

void setManager ( $manager)

Zend_Cache_Manager $manager

_encodeCacheId (line 201)

Encode 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!

access: protected

string _encodeCacheId (string $requestUri)

string $requestUri

__call (line 268)

Proxy non-matched methods back to Zend_Cache_Manager where appropriate

access: public

mixed __call (string $method, array $args)

string $method
array $args

Inherited Methods

Inherited From Zend_Controller_Action_Helper_Abstract

Zend_Controller_Action_Helper_Abstract::getActionController()
Zend_Controller_Action_Helper_Abstract::getFrontController()
Zend_Controller_Action_Helper_Abstract::getName()
Zend_Controller_Action_Helper_Abstract::getRequest()
Zend_Controller_Action_Helper_Abstract::getResponse()
Zend_Controller_Action_Helper_Abstract::init()
Zend_Controller_Action_Helper_Abstract::postDispatch()
Zend_Controller_Action_Helper_Abstract::preDispatch()
Zend_Controller_Action_Helper_Abstract::setActionController()