Zend_Cache_Frontend_Page Class Reference

Inheritance diagram for Zend_Cache_Frontend_Page:

Public Member Functions
	__construct (array $options=array())
	start ($id=false, $doNotDie=false)
	cancel ()
	_flush ($data)
Public Member Functions inherited from Zend_Cache_Core
	__construct ($options=array())
	setConfig (Zend_Config $config)
	setBackend (Zend_Cache_Backend $backendObject)
	getBackend ()
	setOption ($name, $value)
	getOption ($name)
	setLifetime ($newLifetime)
	load ($id, $doNotTestCacheValidity=false, $doNotUnserialize=false)
	test ($id)
	save ($data, $id=null, $tags=array(), $specificLifetime=false, $priority=8)
	remove ($id)
	clean ($mode='all', $tags=array())
	getIdsMatchingTags ($tags=array())
	getIdsNotMatchingTags ($tags=array())
	getIdsMatchingAnyTags ($tags=array())
	getIds ()
	getTags ()
	getFillingPercentage ()
	getMetadatas ($id)
	touch ($id, $extraLifetime)

Protected Member Functions
	_setDefaultOptions ($options)
	_setContentTypeMemorization ($value)
	_setRegexps ($regexps)
	_makeId ()
	_makePartialId ($arrayName, $bool1, $bool2)
Protected Member Functions inherited from Zend_Cache_Core
	_validateIdOrTag ($string)
	_validateTagsArray ($tags)
	_loggerSanity ()
	_log ($message, $priority=4)
	_id ($id)

Protected Attributes
	$_specificOptions
	$_activeOptions = array()
	$_cancel = false
Protected Attributes inherited from Zend_Cache_Core
	$_backend = null
	$_options
	$_specificOptions = array()
	$_extendedBackend = false
	$_backendCapabilities = array()

Additional Inherited Members
Data Fields inherited from Zend_Cache_Core
const	BACKEND_NOT_SUPPORTS_TAG = 'tags are not supported by the current backend'
const	BACKEND_NOT_IMPLEMENTS_EXTENDED_IF = 'Current backend doesn\'t implement the Zend_Cache_Backend_ExtendedInterface, so this method is not available'
Static Protected Attributes inherited from Zend_Cache_Core
static	$_directivesList = array('lifetime', 'logging', 'logger')

Detailed Description

Definition at line 36 of file Page.php.

Constructor & Destructor Documentation

__construct()

__construct

(

array

$options = array()

)

Constructor

Parameters

array	$options	Associative array of options
boolean	$doNotTestCacheValidity	If set to true, the cache validity won't be tested

Exceptions

Zend_Cache_Exception

Returns

void

Definition at line 130 of file Page.php.

    {
        foreach ($options as $name => $value) {
            $name = strtolower($name);
            switch ($name) {
                case 'regexps':
                    $this->_setRegexps($value);
                    break;
                case 'default_options':
                    $this->_setDefaultOptions($value);
                    break;
                case 'content_type_memorization':
                    $this->_setContentTypeMemorization($value);
                    break;
                default:
                    $this->setOption($name, $value);
            }
        }
        if (isset($this->_specificOptions['http_conditional'])) {
            if ($this->_specificOptions['http_conditional']) {
                Zend_Cache::throwException('http_conditional is not implemented for the moment !');
            }
        }
        $this->setOption('automatic_serialization', true);
    }

Member Function Documentation

_flush()

_flush

(

$data

)

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

Parameters

string

$data

Buffered output

Returns

string Data to send to browser

Definition at line 309 of file Page.php.

    {
        if ($this->_cancel) {
            return $data;
        }
        $contentType = null;
        $storedHeaders = array();
        $headersList = headers_list();
        foreach($this->_specificOptions['memorize_headers'] as $key=>$headerName) {
            foreach ($headersList as $headerSent) {
                $tmp = explode(':', $headerSent);
                $headerSentName = trim(array_shift($tmp));
                if (strtolower($headerName) == strtolower($headerSentName)) {
                    $headerSentValue = trim(implode(':', $tmp));
                    $storedHeaders[] = array($headerSentName, $headerSentValue);
                }
            }
        }
        $array = array(
            'data' => $data,
            'headers' => $storedHeaders
        );
        $this->save($array, null, $this->_activeOptions['tags'], $this->_activeOptions['specific_lifetime'], $this->_activeOptions['priority']);
        return $data;
    }

_makeId()

_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 340 of file Page.php.

    {
        $tmp = $_SERVER['REQUEST_URI'];
        $array = explode('?', $tmp, 2);
          $tmp = $array[0];
        foreach (array('Get', 'Post', 'Session', 'Files', 'Cookie') as $arrayName) {
            $tmp2 = $this->_makePartialId($arrayName, $this->_activeOptions['cache_with_' . strtolower($arrayName) . '_variables'], $this->_activeOptions['make_id_with_' . strtolower($arrayName) . '_variables']);
            if ($tmp2===false) {
                return false;
            }
            $tmp = $tmp . $tmp2;
        }
        return md5($tmp);
    }

_makePartialId()

_makePartialId (   $arrayName,   $bool1,   $bool2  )

protected

Make a partial id depending on options

Parameters

