Zend_Cache_Frontend_Class Class Reference

Inheritance diagram for Zend_Cache_Frontend_Class:

Public Member Functions
	__construct (array $options=array())
	setSpecificLifetime ($specificLifetime=false)
	setPriority ($priority)
	setOption ($name, $value)
	setCachedEntity ($cachedEntity)
	setTagsArray ($tags=array())
	__call ($name, $parameters)
	makeId ($name, 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
	$_tags = array()
	$_specificLifetime = false
	$_cachedEntity = null
	$_cachedEntityLabel = ''
	$_priority = 8
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 35 of file Class.php.

Constructor & Destructor Documentation

__construct()

__construct

(

array

$options = array()

)

Constructor

Parameters

array

$options

Associative array of options

Exceptions

Zend_Cache_Exception

Definition at line 107 of file Class.php.

    {
        foreach ($options as $name => $value) {
            $this->setOption($name, $value);
        }
        if ($this->_specificOptions['cached_entity'] === null) {
            Zend_Cache::throwException('cached_entity must be set !');
        }
        $this->setCachedEntity($this->_specificOptions['cached_entity']);
        $this->setOption('automatic_serialization', true);
    }

Member Function Documentation

__call()

__call	(		$name,
			$parameters
	)

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

Parameters

string	$name	Method name
array	$parameters	Method parameters

Returns

mixed Result

Exceptions

Exception

Definition at line 205 of file Class.php.

    {
        $callback = array($this->_cachedEntity, $name);

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

        $cacheBool1 = $this->_specificOptions['cache_by_default'];
        $cacheBool2 = in_array($name, $this->_specificOptions['cached_methods']);
        $cacheBool3 = in_array($name, $this->_specificOptions['non_cached_methods']);
        $cache      = (($cacheBool1 || $cacheBool2) && (!$cacheBool3));

        if (!$cache) {
            // We do not have not cache
            return call_user_func_array($callback, $parameters);
        }

        $id = $this->makeId($name, $parameters);
        if (($rs = $this->load($id)) && (array_key_exists(0, $rs))
            && (array_key_exists(1, $rs))
        ) {
            // 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);

            try {
                $return = call_user_func_array($callback, $parameters);
                $output = ob_get_clean();
                $data   = array($output, $return);

                $this->save(
                    $data, $id, $this->_tags, $this->_specificLifetime,
                    $this->_priority
                );
            } catch (Exception $e) {
                ob_end_clean();
                throw $e;
            }
        }

        echo $output;
        return $return;
    }

makeId()

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

Make a cache id from the method name and parameters

Parameters

string	$name	Method name
array	$args	Method parameters

Returns

string Cache id

Definition at line 271 of file Class.php.

    {
        return md5($this->_cachedEntityLabel . '__' . $name . '__' . serialize($args));
    }

setCachedEntity()

setCachedEntity

(

$cachedEntity

)

Specific method to set the cachedEntity

if set to a class name, we will cache an abstract class and will use only static calls if set to an object, we will cache this object methods

Parameters

mixed

$cachedEntity

Definition at line 167 of file Class.php.

    {
        if (!is_string($cachedEntity) && !is_object($cachedEntity)) {
            Zend_Cache::throwException(
                'cached_entity must be an object or a class name'
            );
        }

        $this->_cachedEntity                     = $cachedEntity;
        $this->_specificOptions['cached_entity'] = $cachedEntity;

        if (is_string($this->_cachedEntity)) {
            $this->_cachedEntityLabel = $this->_cachedEntity;
        } else {
            $ro = new ReflectionObject($this->_cachedEntity);
            $this->_cachedEntityLabel = $ro->getName();
        }
    }

setOption()

setOption	(		$name,
			$value
	)

Public frontend to set an option

Just a wrapper to get a specific behaviour for cached_entity

Parameters

string	$name	Name of the option
mixed	$value	Value of the option

Exceptions

Zend_Cache_Exception

Returns

void

Definition at line 150 of file Class.php.

    {
        if ($name == 'cached_entity') {
            $this->setCachedEntity($value);
        } else {
            parent::setOption($name, $value);
        }
    }

setPriority()

setPriority

(

$priority

)

Set the priority (used by some particular backends)

Parameters

int

$priority

integer between 0 (very low priority) and 10 (maximum priority)

Definition at line 135 of file Class.php.

    {
        $this->_priority = $priority;
    }

setSpecificLifetime()

setSpecificLifetime

(

$specificLifetime = false

)

Set a specific life time

Parameters

bool | int

$specificLifetime

Returns

void

Definition at line 125 of file Class.php.

    {
        $this->_specificLifetime = $specificLifetime;
    }

setTagsArray()

setTagsArray

(

$tags = array()

)

Set the cache array

Parameters

array

$tags

Returns

void

Definition at line 192 of file Class.php.

    {
        $this->_tags = $tags;
    }

Field Documentation

$_cachedEntity

$_cachedEntity = null

protected

Definition at line 83 of file Class.php.

$_cachedEntityLabel

$_cachedEntityLabel = ''

protected

Definition at line 92 of file Class.php.

$_priority

$_priority = 8

protected

Definition at line 99 of file Class.php.

$_specificLifetime

$_specificLifetime = false

protected

Definition at line 76 of file Class.php.

$_specificOptions

$_specificOptions

protected

Initial value:

= array(
        'cached_entity'      => null,
        'cache_by_default'   => true,
        'cached_methods'     => array(),
        'non_cached_methods' => array()
    )

Definition at line 55 of file Class.php.

$_tags

$_tags = array()

protected

Definition at line 67 of file Class.php.

---

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

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