Zend_Cache_Frontend_Output Class Reference

Inheritance diagram for Zend_Cache_Frontend_Output:

Public Member Functions
	__construct (array $options=array())
	start ($id, $doNotTestCacheValidity=false, $echoData=true)
	end ($tags=array(), $specificLifetime=false, $forcedDatas=null, $echoData=true, $priority=8)
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)

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'
Protected Member Functions inherited from Zend_Cache_Core
	_validateIdOrTag ($string)
	_validateTagsArray ($tags)
	_loggerSanity ()
	_log ($message, $priority=4)
	_id ($id)
Protected Attributes inherited from Zend_Cache_Core
	$_backend = null
	$_options
	$_specificOptions = array()
	$_extendedBackend = false
	$_backendCapabilities = array()
Static Protected Attributes inherited from Zend_Cache_Core
static	$_directivesList = array('lifetime', 'logging', 'logger')

Detailed Description

Definition at line 36 of file Output.php.

Constructor & Destructor Documentation

__construct()

__construct

(

array

$options = array()

)

Constructor

Parameters

array

$options

Associative array of options

Returns

void

Definition at line 47 of file Output.php.

    {
        parent::__construct($options);
        $this->_idStack = array();
    }

Member Function Documentation

end()

end	(		$tags = array(),
			$specificLifetime = false,
			$forcedDatas = null,
			$echoData = true,
			$priority = 8
	)

Stop the cache

Parameters

array	$tags	Tags array
int	$specificLifetime	If != false, set a specific lifetime for this cache record (null => infinite lifetime)
string	$forcedDatas	If not null, force written datas with this
boolean	$echoData	If set to true, datas are sent to the browser
int	$priority	integer between 0 (very low priority) and 10 (maximum priority) used by some particular backends

Returns

void

Definition at line 88 of file Output.php.

    {
        if ($forcedDatas === null) {
            $data = ob_get_clean();
        } else {
            $data =& $forcedDatas;
        }
        $id = array_pop($this->_idStack);
        if ($id === null) {
            Zend_Cache::throwException('use of end() without a start()');
        }
        $this->save($data, $id, $tags, $specificLifetime, $priority);
        if ($echoData) {
            echo($data);
        }
    }

start()

start	(		$id,
			$doNotTestCacheValidity = false,
			$echoData = true
	)

Start the cache

Parameters

string	$id	Cache id
boolean	$doNotTestCacheValidity	If set to true, the cache validity won't be tested
boolean	$echoData	If set to true, datas are sent to the browser if the cache is hit (simply returned else)

Returns

mixed True if the cache is hit (false else) with $echoData=true (default) ; string else (datas)

Definition at line 61 of file Output.php.

    {
        $data = $this->load($id, $doNotTestCacheValidity);
        if ($data !== false) {
            if ( $echoData ) {
                echo($data);
                return true;
            } else {
                return $data;
            }
        }
        ob_start();
        ob_implicit_flush(false);
        $this->_idStack[] = $id;
        return false;
    }

---

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

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