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

 Methods

Proxy non-matched methods back to Zend_Cache_Manager where appropriate

__call(string $method, array $args) : mixed

Parameters

$method

string

$args

array

Returns

mixed

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

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

Parameters

$actions

array

$tags

array

$extension

Retrieve current action controller

getActionController() : \Zend_Controller_Action
Inherited

Returns

\Zend_Controller_Action

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

getCacheableActions() : array

Returns

array

Return a list of tags set for all cacheable actions

getCacheableTags() : array

Returns

array

Retrieve front controller instance

getFrontController() : \Zend_Controller_Front
Inherited

Returns

\Zend_Controller_Front

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

getManager() : \Zend_Cache_Manager

Returns

\Zend_Cache_Manager

getName()

getName() : string
Inherited

Returns

string

getRequest() -

getRequest() : \Zend_Controller_Request_Abstract
Inherited

Returns

\Zend_Controller_Request_Abstract$request

getResponse() -

getResponse() : \Zend_Controller_Response_Abstract
Inherited

Returns

\Zend_Controller_Response_Abstract$response

Hook into action controller initialization

init() : void
Inherited

Hook into action controller postDispatch() workflow

postDispatch() : void
Inherited

Commence page caching for any cacheable actions

preDispatch() : void
inherited_from \Zend_Controller_Action_Helper_Abstract::preDispatch()

Hook into action controller preDispatch() workflow

preDispatch() : void
Inherited

Remove a specific page cache static file based on its relative URL from the application's public directory.

removePage(string $relativeUrl, boolean $recursive = false) : mixed

The file extension is not required here; usually matches the original REQUEST_URI that was cached.

Parameters

$relativeUrl

string

$recursive

boolean

Returns

mixed

Remove a specific page cache static file based on its relative URL from the application's public directory.

removePagesTagged(array $tags) : mixed

The file extension is not required here; usually matches the original REQUEST_URI that was cached.

Parameters

$tags

array

Returns

mixed

setActionController()

setActionController(\Zend_Controller_Action $actionController = null) : \Zend_Controller_ActionHelper_Abstract
Inherited

Parameters

$actionController

\Zend_Controller_Action

Returns

\Zend_Controller_ActionHelper_AbstractProvides a fluent interface

Set an instance of the Cache Manager for this helper

setManager(\Zend_Cache_Manager $manager) : void

Parameters

$manager

\Zend_Cache_Manager

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!

_encodeCacheId(string $requestUri) : string

Parameters

$requestUri

string

Returns

string

 Properties

 

$_actionController

$_actionController : \Zend_Controller_Action

Default

null
 

Indexed map of Actions to attempt Page caching on by Controller

$_caching : array

Default

array()
 

Indexed map of Extensions by Controller and Action

$_extensions : array

Default

array()
 

$_frontController

$_frontController : mixed

Default

null
 

Local Cache Manager object used by Helper

$_manager : \Zend_Cache_Manager

Default

null
 

Track output buffering condition

$_obStarted 

Default

false
 

Indexed map of Tags by Controller and Action

$_tags : array

Default

array()