Zend_Cache_Core Class Reference

Inheritance diagram for Zend_Cache_Core:

Public Member Functions
	__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)

Data Fields
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
	_validateIdOrTag ($string)
	_validateTagsArray ($tags)
	_loggerSanity ()
	_log ($message, $priority=4)
	_id ($id)

Protected Attributes
	$_backend = null
	$_options
	$_specificOptions = array()
	$_extendedBackend = false
	$_backendCapabilities = array()

Static Protected Attributes
static	$_directivesList = array('lifetime', 'logging', 'logger')

Detailed Description

Definition at line 28 of file Core.php.

Constructor & Destructor Documentation

__construct()

__construct

(

$options = array()

)

Constructor

Parameters

array | Zend_Config

$options

Associative array of options or Zend_Config instance

Exceptions

Zend_Cache_Exception

Returns

void

Definition at line 137 of file Core.php.

    {
        if ($options instanceof Zend_Config) {
            $options = $options->toArray();
        }
        if (!is_array($options)) {
            Zend_Cache::throwException("Options passed were not an array"
            . " or Zend_Config instance.");
        }
        foreach ($options as $name => $value) {
            $this->setOption($name, $value);
        }
        $this->_loggerSanity();
    }

Member Function Documentation

_id()

_id (   $id )

protected

Make and return a cache id

Checks 'cache_id_prefix' and returns new id with prefix or simply the id if null

Parameters

string

$id

Cache id

Returns

string Cache id (with or without prefix)

Definition at line 757 of file Core.php.

    {
        if (($id !== null) && isset($this->_options['cache_id_prefix'])) {
            return $this->_options['cache_id_prefix'] . $id; // return with prefix
        }
        return $id; // no prefix, just return the $id passed
    }

_log()

_log (   $message,   $priority = 4  )

protected

Log a message at the WARN (4) priority.

Parameters

string

$message

Exceptions

Zend_Cache_Exception

Returns

void

Definition at line 737 of file Core.php.

    {
        if (!$this->_options['logging']) {
            return;
        }
        if (!(isset($this->_options['logger']) || $this->_options['logger'] instanceof Zend_Log)) {
            Zend_Cache::throwException('Logging is enabled but logger is not set');
        }
        $logger = $this->_options['logger'];
        $logger->log($message, $priority);
    }

_loggerSanity()

_loggerSanity ( )

protected

Make sure if we enable logging that the Zend_Log class is available. Create a default log object if none is set.

Exceptions

Zend_Cache_Exception

Returns

void

Definition at line 711 of file Core.php.

    {
        if (!isset($this->_options['logging']) || !$this->_options['logging']) {
            return;
        }

        if (isset($this->_options['logger']) && $this->_options['logger'] instanceof Zend_Log) {
            return;
        }

        // Create a default logger to the standard output stream
        #require_once 'Zend/Log.php';
        #require_once 'Zend/Log/Writer/Stream.php';
        #require_once 'Zend/Log/Filter/Priority.php';
        $logger = new Zend_Log(new Zend_Log_Writer_Stream('php://output'));
        $logger->addFilter(new Zend_Log_Filter_Priority(Zend_Log::WARN, '<='));
        $this->_options['logger'] = $logger;
    }

_validateIdOrTag()

_validateIdOrTag (   $string )

protected

Validate a cache id or a tag (security, reliable filenames, reserved prefixes...)

Throw an exception if a problem is found

Parameters

string

$string

Cache id or tag

Exceptions

Zend_Cache_Exception

Returns

void

Definition at line 670 of file Core.php.

    {
        if (!is_string($string)) {
            Zend_Cache::throwException('Invalid id or tag : must be a string');
        }
        if (substr($string, 0, 9) == 'internal-') {
            Zend_Cache::throwException('"internal-*" ids or tags are reserved');
        }
        if (!preg_match('~^[a-zA-Z0-9_]+$~D', $string)) {
            Zend_Cache::throwException("Invalid id or tag '$string' : must use only [a-zA-Z0-9_]");
        }
    }

_validateTagsArray()

_validateTagsArray (   $tags )

protected

Validate a tags array (security, reliable filenames, reserved prefixes...)

Throw an exception if a problem is found

Parameters

array

$tags

Array of tags

Exceptions

Zend_Cache_Exception

Returns

void

