Zend_Controller_Action_Helper_Cache Class Reference

Public Member Functions
	direct (array $actions, array $tags=array(), $extension=null)
	Tell the helper which actions are cacheable and under which tags (if applicable) they should be recorded with.
	removePage ($relativeUrl, $recursive=false)
	Remove a specific page cache static file based on its relative URL from the application's public directory.
	removePagesTagged (array $tags)
	Remove a specific page cache static file based on its relative URL from the application's public directory.
	preDispatch ()
	Commence page caching for any cacheable actions.
	setManager (Zend_Cache_Manager $manager)
	Set an instance of the Cache Manager for this helper.
	getManager ()
	Get the Cache Manager instance or instantiate the object if not exists.
	getCacheableActions ()
	Return a list of actions for the current Controller marked for caching.
	getCacheableTags ()
	Return a list of tags set for all cacheable actions.
	__call ($method, $args)
	Proxy non-matched methods back to Zend_Cache_Manager where appropriate.
Public Member Functions inherited from Zend_Controller_Action_Helper_Abstract
	setActionController (Zend_Controller_Action $actionController=null)
	setActionController()
	getActionController ()
	Retrieve current action controller.
	getFrontController ()
	Retrieve front controller instance.
	init ()
	Hook into action controller initialization.
	preDispatch ()
	Hook into action controller preDispatch() workflow.
	postDispatch ()
	Hook into action controller postDispatch() workflow.
	getRequest ()
	getRequest() -
	getResponse ()
	getResponse() -
	getName ()
	getName()

Protected Member Functions
	_encodeCacheId ($requestUri)
	Encode a Cache ID as hexadecimal.

Protected Attributes
	$_manager = null
	$_caching = array()
	$_tags = array()
	$_extensions = array()
	$_obStarted = false
	Track output buffering condition.
Protected Attributes inherited from Zend_Controller_Action_Helper_Abstract
	$_actionController = null
	$_actionController
	$_frontController = null

Member Function Documentation

__call	(		$method,
			$args
	)

Proxy non-matched methods back to Zend_Cache_Manager where appropriate.

Parameters

string	$method
array	$args

Returns

mixed

_encodeCacheId (   $requestUri )

protected

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!

Returns

string

Parameters

string

$requestUri

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

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

Parameters

array	$actions
array	$tags

Returns

void

getCacheableActions

(

)

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

Returns

array

getCacheableTags

(

)

Return a list of tags set for all cacheable actions.

Returns

array

getManager

(

)

Get the Cache Manager instance or instantiate the object if not exists.

Attempts to load from bootstrap if available.

Returns

Zend_Cache_Manager

preDispatch

(

)

Commence page caching for any cacheable actions.

Returns

void

removePage	(		$relativeUrl,
			$recursive = false
	)

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.

Parameters

string	$relativeUrl
bool	$recursive

Returns

mixed

removePagesTagged

(

array

$tags

)

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.

Parameters

array

$tags

Returns

mixed

setManager

(

Zend_Cache_Manager

$manager

)

Set an instance of the Cache Manager for this helper.

Parameters

Zend_Cache_Manager

$manager

Returns

void

Member Data Documentation

$_caching = array()

protected

$_extensions = array()

protected

$_manager = null

protected

$_obStarted = false

protected

Track output buffering condition.

$_tags = array()

protected