API Documentation

Zend/Controller/Action/Helper/Cache.php

Show: inherited
Table of Contents

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-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  
Package
Zend_Controller  
Version
$Id: Cache.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Controller_Action_Helper_Cache

Package: Zend\Controller

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

Propertyprotectedarray  $_caching= 'array()'

Indexed map of Actions to attempt Page caching on by Controller

Default valuearray()Details
Type
array
Propertyprotectedarray  $_extensions= 'array()'

Indexed map of Extensions by Controller and Action

Default valuearray()Details
Type
array
Propertyprotected\Zend_Cache_Manager  $_manager= 'null'

Local Cache Manager object used by Helper

Default valuenullDetails
Type
\Zend_Cache_Manager
Propertyprotected  $_obStarted= 'false'

Track output buffering condition

Default valuefalseDetails
Type
Propertyprotectedarray  $_tags= 'array()'

Indexed map of Tags by Controller and Action

Default valuearray()Details
Type
array

Methods

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

Proxy non-matched methods back to Zend_Cache_Manager where appropriate

Parameters
Name Type Description
$method string
$args array
Returns
Type Description
mixed
methodprotected_encodeCacheId( string $requestUri ) : string

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!

Parameters
Name Type Description
$requestUri string
Returns
Type Description
string
methodpublicdirect( array $actions, array $tags = array(),  $extension = null ) : void

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

Parameters
Name Type Description
$actions array
$tags array
$extension
methodpublicgetCacheableActions( ) : array

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

Returns
Type Description
array
methodpublicgetCacheableTags( ) : array

Return a list of tags set for all cacheable actions

Returns
Type Description
array
methodpublicgetManager( ) : \Zend_Cache_Manager

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

Returns
Type Description
\Zend_Cache_Manager
methodpublicpreDispatch( ) : void

Commence page caching for any cacheable actions

methodpublicremovePage( string $relativeUrl, bool $recursive = false ) : mixed

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
Name Type Description
$relativeUrl string
$recursive bool
Returns
Type Description
mixed
methodpublicremovePagesTagged( array $tags ) : mixed

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
Name Type Description
$tags array
Returns
Type Description
mixed
methodpublicsetManager( \Zend_Cache_Manager $manager ) : void

Set an instance of the Cache Manager for this helper

Parameters
Name Type Description
$manager \Zend_Cache_Manager
Documentation was generated by DocBlox 0.15.1.