Definition at line 692 of file Core.php.

    {
        if (!is_array($tags)) {
            Zend_Cache::throwException('Invalid tags array : must be an array');
        }
        foreach($tags as $tag) {
            $this->_validateIdOrTag($tag);
        }
        reset($tags);
    }

clean()

clean	(		$mode = 'all',
			$tags = array()
	)

Clean cache entries

Available modes are : 'all' (default) => remove all cache entries ($tags is not used) 'old' => remove too old cache entries ($tags is not used) 'matchingTag' => remove cache entries matching all given tags ($tags can be an array of strings or a single string) 'notMatchingTag' => remove cache entries not matching one of the given tags ($tags can be an array of strings or a single string) 'matchingAnyTag' => remove cache entries matching any given tags ($tags can be an array of strings or a single string)

Parameters

string	$mode
array | string	$tags

Exceptions

Zend_Cache_Exception

Returns

boolean True if ok

Definition at line 451 of file Core.php.

    {
        if (!$this->_options['caching']) {
            return true;
        }
        if (!in_array($mode, array(Zend_Cache::CLEANING_MODE_ALL,
                                   Zend_Cache::CLEANING_MODE_OLD,
                                   Zend_Cache::CLEANING_MODE_MATCHING_TAG,
                                   Zend_Cache::CLEANING_MODE_NOT_MATCHING_TAG,
                                   Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG))) {
            Zend_Cache::throwException('Invalid cleaning mode');
        }
        $this->_validateTagsArray($tags);

        return $this->_backend->clean($mode, $tags);
    }

getBackend()

getBackend

(

)

Returns the backend

Returns

Zend_Cache_Backend backend object

Definition at line 196 of file Core.php.

    {
        return $this->_backend;
    }

getFillingPercentage()

getFillingPercentage

(

)

Return the filling percentage of the backend storage

Returns

int integer between 0 and 100

Definition at line 615 of file Core.php.

    {
        if (!$this->_extendedBackend) {
            Zend_Cache::throwException(self::BACKEND_NOT_IMPLEMENTS_EXTENDED_IF);
        }
        return $this->_backend->getFillingPercentage();
    }

getIds()

getIds

(

)

Return an array of stored cache ids

Returns

array array of stored cache ids (string)

Definition at line 572 of file Core.php.

    {
        if (!$this->_extendedBackend) {
            Zend_Cache::throwException(self::BACKEND_NOT_IMPLEMENTS_EXTENDED_IF);
        }

        $ids = $this->_backend->getIds();

        // we need to remove cache_id_prefix from ids (see #ZF-6178, #ZF-7600)
        if (isset($this->_options['cache_id_prefix']) && $this->_options['cache_id_prefix'] !== '') {
            $prefix    = & $this->_options['cache_id_prefix'];
            $prefixLen = strlen($prefix);
            foreach ($ids as &$id) {
                if (strpos($id, $prefix) === 0) {
                    $id = substr($id, $prefixLen);
                }
            }
        }

        return $ids;
    }

getIdsMatchingAnyTags()

getIdsMatchingAnyTags

(

$tags = array()

)

Return an array of stored cache ids which match any given tags

In case of multiple tags, a logical OR is made between tags

Parameters

array

$tags

array of tags

Returns

array array of matching any cache ids (string)

Definition at line 542 of file Core.php.

    {
        if (!$this->_extendedBackend) {
            Zend_Cache::throwException(self::BACKEND_NOT_IMPLEMENTS_EXTENDED_IF);
        }
        if (!($this->_backendCapabilities['tags'])) {
            Zend_Cache::throwException(self::BACKEND_NOT_SUPPORTS_TAG);
        }

        $ids = $this->_backend->getIdsMatchingAnyTags($tags);

        // we need to remove cache_id_prefix from ids (see #ZF-6178, #ZF-7600)
        if (isset($this->_options['cache_id_prefix']) && $this->_options['cache_id_prefix'] !== '') {
            $prefix    = & $this->_options['cache_id_prefix'];
            $prefixLen = strlen($prefix);
            foreach ($ids as &$id) {
                if (strpos($id, $prefix) === 0) {
                    $id = substr($id, $prefixLen);
                }
            }
        }

        return $ids;
    }

getIdsMatchingTags()

getIdsMatchingTags

(

$tags = array()

)

Return an array of stored cache ids which match given tags

In case of multiple tags, a logical AND is made between tags

Parameters

array

$tags

array of tags

Returns

array array of matching cache ids (string)

