Public Member Functions | Protected Member Functions | Protected Attributes

Zend_Cache_Frontend_Page Class Reference

Inheritance diagram for Zend_Cache_Frontend_Page:
Zend_Cache_Core

Public Member Functions

 __construct (array $options=array())
 start ($id=false, $doNotDie=false)
 cancel ()
 _flush ($data)

Protected Member Functions

 _setDefaultOptions ($options)
 _setContentTypeMemorization ($value)
 _setRegexps ($regexps)
 _makeId ()
 _makePartialId ($arrayName, $bool1, $bool2)

Protected Attributes

 $_specificOptions
 $_activeOptions = array()
 $_cancel = false

Detailed Description

Definition at line 36 of file Page.php.


Constructor & Destructor Documentation

__construct ( array $  options = array() )

Constructor

Parameters:
array$optionsAssociative array of options
boolean$doNotTestCacheValidityIf set to true, the cache validity won't be tested
Exceptions:
Zend_Cache_Exception
Returns:
void

Definition at line 130 of file Page.php.


Member Function Documentation

_flush ( data )

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

Parameters:
string$dataBuffered output
Returns:
string Data to send to browser

Definition at line 307 of file Page.php.

_makeId (  ) [protected]

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

Returns:
mixed|false a cache id (string), false if the cache should have not to be used

Definition at line 338 of file Page.php.

_makePartialId ( arrayName,
bool1,
bool2 
) [protected]

Make a partial id depending on options

Parameters:
string$arrayNameSuperglobal array name
bool$bool1If true, cache is still on even if there are some variables in the superglobal array
bool$bool2If true, we have to use the content of the superglobal array to make a partial id
Returns:
mixed|false Partial id (string) or false if the cache should have not to be used

Definition at line 361 of file Page.php.

_setContentTypeMemorization ( value ) [protected]

Set the deprecated contentTypeMemorization option

Parameters:
boolean$valuevalue
Returns:
void
Deprecated:

Definition at line 186 of file Page.php.

_setDefaultOptions ( options ) [protected]

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

Parameters:
array$optionsAssociative array
Exceptions:
Zend_Cache_Exception
Returns:
void

Definition at line 163 of file Page.php.

_setRegexps ( regexps ) [protected]

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

Parameters:
array$optionsAssociative array
Exceptions:
Zend_Cache_Exception
Returns:
void

Definition at line 212 of file Page.php.

cancel (  )

Cancel the current caching process

Definition at line 295 of file Page.php.

start ( id = false,
doNotDie = false 
)

Start the cache

Parameters:
string$id(optional) A cache id (if you set a value here, maybe you have to use Output frontend instead)
boolean$doNotDieFor unit testing only !
Returns:
boolean True if the cache is hit (false else)

Definition at line 242 of file Page.php.


Field Documentation

$_specificOptions [protected]
Initial value:
 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()
    )

Not used for the core, just a sort a hint to get a common setOption() method (for the core and for frontends)

Reimplemented from Zend_Cache_Core.

Definition at line 84 of file Page.php.


The documentation for this class was generated from the following file: