Controller/Action/Helper/Cache.php

category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Controller
version: $Id$
Classes: Zend_Controller_Action_Helper_Cache

Description

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.

Zend_Controller_Action_Helper_Cache
jump to top

Extends from: Zend_Controller_Action_Helper_Abstract
category: Zend
copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
license: http://framework.zend.com/license/new-bsd New BSD License
package: Zend_Controller
Properties: $_manager; $_caching; $_tags; $_extensions; $_obStarted
Methods: direct; removePage; removePagesTagged; preDispatch; _encodeCacheId; setManager; getManager; getCacheableActions; getCacheableTags; __call

Description

Properties

$_caching
jump to class

array $_caching = 'array'

Indexed map of Actions to attempt Page caching on by Controller

Details

$_caching: array
visibility: protected
default: array
final: false
static: false

$_extensions
jump to class

array $_extensions = 'array'

Indexed map of Extensions by Controller and Action

Details

$_extensions: array
visibility: protected
default: array
final: false
static: false

$_manager
jump to class

Zend_Cache_Manager $_manager = 'null'

Local Cache Manager object used by Helper

Details

$_manager: Zend_Cache_Manager
visibility: protected
default: null
final: false
static: false

$_obStarted
jump to class

$_obStarted = 'false'

Track output buffering condition

Details

visibility: protected
default: false
final: false
static: false

$_tags
jump to class

array $_tags = 'array'

Indexed map of Tags by Controller and Action

Details

$_tags: array
visibility: protected
default: array
final: false
static: false

Methods

__call
jump to class

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

Proxy non-matched methods back to Zend_Cache_Manager where appropriate

Arguments

$method: string
$args: array

Output

mixed

Details

visibility: public
final: false
static: false

_encodeCacheId
jump to class

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

Arguments

$requestUri: string

Output

string

Details

visibility: protected
final: false
static: false

direct
jump to class

direct(
          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

Arguments

$actions: array
$tags: array
$extension

Details

visibility: public
final: false
static: false

getCacheableActions
jump to class

getCacheableActions(
          
          )
        
        :
        array

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

Output

array

Details

visibility: public
final: false
static: false

getCacheableTags
jump to class

getCacheableTags(
          
          )
        
        :
        array

Return a list of tags set for all cacheable actions

Output

array

Details

visibility: public
final: false
static: false

getManager
jump to class

getManager(
          
          )
        
        :
        Zend_Cache_Manager

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

Output

Zend_Cache_Manager

Details

visibility: public
final: false
static: false

preDispatch
jump to class

preDispatch(
          
          )
        
        :
        void

Commence page caching for any cacheable actions

Details

visibility: public
final: false
static: false

removePage
jump to class

removePage(
          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.

Arguments

$relativeUrl: string
$recursive: bool

Output

mixed

Details

visibility: public
final: false
static: false

removePagesTagged
jump to class

removePagesTagged(
          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.

Arguments

$tags: array

Output

mixed

Details

visibility: public
final: false
static: false

setManager
jump to class

setManager(
          Zend_Cache_Manager $manager
          )
        
        :
        void

Set an instance of the Cache Manager for this helper

Arguments

$manager: Zend_Cache_Manager

Details

visibility: public
final: false
static: false

API Documentation

Controller/Action/Helper/Cache.php

Description

Zend_Controller_Action_Helper_Cachejump to top

Description

Properties

$_cachingjump to class

Details

$_extensionsjump to class

Details

$_managerjump to class

Details

$_obStartedjump to class

Details

$_tagsjump to class

Details

Methods

__calljump to class

Arguments

Output

Details

_encodeCacheIdjump to class

Arguments

Output

Details

directjump to class

Arguments

Details

getCacheableActionsjump to class

Output

Details

getCacheableTagsjump to class

Output

Details

getManagerjump to class

Output

Details

preDispatchjump to class

Details

removePagejump to class

Arguments

Output

Details

removePagesTaggedjump to class

Arguments

Output

Details

setManagerjump to class

Arguments

Details

Zend_Controller_Action_Helper_Cache
jump to top

$_caching
jump to class

$_extensions
jump to class

$_manager
jump to class

$_obStarted
jump to class

$_tags
jump to class

__call
jump to class

_encodeCacheId
jump to class

direct
jump to class

getCacheableActions
jump to class

getCacheableTags
jump to class

getManager
jump to class

preDispatch
jump to class

removePage
jump to class

removePagesTagged
jump to class

setManager
jump to class