Class Zend_Cache_Frontend_Page

Description
  • license: New BSD License
  • copyright: Copyright (c) 2005-2007 Zend Technologies USA Inc. (http://www.zend.com)

Located in /Zend/Cache/Frontend/Page.php (line 38)

Zend_Cache_Core
   |
   --Zend_Cache_Frontend_Page
Variable Summary
Method Summary
 Zend_Cache_Frontend_Page __construct ([array $options = array()], boolean $doNotTestCacheValidity)
 boolean start ([string $id = false], [boolean $doNotDie = false])
 string _flush (string $data)
 void _setDefaultOptions (array $options)
 void _setRegexps ( $regexps, array $options)
Variables
array $_activeOptions = array() (line 94)

Internal array to store some options

  • var: associative array of options
  • access: protected
array $_specificOptions = array(
'httpConditional' => false,
'debugHeader' => false,
'defaultOptions' => array(
'cacheWithGetVariables' => false,
'cacheWithPostVariables' => false,
'cacheWithSessionVariables' => false,
'cacheWithFilesVariables' => false,
'cacheWithCookieVariables' => false,
'makeIdWithGetVariables' => true,
'makeIdWithPostVariables' => true,
'makeIdWithSessionVariables' => true,
'makeIdWithFilesVariables' => true,
'makeIdWithCookieVariables' => true,
'cache' => true
),'regexps'=>array())
(line 70)

This frontend specific options

====> (boolean) httpConditional :

  • if true, http conditional mode is on
WARNING : httpConditional OPTION IS NOT IMPLEMENTED FOR THE MOMENT (TODO)

====> (boolean) debugHeader :

  • if true, a debug text is added before each cached pages
====> (array) defaultOptions :
    • (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
    ====> (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 defaultOptions for the list of available options)
    • if several regexps match the $_SERVER['REQUEST_URI'], only the last one will be used

    • var: options
    • access: protected

    Redefinition of:
    Zend_Cache_Core::$_specificOptions
    Not used for the core, just a sort a hint to get a common setOption() method (for the core and for frontends)

    Inherited Variables

    Inherited from Zend_Cache_Core

    Zend_Cache_Core::$_directivesList
    Zend_Cache_Core::$_options
    Methods
    Constructor __construct (line 102)

    Constructor

    • access: public
    Zend_Cache_Frontend_Page __construct ([array $options = array()], boolean $doNotTestCacheValidity)
    • array $options: associative array of options
    • boolean $doNotTestCacheValidity: if set to true, the cache validity won't be tested

    Redefinition of:
    Zend_Cache_Core::__construct()
    Constructor
    start (line 173)

    Start the cache

    • return: true if the cache is hit (false else)
    • access: public
    boolean start ([string $id = false], [boolean $doNotDie = false])
    • string $id: (optional) a cache id (if you set a value here, maybe you have to use Output frontend instead)
    • boolean $doNotDie: for unit testing only !
    _flush (line 220)

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

    • return: data to send to browser
    • access: public
    string _flush (string $data)
    • string $data: buffered output
    _setDefaultOptions (line 128)

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

    • access: protected
    void _setDefaultOptions (array $options)
    • array $options: associative array
    _setRegexps (line 147)

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

    • access: protected
    void _setRegexps ( $regexps, array $options)
    • array $options: associative array
    • $regexps

    Inherited Methods

    Inherited From Zend_Cache_Core

     Zend_Cache_Core::__construct()
     Zend_Cache_Core::clean()
     Zend_Cache_Core::get()
     Zend_Cache_Core::load()
     Zend_Cache_Core::remove()
     Zend_Cache_Core::save()
     Zend_Cache_Core::setBackend()
     Zend_Cache_Core::setLifeTime()
     Zend_Cache_Core::setOption()
     Zend_Cache_Core::test()

    Documentation generated on Thu, 18 Jan 2007 09:57:34 -0800 by phpDocumentor 1.3.1