API Documentation

Zend/Cache/Frontend/Page.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_Cache  
Subpackage
Zend_Cache_Frontend  
Version
$Id: Page.php 24594 2012-01-05 21:27:01Z matthew $  

\Zend_Cache_Frontend_Page

Package: Zend\Cache\Zend\Cache\Frontend

Parent(s)
\Zend_Cache_Core
Copyright
Copyright (c) 2005-2012 Zend Technologies USA Inc. (http://www.zend.com)  
License
New BSD License  

Properties

Propertyprotectedarray  $_activeOptions= 'array()'

Internal array to store some options

associative array of options
Default valuearray()Details
Type
array
Propertyprotectedboolean  $_cancel= 'false'

If true, the page won't be cached

Default valuefalseDetails
Type
boolean
Propertyprotectedarray  $_specificOptions= 'array( 'http_conditional' => false'

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 valuearray( 'http_conditional' => falseDetails
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_makeId( ) : mixed|false

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

Returns
Type Description
mixed|false 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
mixed|false 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
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
methodpubliccancel( ) : void

Cancel the current caching process

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)
Documentation was generated by DocBlox 0.15.1.