Zend_Cache_Frontend_Function Class Reference

Inheritance diagram for Zend_Cache_Frontend_Function:

Public Member Functions
	__construct (array $options=array())
	call ($callback, array $parameters=array(), $tags=array(), $specificLifetime=false, $priority=8)
	makeId ($callback, array $args=array())
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 Attributes
	$_specificOptions
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'
Protected Member Functions inherited from Zend_Cache_Core
	_validateIdOrTag ($string)
	_validateTagsArray ($tags)
	_loggerSanity ()
	_log ($message, $priority=4)
	_id ($id)
Static Protected Attributes inherited from Zend_Cache_Core
static	$_directivesList = array('lifetime', 'logging', 'logger')

Detailed Description

Definition at line 36 of file Function.php.

Constructor & Destructor Documentation

__construct()

__construct

(

array

$options = array()

)

Constructor

Parameters

array

$options

Associative array of options

Returns

void

Definition at line 64 of file Function.php.

    {
        foreach ($options as $name => $value) {
            $this->setOption($name, $value);
        }
        $this->setOption('automatic_serialization', true);
    }

Member Function Documentation

call()

call	(		$callback,
		array	$parameters = array(),
			$tags = array(),
			$specificLifetime = false,
			$priority = 8
	)

Main method : call the specified function or get the result from cache

Parameters

callback	$callback	A valid callback
array	$parameters	Function parameters
array	$tags	Cache tags
int	$specificLifetime	If != false, set a specific lifetime for this cache record (null => infinite lifetime)
int	$priority	integer between 0 (very low priority) and 10 (maximum priority) used by some particular backends

Returns

mixed Result

Definition at line 82 of file Function.php.

    {
        if (!is_callable($callback, true, $name)) {
            Zend_Cache::throwException('Invalid callback');
        }

        $cacheBool1 = $this->_specificOptions['cache_by_default'];
        $cacheBool2 = in_array($name, $this->_specificOptions['cached_functions']);
        $cacheBool3 = in_array($name, $this->_specificOptions['non_cached_functions']);
        $cache = (($cacheBool1 || $cacheBool2) && (!$cacheBool3));
        if (!$cache) {
            // Caching of this callback is disabled
            return call_user_func_array($callback, $parameters);
        }

        $id = $this->_makeId($callback, $parameters);
        if ( ($rs = $this->load($id)) && isset($rs[0], $rs[1])) {
            // A cache is available
            $output = $rs[0];
            $return = $rs[1];
        } else {
            // A cache is not available (or not valid for this frontend)
            ob_start();
            ob_implicit_flush(false);
            $return = call_user_func_array($callback, $parameters);
            $output = ob_get_clean();
            $data = array($output, $return);
            $this->save($data, $id, $tags, $specificLifetime, $priority);
        }

        echo $output;
        return $return;
    }

makeId()

makeId	(		$callback,
		array	$args = array()
	)

Make a cache id from the function name and parameters

Parameters

callback	$callback	A valid callback
array	$args	Function parameters

Exceptions

Zend_Cache_Exception

Returns

string Cache id

Definition at line 134 of file Function.php.

    {
        if (!is_callable($callback, true, $name)) {
            Zend_Cache::throwException('Invalid callback');
        }

        // functions, methods and classnames are case-insensitive
        $name = strtolower($name);

        // generate a unique id for object callbacks
        if (is_object($callback)) { // Closures & __invoke
            $object = $callback;
        } elseif (isset($callback[0])) { // array($object, 'method')
            $object = $callback[0];
        }
        if (isset($object)) {
            try {
                $tmp = @serialize($callback);
            } catch (Exception $e) {
                Zend_Cache::throwException($e->getMessage());
            }
            if (!$tmp) {
                $lastErr = error_get_last();
                Zend_Cache::throwException("Can't serialize callback object to generate id: {$lastErr['message']}");
            }
            $name.= '__' . $tmp;
        }

        // generate a unique id for arguments
        $argsStr = '';
        if ($args) {
            try {
                $argsStr = @serialize(array_values($args));
            } catch (Exception $e) {
                Zend_Cache::throwException($e->getMessage());
            }
            if (!$argsStr) {
                $lastErr = error_get_last();
                throw Zend_Cache::throwException("Can't serialize arguments to generate id: {$lastErr['message']}");
            }
        }

        return md5($name . $argsStr);
    }

Field Documentation

$_specificOptions

$_specificOptions

protected

Initial value:

= array(
        'cache_by_default' => true,
        'cached_functions' => array(),
        'non_cached_functions' => array()
    )

Definition at line 52 of file Function.php.

---

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

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