Definition at line 476 of file Core.php.

    {
        if (!$this->_extendedBackend) {
            Zend_Cache::throwException(self::BACKEND_NOT_IMPLEMENTS_EXTENDED_IF);
        }
        if (!($this->_backendCapabilities['tags'])) {
            Zend_Cache::throwException(self::BACKEND_NOT_SUPPORTS_TAG);
        }

        $ids = $this->_backend->getIdsMatchingTags($tags);

        // we need to remove cache_id_prefix from ids (see #ZF-6178, #ZF-7600)
        if (isset($this->_options['cache_id_prefix']) && $this->_options['cache_id_prefix'] !== '') {
            $prefix    = & $this->_options['cache_id_prefix'];
            $prefixLen = strlen($prefix);
            foreach ($ids as &$id) {
                if (strpos($id, $prefix) === 0) {
                    $id = substr($id, $prefixLen);
                }
            }
        }

        return $ids;
    }

getIdsNotMatchingTags()

getIdsNotMatchingTags

(

$tags = array()

)

Return an array of stored cache ids which don't match given tags

In case of multiple tags, a logical OR is made between tags

Parameters

array

$tags

array of tags

Returns

array array of not matching cache ids (string)

Definition at line 509 of file Core.php.

    {
        if (!$this->_extendedBackend) {
            Zend_Cache::throwException(self::BACKEND_NOT_IMPLEMENTS_EXTENDED_IF);
        }
        if (!($this->_backendCapabilities['tags'])) {
            Zend_Cache::throwException(self::BACKEND_NOT_SUPPORTS_TAG);
        }

        $ids = $this->_backend->getIdsNotMatchingTags($tags);

        // we need to remove cache_id_prefix from ids (see #ZF-6178, #ZF-7600)
        if (isset($this->_options['cache_id_prefix']) && $this->_options['cache_id_prefix'] !== '') {
            $prefix    = & $this->_options['cache_id_prefix'];
            $prefixLen = strlen($prefix);
            foreach ($ids as &$id) {
                if (strpos($id, $prefix) === 0) {
                    $id = substr($id, $prefixLen);
                }
            }
        }

        return $ids;
    }

getMetadatas()

getMetadatas

(

$id

)

Return an array of metadatas for the given cache id

The array will include these keys :

• expire : the expire timestamp
• tags : a string array of tags
• mtime : timestamp of last modification time

Parameters

string

$id

cache id

Returns

array array of metadatas (false if the cache id is not found)

Definition at line 634 of file Core.php.

    {
        if (!$this->_extendedBackend) {
            Zend_Cache::throwException(self::BACKEND_NOT_IMPLEMENTS_EXTENDED_IF);
        }
        $id = $this->_id($id); // cache id may need prefix
        return $this->_backend->getMetadatas($id);
    }

getOption()

getOption

(

$name

)

Public frontend to get an option value

Parameters

string

$name

Name of the option

Exceptions

Zend_Cache_Exception

Returns

mixed option value

Definition at line 236 of file Core.php.

    {
        $name = strtolower($name);

        if (array_key_exists($name, $this->_options)) {
            // This is a Core option
            return $this->_options[$name];
        }

        if (array_key_exists($name, $this->_specificOptions)) {
            // This a specic option of this frontend
            return $this->_specificOptions[$name];
        }

        Zend_Cache::throwException("Incorrect option name : $name");
    }

getTags()

getTags

(

)

Return an array of stored tags

Returns

array array of stored tags (string)

Definition at line 599 of file Core.php.

    {
        if (!$this->_extendedBackend) {
            Zend_Cache::throwException(self::BACKEND_NOT_IMPLEMENTS_EXTENDED_IF);
        }
        if (!($this->_backendCapabilities['tags'])) {
            Zend_Cache::throwException(self::BACKEND_NOT_SUPPORTS_TAG);
        }
        return $this->_backend->getTags();
    }

load()

load	(		$id,
			$doNotTestCacheValidity = false,
			$doNotUnserialize = false
	)

Test if a cache is available for the given id and (if yes) return it (false else)

Parameters

string	$id	Cache id
boolean	$doNotTestCacheValidity	If set to true, the cache validity won't be tested
boolean	$doNotUnserialize	Do not serialize (even if automatic_serialization is true) => for internal use

Returns

mixed|false Cached datas

