Cache/Frontend/Page.php
Show:
inherited
inherited
Classes
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 [email protected] so we can send you a copy immediately.
- Category
- Zend
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
- Package
- Zend_Cache
- Subpackage
- Zend_Cache_Frontend
- Version
- $Id$
\Zend_Cache_Frontend_Page
Package: Zend_Cache\Zend_Cache_Frontend
- Parent(s)
- \Zend_Cache_Core
- Copyright
- Copyright (c) 2005-2014 Zend Technologies USA Inc. (http://www.zend.com)
- License
- New BSD License
Properties
array $_activeOptions = array()Internal array to store some options
Default value
array()Details- Type
- array
boolean $_cancel = falseIf true, the page won't be cached
Default value
falseDetails- Type
- boolean
array $_specificOptions = array('http_conditional' => false, 'debug_header' => false, 'content_type_memorization' => false, 'memorize_headers' => array(), 'default_options' => array('cache_with_get_variables' => false, 'cache_with_post_variables' => false, 'cache_with_session_variables' => false, 'cache_with_files_variables' => false, 'cache_with_cookie_variables' => false, 'make_id_with_get_variables' => true, 'make_id_with_post_variables' => true, 'make_id_with_session_variables' => true, 'make_id_with_files_variables' => true, 'make_id_with_cookie_variables' => true, 'cache' => true, 'specific_lifetime' => false, 'tags' => array(), 'priority' => null), 'regexps' => array())This frontend specific 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' => false, 'debug_header' => false, 'content_type_memorization' => false, 'memorize_headers' => array(), 'default_options' => array('cache_with_get_variables' => false, 'cache_with_post_variables' => false, 'cache_with_session_variables' => false, 'cache_with_files_variables' => false, 'cache_with_cookie_variables' => false, 'make_id_with_get_variables' => true, 'make_id_with_post_variables' => true, 'make_id_with_session_variables' => true, 'make_id_with_files_variables' => true, 'make_id_with_cookie_variables' => true, 'cache' => true, 'specific_lifetime' => false, 'tags' => array(), 'priority' => null), 'regexps' => array())Details- Type
- array
Methods
__construct(array $options = array()) : voidConstructor
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $options | array | Associative array of options |
| Exception | Description |
|---|---|
| \Zend_Cache_Exception |
_flush(string $data) : stringcallback for output buffering (shouldn't really be called manually)
Parameters
Returns
| Name | Type | Description |
|---|---|---|
| $data | string | Buffered output |
| Type | Description |
|---|---|
| string | Data to send to browser |
_makeId() : mixed | falseMake 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 |
_makePartialId(string $arrayName, bool $bool1, bool $bool2) : mixed | falseMake a partial id depending on options
Parameters
Returns
| 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 |
| Type | Description |
|---|---|
| mixed | false | Partial id (string) or false if the cache should have not to be used |
_setContentTypeMemorization(boolean $value) : voidSet the deprecated contentTypeMemorization option
Parameters
Details
| Name | Type | Description |
|---|---|---|
| $value | boolean | value |
- Deprecated
_setDefaultOptions(array $options) : voidSpecific setter for the 'default_options' option (with some additional tests)
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $options | array | Associative array |
| Exception | Description |
|---|---|
| \Zend_Cache_Exception |
_setRegexps( $regexps) : voidSpecific setter for the 'regexps' option (with some additional tests)
Parameters
Throws
| Name | Type | Description |
|---|---|---|
| $regexps |
| Exception | Description |
|---|---|
| \Zend_Cache_Exception |
cancel() : voidCancel the current caching process
start(string $id = false, boolean $doNotDie = false) : booleanStart the cache
Parameters
Returns
| 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 ! |
| Type | Description |
|---|---|
| boolean | True if the cache is hit (false else) |