API Documentation

Cache/Frontend/Page.php

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-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Cache  
subpackage
Zend_Cache_Frontend  
version
$Id: Page.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Cache_Frontend_Page

Extends from
\Zend_Cache_Core
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Cache  
subpackage
Zend_Cache_Frontend  

Properties

Propertyprotectedarray  $_activeOptions= 'array'

Internal array to store some options

associative array of options
Default valuearrayDetails
Type
array
Propertyprotectedboolean  $_cancel= 'false'

If true, the page won't be cached

Default valuefalseDetails
Type
boolean
Propertyprotectedarray  $_specificOptions= 'array'

This frontend specific options

options

====> (boolean) http_conditional : - if true, http conditional mode is on WARNING : http_conditional OPTION IS NOT IMPLEMENTED FOR THE MOMENT (TODO)

====> (boolean) debug_header : - if true, a debug text is added before each cached pages

====> (boolean) content_type_memorization : - deprecated => use memorize_headers instead - if the Content-Type header is sent after the cache was started, the corresponding value can be memorized and replayed when the cache is hit (if false (default), the frontend doesn't take care of Content-Type header)

====> (array) memorize_headers : - an array of strings corresponding to some HTTP headers name. Listed headers will be stored with cache datas and "replayed" when the cache is hit

====> (array) default_options : - an associative array of default options : - (boolean) cache : cache is on by default if true - (boolean) cacheWithXXXVariables (XXXX = 'Get', 'Post', 'Session', 'Files' or 'Cookie') : if true, cache is still on even if there are some variables in this superglobal array if false, cache is off if there are some variables in this superglobal array - (boolean) makeIdWithXXXVariables (XXXX = 'Get', 'Post', 'Session', 'Files' or 'Cookie') : if true, we have to use the content of this superglobal array to make a cache id if false, the cache id won't be dependent of the content of this superglobal array - (int) specific_lifetime : cache specific lifetime (false => global lifetime is used, null => infinite lifetime, integer => this lifetime is used), this "lifetime" is probably only usefull when used with "regexps" array - (array) tags : array of tags (strings) - (int) priority : integer between 0 (very low priority) and 10 (maximum priority) used by some particular backends

====> (array) regexps : - an associative array to set options only for some REQUEST_URI - keys are (pcre) regexps - values are associative array with specific options to set if the regexp matchs on $_SERVER['REQUEST_URI'] (see default_options for the list of available options) - if several regexps match the $_SERVER['REQUEST_URI'], only the last one will be used

Default valuearrayDetails
Type
array

Methods

methodpublic__construct( array $options = array ) : void

Constructor

Parameters
Name Type Description
$options array Associative array of options
Throws
Exception Description
\Zend_Cache_Exception
methodpublic_flush( string $data ) : string

callback for output buffering (shouldn't really be called manually)

Parameters
Name Type Description
$data string Buffered output
Returns
Type Description
string Data to send to browser
methodprotected_id( string $id ) : string

Make and return a cache id

Inherited from: \Zend_Cache_Core::_id()

Checks 'cache_id_prefix' and returns new id with prefix or simply the id if null

Parameters
Name Type Description
$id string Cache id
Returns
Type Description
string Cache id (with or without prefix)
methodprotected_log( string $message,  $priority = 4 ) : void

Log a message at the WARN (4) priority.

Inherited from: \Zend_Cache_Core::_log()
Parameters
Name Type Description
$message string
$priority
Throws
Exception Description
\Zend_Cache_Exception
methodprotected_loggerSanity( ) : void

Make sure if we enable logging that the Zend_Log class is available.

Inherited from: \Zend_Cache_Core::_loggerSanity()

Create a default log object if none is set.

Throws
Exception Description
\Zend_Cache_Exception
methodprotected_makeId( ) : mixed|false

Make an id depending on REQUEST_URI and superglobal arrays (depending on options)

Returns
Type Description
mixedfalse a cache id (string), false if the cache should have not to be used
methodprotected_makePartialId( string $arrayName, bool $bool1, bool $bool2 ) : mixed|false

Make a partial id depending on options

Parameters
Name Type Description
$arrayName string Superglobal array name
$bool1 bool If true, cache is still on even if there are some variables in the superglobal array
$bool2 bool If true, we have to use the content of the superglobal array to make a partial id
Returns
Type Description
mixedfalse Partial id (string) or false if the cache should have not to be used
methodprotected_setContentTypeMemorization( boolean $value ) : void

Set the deprecated contentTypeMemorization option

Parameters
Name Type Description
$value boolean value
Details
deprecated
 
methodprotected_setDefaultOptions( array $options ) : void

Specific setter for the 'default_options' option (with some additional tests)

Parameters
Name Type Description
$options array Associative array
Throws
Exception Description
\Zend_Cache_Exception
methodprivate_setOption( string $name, mixed $value ) : void

Set an option

Inherited from: \Zend_Cache_Core::_setOption()
Parameters
Name Type Description
$name string Name of the option
$value mixed Value of the option
Throws
Exception Description
\Zend_Cache_Exception
methodprotected_setRegexps(  $regexps ) : void

Specific setter for the 'regexps' option (with some additional tests)

Parameters
Name Type Description
$regexps
Throws
Exception Description
\Zend_Cache_Exception
methodprotected_validateIdOrTag( string $string ) : void
static

Validate a cache id or a tag (security, reliable filenames, reserved prefixes...)

Inherited from: \Zend_Cache_Core::_validateIdOrTag()

Throw an exception if a problem is found

Parameters
Name Type Description
$string string Cache id or tag
Throws
Exception Description
\Zend_Cache_Exception
methodprotected_validateTagsArray( array $tags ) : void
static

Validate a tags array (security, reliable filenames, reserved prefixes...)

Inherited from: \Zend_Cache_Core::_validateTagsArray()

Throw an exception if a problem is found

Parameters
Name Type Description
$tags array Array of tags
Throws
Exception Description
\Zend_Cache_Exception
methodpubliccancel( ) : void

Cancel the current caching process

methodpublicclean( string $mode = all, array|string $tags = array ) : boolean

Clean cache entries

Inherited from: \Zend_Cache_Core::clean()

Available modes are : 'all' (default) => remove all cache entries ($tags is not used) 'old' => remove too old cache entries ($tags is not used) 'matchingTag' => remove cache entries matching all given tags ($tags can be an array of strings or a single string) 'notMatchingTag' => remove cache entries not matching one of the given tags ($tags can be an array of strings or a single string) 'matchingAnyTag' => remove cache entries matching any given tags ($tags can be an array of strings or a single string)

Parameters
Name Type Description
$mode string
$tags array|string
Returns
Type Description
boolean True if ok
Throws
Exception Description
\Zend_Cache_Exception
methodpublicgetBackend( ) : \Zend_Cache_Backend

Returns the backend

Inherited from: \Zend_Cache_Core::getBackend()
Returns
Type Description
\Zend_Cache_Backend backend object
methodpublicgetFillingPercentage( ) : int

Return the filling percentage of the backend storage

Inherited from: \Zend_Cache_Core::getFillingPercentage()
Returns
Type Description
int integer between 0 and 100
methodpublicgetIds( ) : array

Return an array of stored cache ids

Inherited from: \Zend_Cache_Core::getIds()
Returns
Type Description
array array of stored cache ids (string)
methodpublicgetIdsMatchingAnyTags( array $tags = array ) : array

Return an array of stored cache ids which match any given tags

Inherited from: \Zend_Cache_Core::getIdsMatchingAnyTags()

In case of multiple tags, a logical OR is made between tags

Parameters
Name Type Description
$tags array array of tags
Returns
Type Description
array array of matching any cache ids (string)
methodpublicgetIdsMatchingTags( array $tags = array ) : array

Return an array of stored cache ids which match given tags

Inherited from: \Zend_Cache_Core::getIdsMatchingTags()

In case of multiple tags, a logical AND is made between tags

Parameters
Name Type Description
$tags array array of tags
Returns
Type Description
array array of matching cache ids (string)
methodpublicgetIdsNotMatchingTags( array $tags = array ) : array

Return an array of stored cache ids which don't match given tags

Inherited from: \Zend_Cache_Core::getIdsNotMatchingTags()

In case of multiple tags, a logical OR is made between tags

Parameters
Name Type Description
$tags array array of tags
Returns
Type Description
array array of not matching cache ids (string)
methodpublicgetMetadatas( string $id ) : array

Return an array of metadatas for the given cache id

Inherited from: \Zend_Cache_Core::getMetadatas()

The array will include these keys : - expire : the expire timestamp - tags : a string array of tags - mtime : timestamp of last modification time

Parameters
Name Type Description
$id string cache id
Returns
Type Description
array array of metadatas (false if the cache id is not found)
methodpublicgetOption( string $name ) : mixed

Public frontend to get an option value

Inherited from: \Zend_Cache_Core::getOption()
Parameters
Name Type Description
$name string Name of the option
Returns
Type Description
mixed option value
Throws
Exception Description
\Zend_Cache_Exception
methodpublicgetTags( ) : array

Return an array of stored tags

Inherited from: \Zend_Cache_Core::getTags()
Returns
Type Description
array array of stored tags (string)
methodpublicload( string $id, boolean $doNotTestCacheValidity = false, boolean $doNotUnserialize = false ) : mixed|false

Test if a cache is available for the given id and (if yes) return it (false else)

Inherited from: \Zend_Cache_Core::load()
Parameters
Name Type Description
$id string Cache id
$doNotTestCacheValidity boolean

If set to true, the cache validity won't be tested

$doNotUnserialize boolean

Do not serialize (even if automatic_serialization is true) => for internal use

Returns
Type Description
mixedfalse Cached datas
methodpublicremove( string $id ) : boolean

Remove a cache

Inherited from: \Zend_Cache_Core::remove()
Parameters
Name Type Description
$id string Cache id to remove
Returns
Type Description
boolean True if ok
methodpublicsave( mixed $data, string $id = null, array $tags = array, int $specificLifetime = false, int $priority = 8 ) : boolean

Save some data in a cache

Inherited from: \Zend_Cache_Core::save()
Parameters
Name Type Description
$data mixed

Data to put in cache (can be another type than string if automatic_serialization is on)

$id string

Cache id (if not set, the last cache id will be used)

$tags array Cache tags
$specificLifetime int

If != false, set a specific lifetime for this cache record (null => infinite lifetime)

$priority int

integer between 0 (very low priority) and 10 (maximum priority) used by some particular backends

Returns
Type Description
boolean True if no problem
Throws
Exception Description
\Zend_Cache_Exception
methodpublicsetBackend( \Zend_Cache_Backend $backendObject ) : void

Set the backend

Inherited from: \Zend_Cache_Core::setBackend()
Parameters
Name Type Description
$backendObject \Zend_Cache_Backend
Throws
Exception Description
\Zend_Cache_Exception
methodpublicsetConfig( \Zend_Config $config ) : \Zend_Cache_Core

Set options using an instance of type Zend_Config

Inherited from: \Zend_Cache_Core::setConfig()
Parameters
Name Type Description
$config \Zend_Config
Returns
Type Description
\Zend_Cache_Core
methodpublicsetLifetime( int $newLifetime ) : void

Force a new lifetime

Inherited from: \Zend_Cache_Core::setLifetime()

The new value is set for the core/frontend but for the backend too (directive)

Parameters
Name Type Description
$newLifetime int

New lifetime (in seconds)

methodpublicsetOption( string $name, mixed $value ) : void

Public frontend to set an option

Inherited from: \Zend_Cache_Core::setOption()

There is an additional validation (relatively to the protected _setOption method)

Parameters
Name Type Description
$name string Name of the option
$value mixed Value of the option
Throws
Exception Description
\Zend_Cache_Exception
methodpublicstart( string $id = false, boolean $doNotDie = false ) : boolean

Start the cache

Parameters
Name Type Description
$id string

(optional) A cache id (if you set a value here, maybe you have to use Output frontend instead)

$doNotDie boolean

For unit testing only !

Returns
Type Description
boolean True if the cache is hit (false else)
methodpublictest( string $id ) : int|false

Test if a cache is available for the given id

Inherited from: \Zend_Cache_Core::test()
Parameters
Name Type Description
$id string Cache id
Returns
Type Description
intfalse Last modified time of cache entry if it is available, false otherwise
methodpublictouch( string $id, int $extraLifetime ) : boolean

Give (if possible) an extra lifetime to the given cache id

Inherited from: \Zend_Cache_Core::touch()
Parameters
Name Type Description
$id string cache id
$extraLifetime int
Returns
Type Description
boolean true if ok
Documentation was generated by DocBlox 0.13.3.