Definition at line 296 of file Core.php.

    {
        if (!$this->_options['caching']) {
            return false;
        }
        $id = $this->_id($id); // cache id may need prefix
        $this->_lastId = $id;
        $this->_validateIdOrTag($id);

        $this->_log("Zend_Cache_Core: load item '{$id}'", 7);
        $data = $this->_backend->load($id, $doNotTestCacheValidity);
        if ($data===false) {
            // no cache available
            return false;
        }
        if ((!$doNotUnserialize) && $this->_options['automatic_serialization']) {
            // we need to unserialize before sending the result
            return unserialize($data);
        }
        return $data;
    }

remove()

remove

(

$id

)

Remove a cache

Parameters

string

$id

Cache id to remove

Returns

boolean True if ok

Definition at line 421 of file Core.php.

    {
        if (!$this->_options['caching']) {
            return true;
        }
        $id = $this->_id($id); // cache id may need prefix
        $this->_validateIdOrTag($id);

        $this->_log("Zend_Cache_Core: remove item '{$id}'", 7);
        return $this->_backend->remove($id);
    }

save()

save	(		$data,
			$id = null,
			$tags = array(),
			$specificLifetime = false,
			$priority = 8
	)

Save some data in a cache

Parameters

mixed	$data	Data to put in cache (can be another type than string if automatic_serialization is on)
string	$id	Cache id (if not set, the last cache id will be used)
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

Exceptions

Zend_Cache_Exception

Returns

boolean True if no problem

Definition at line 348 of file Core.php.

    {
        if (!$this->_options['caching']) {
            return true;
        }
        if ($id === null) {
            $id = $this->_lastId;
        } else {
            $id = $this->_id($id);
        }
        $this->_validateIdOrTag($id);
        $this->_validateTagsArray($tags);
        if ($this->_options['automatic_serialization']) {
            // we need to serialize datas before storing them
            $data = serialize($data);
        } else {
            if (!is_string($data)) {
                Zend_Cache::throwException("Datas must be string or set automatic_serialization = true");
            }
        }

        // automatic cleaning
        if ($this->_options['automatic_cleaning_factor'] > 0) {
            $rand = rand(1, $this->_options['automatic_cleaning_factor']);
            if ($rand==1) {
                //  new way                 || deprecated way
                if ($this->_extendedBackend || method_exists($this->_backend, 'isAutomaticCleaningAvailable')) {
                    $this->_log("Zend_Cache_Core::save(): automatic cleaning running", 7);
                    $this->clean(Zend_Cache::CLEANING_MODE_OLD);
                } else {
                    $this->_log("Zend_Cache_Core::save(): automatic cleaning is not available/necessary with current backend", 4);
                }
            }
        }

        $this->_log("Zend_Cache_Core: save item '{$id}'", 7);
        if ($this->_options['ignore_user_abort']) {
            $abort = ignore_user_abort(true);
        }
        if (($this->_extendedBackend) && ($this->_backendCapabilities['priority'])) {
            $result = $this->_backend->save($data, $id, $tags, $specificLifetime, $priority);
        } else {
            $result = $this->_backend->save($data, $id, $tags, $specificLifetime);
        }
        if ($this->_options['ignore_user_abort']) {
            ignore_user_abort($abort);
        }

        if (!$result) {
            // maybe the cache is corrupted, so we remove it !
            $this->_log("Zend_Cache_Core::save(): failed to save item '{$id}' -> removing it", 4);
            $this->_backend->remove($id);
            return false;
        }

        if ($this->_options['write_control']) {
            $data2 = $this->_backend->load($id, true);
            if ($data!=$data2) {
                $this->_log("Zend_Cache_Core::save(): write control of item '{$id}' failed -> removing it", 4);
                $this->_backend->remove($id);
                return false;
            }
        }

        return true;
    }

setBackend()

setBackend

(

Zend_Cache_Backend

$backendObject

)

Set the backend

Parameters

Zend_Cache_Backend

$backendObject

Exceptions

Zend_Cache_Exception

Returns

void

Definition at line 174 of file Core.php.

    {
        $this->_backend= $backendObject;
        // some options (listed in $_directivesList) have to be given
        // to the backend too (even if they are not "backend specific")
        $directives = array();
        foreach (Zend_Cache_Core::$_directivesList as $directive) {
            $directives[$directive] = $this->_options[$directive];
        }
        $this->_backend->setDirectives($directives);
        if (in_array('Zend_Cache_Backend_ExtendedInterface', class_implements($this->_backend))) {
            $this->_extendedBackend = true;
            $this->_backendCapabilities = $this->_backend->getCapabilities();
        }

    }