string	$arrayName	Superglobal array name
bool	$bool1	If true, cache is still on even if there are some variables in the superglobal array
bool	$bool2	If 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 363 of file Page.php.

    {
        switch ($arrayName) {
        case 'Get':
            $var = $_GET;
            break;
        case 'Post':
            $var = $_POST;
            break;
        case 'Session':
            if (isset($_SESSION)) {
                $var = $_SESSION;
            } else {
                $var = null;
            }
            break;
        case 'Cookie':
            if (isset($_COOKIE)) {
                $var = $_COOKIE;
            } else {
                $var = null;
            }
            break;
        case 'Files':
            $var = $_FILES;
            break;
        default:
            return false;
        }
        if ($bool1) {
            if ($bool2) {
                return serialize($var);
            }
            return '';
        }
        if (is_array($var) && count($var) > 0) {
            return false;
        }
        return '';
    }

_setContentTypeMemorization()

_setContentTypeMemorization (   $value )

protected

Set the deprecated contentTypeMemorization option

Parameters

boolean

$value

value

Returns

void

Deprecated:

Definition at line 186 of file Page.php.

    {
        $found = null;
        foreach ($this->_specificOptions['memorize_headers'] as $key => $value) {
            if (strtolower($value) == 'content-type') {
                $found = $key;
            }
        }
        if ($value) {
            if (!$found) {
                $this->_specificOptions['memorize_headers'][] = 'Content-Type';
            }
        } else {
            if ($found) {
                unset($this->_specificOptions['memorize_headers'][$found]);
            }
        }
    }

_setDefaultOptions()

_setDefaultOptions (   $options )

protected

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

Parameters

array

$options

Associative array

Exceptions

Zend_Cache_Exception

Returns

void

Definition at line 163 of file Page.php.

    {
        if (!is_array($options)) {
            Zend_Cache::throwException('default_options must be an array !');
        }
        foreach ($options as $key=>$value) {
            if (!is_string($key)) {
                Zend_Cache::throwException("invalid option [$key] !");
            }
            $key = strtolower($key);
            if (isset($this->_specificOptions['default_options'][$key])) {
                $this->_specificOptions['default_options'][$key] = $value;
            }
        }
    }

_setRegexps()

_setRegexps (   $regexps )

protected

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

Parameters

array

$options

Associative array

Exceptions

Zend_Cache_Exception

Returns

void

Definition at line 212 of file Page.php.

    {
        if (!is_array($regexps)) {
            Zend_Cache::throwException('regexps option must be an array !');
        }
        foreach ($regexps as $regexp=>$conf) {
            if (!is_array($conf)) {
                Zend_Cache::throwException('regexps option must be an array of arrays !');
            }
            $validKeys = array_keys($this->_specificOptions['default_options']);
            foreach ($conf as $key=>$value) {
                if (!is_string($key)) {
                    Zend_Cache::throwException("unknown option [$key] !");
                }
                $key = strtolower($key);
                if (!in_array($key, $validKeys)) {
                    unset($regexps[$regexp][$key]);
                }
            }
        }
        $this->setOption('regexps', $regexps);
    }

cancel()

cancel

(

)

Cancel the current caching process

Definition at line 297 of file Page.php.

    {
        $this->_cancel = true;
    }

start()

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	$doNotDie	For unit testing only !

Returns

boolean True if the cache is hit (false else)

Definition at line 242 of file Page.php.

    {
        $this->_cancel = false;
        $lastMatchingRegexp = null;
        if (isset($_SERVER['REQUEST_URI'])) {
            foreach ($this->_specificOptions['regexps'] as $regexp => $conf) {
                if (preg_match("`$regexp`", $_SERVER['REQUEST_URI'])) {
                    $lastMatchingRegexp = $regexp;
                }
            }
        }
        $this->_activeOptions = $this->_specificOptions['default_options'];
        if ($lastMatchingRegexp !== null) {
            $conf = $this->_specificOptions['regexps'][$lastMatchingRegexp];
            foreach ($conf as $key=>$value) {
                $this->_activeOptions[$key] = $value;
            }
        }
        if (!($this->_activeOptions['cache'])) {
            return false;
        }
        if (!$id) {
            $id = $this->_makeId();
            if (!$id) {
                return false;
            }
        }
        $array = $this->load($id);
        if ($array !== false) {
            $data = $array['data'];
            $headers = $array['headers'];
            if (!headers_sent()) {
                foreach ($headers as $key=>$headerCouple) {
                    $name = $headerCouple[0];
                    $value = $headerCouple[1];
                    header("$name: $value");
                }
            }
            if ($this->_specificOptions['debug_header']) {
                echo 'DEBUG HEADER : This is a cached page !';
            }
            echo $data;
            if ($doNotDie) {
                return true;
            }
            die();
        }
        ob_start(array($this, '_flush'));
        ob_implicit_flush(false);
        return false;
    }

Field Documentation

$_activeOptions

$_activeOptions = array()

protected

Definition at line 113 of file Page.php.

$_cancel

$_cancel = false

protected

Definition at line 120 of file Page.php.

$_specificOptions

$_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()
    )

Definition at line 84 of file Page.php.

---

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

• vendor/magento/zendframework1/library/Zend/Cache/Frontend/Page.php