setConfig()

setConfig

(

Zend_Config

$config

)

Set options using an instance of type Zend_Config

Parameters

Zend_Config

$config

Returns

Zend_Cache_Core

Definition at line 158 of file Core.php.

    {
        $options = $config->toArray();
        foreach ($options as $name => $value) {
            $this->setOption($name, $value);
        }
        return $this;
    }

setLifetime()

setLifetime

(

$newLifetime

)

Force a new lifetime

The new value is set for the core/frontend but for the backend too (directive)

Parameters

int

$newLifetime

New lifetime (in seconds)

Returns

void

Definition at line 280 of file Core.php.

    {
        $this->_options['lifetime'] = $newLifetime;
        $this->_backend->setDirectives(array(
            'lifetime' => $newLifetime
        ));
    }

setOption()

setOption	(		$name,
			$value
	)

Public frontend to set an option

There is an additional validation (relatively to the protected _setOption method)

Parameters

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

Exceptions

Zend_Cache_Exception

Returns

void

Definition at line 211 of file Core.php.

    {
        if (!is_string($name)) {
            Zend_Cache::throwException("Incorrect option name!");
        }
        $name = strtolower($name);
        if (array_key_exists($name, $this->_options)) {
            // This is a Core option
            $this->_setOption($name, $value);
            return;
        }
        if (array_key_exists($name, $this->_specificOptions)) {
            // This a specic option of this frontend
            $this->_specificOptions[$name] = $value;
            return;
        }
    }

test()

test

(

$id

)

Test if a cache is available for the given id

Parameters

string

$id

Cache id

Returns

int|false Last modified time of cache entry if it is available, false otherwise

Definition at line 324 of file Core.php.

    {
        if (!$this->_options['caching']) {
            return false;
        }
        $id = $this->_id($id); // cache id may need prefix
        $this->_validateIdOrTag($id);
        $this->_lastId = $id;

        $this->_log("Zend_Cache_Core: test item '{$id}'", 7);
        return $this->_backend->test($id);
    }

touch()

touch	(		$id,
			$extraLifetime
	)

Give (if possible) an extra lifetime to the given cache id

Parameters

string	$id	cache id
int	$extraLifetime

Returns

boolean true if ok

Definition at line 650 of file Core.php.

    {
        if (!$this->_extendedBackend) {
            Zend_Cache::throwException(self::BACKEND_NOT_IMPLEMENTS_EXTENDED_IF);
        }
        $id = $this->_id($id); // cache id may need prefix

        $this->_log("Zend_Cache_Core: touch item '{$id}'", 7);
        return $this->_backend->touch($id, $extraLifetime);
    }

Field Documentation

$_backend

Zend_Cache_Backend_Interface $_backend = null

protected

Backend Object

Definition at line 41 of file Core.php.

$_backendCapabilities

$_backendCapabilities = array()

protected

Definition at line 128 of file Core.php.

$_directivesList

array $_directivesList = array('lifetime', 'logging', 'logger')

staticprotected

Array of options which have to be transfered to backend

Definition at line 100 of file Core.php.

$_extendedBackend

boolean $_extendedBackend = false

protected

True if the backend implements Zend_Cache_Backend_ExtendedInterface

Definition at line 121 of file Core.php.

$_options

$_options

protected

Initial value:

= array(
        'write_control'             => true,
        'caching'                   => true,
        'cache_id_prefix'           => null,
        'automatic_serialization'   => false,
        'automatic_cleaning_factor' => 10,
        'lifetime'                  => 3600,
        'logging'                   => false,
        'logger'                    => null,
        'ignore_user_abort'         => false
    )

Definition at line 83 of file Core.php.

$_specificOptions

array $_specificOptions = array()

protected

Not used for the core, just a sort a hint to get a common setOption() method (for the core and for frontends)

Definition at line 107 of file Core.php.

BACKEND_NOT_IMPLEMENTS_EXTENDED_IF

const BACKEND_NOT_IMPLEMENTS_EXTENDED_IF = 'Current backend doesn\'t implement the Zend_Cache_Backend_ExtendedInterface, so this method is not available'

Definition at line 34 of file Core.php.

BACKEND_NOT_SUPPORTS_TAG

const BACKEND_NOT_SUPPORTS_TAG = 'tags are not supported by the current backend'

Messages

Definition at line 33 of file Core.php.

---

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

• vendor/magento/zendframework1/library/Zend/Cache/Core.php