Zend_Cache_Backend_ZendServer Class Reference

Inheritance diagram for Zend_Cache_Backend_ZendServer:

Public Member Functions
	load ($id, $doNotTestCacheValidity=false)
	test ($id)
	save ($data, $id, $tags=array(), $specificLifetime=false)
	remove ($id)
	clean ($mode=Zend_Cache::CLEANING_MODE_ALL, $tags=array())
Public Member Functions inherited from Zend_Cache_Backend
	__construct (array $options=array())
	setDirectives ($directives)
	setOption ($name, $value)
	getOption ($name)
	getLifetime ($specificLifetime)
	isAutomaticCleaningAvailable ()
	getTmpDir ()
Public Member Functions inherited from Zend_Cache_Backend_Interface
	setDirectives ($directives)

Protected Member Functions
	_store ($data, $id, $timeToLive)
	_fetch ($id)
	_unset ($id)
	_clear ()
Protected Member Functions inherited from Zend_Cache_Backend
	_isGoodTmpDir ($dir)
	_loggerSanity ()
	_log ($message, $priority=4)

Protected Attributes
	$_options
Protected Attributes inherited from Zend_Cache_Backend
	$_directives
	$_options = array()

Detailed Description

Definition at line 37 of file ZendServer.php.

Member Function Documentation

_clear()

_clear ( )

abstractprotected

Clear cache

_fetch()

_fetch (   $id )

abstractprotected

Fetch data

Parameters

string

$id

Cache id

Exceptions

Zend_Cache_Exception

_store()

_store (   $data,   $id,   $timeToLive  )

abstractprotected

Store data

Parameters

mixed	$data	Object to store
string	$id	Cache id
int	$timeToLive	Time to live in seconds

Exceptions

Zend_Cache_Exception

_unset()

_unset (   $id )

abstractprotected

Unset data

Parameters

string

$id

Cache id

clean()

clean	(		$mode = Zend_Cache::CLEANING_MODE_ALL,
			$tags = array()
	)

Clean some cache records

Available modes are : 'all' (default) => remove all cache entries ($tags is not used) 'old' => unsupported 'matchingTag' => unsupported 'notMatchingTag' => unsupported 'matchingAnyTag' => unsupported

Parameters

string	$mode	clean mode
array	$tags	array of tags

Exceptions

Zend_Cache_Exception

Returns

boolean true if no problem

Implements Zend_Cache_Backend_Interface.

Definition at line 186 of file ZendServer.php.

    {
        switch ($mode) {
            case Zend_Cache::CLEANING_MODE_ALL:
                $this->_clear();
                return true;
                break;
            case Zend_Cache::CLEANING_MODE_OLD:
                $this->_log("Zend_Cache_Backend_ZendServer::clean() : CLEANING_MODE_OLD is unsupported by the Zend Server backends.");
                break;
            case Zend_Cache::CLEANING_MODE_MATCHING_TAG:
            case Zend_Cache::CLEANING_MODE_NOT_MATCHING_TAG:
            case Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG:
                $this->_clear();
                $this->_log('Zend_Cache_Backend_ZendServer::clean() : tags are unsupported by the Zend Server backends.');
                break;
            default:
                Zend_Cache::throwException('Invalid mode for clean() method');
                break;
        }
    }

load()

load	(		$id,
			$doNotTestCacheValidity = 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

Returns

string cached datas (or false)

Implements Zend_Cache_Backend_Interface.

Definition at line 88 of file ZendServer.php.

    {
        $tmp = $this->_fetch($id);
        if ($tmp !== null) {
            return $tmp;
        }
        return false;
    }

remove()

remove

(

$id

)

Remove a cache record

Parameters

string

$id

cache id

Returns

boolean true if no problem

Implements Zend_Cache_Backend_Interface.

Definition at line 163 of file ZendServer.php.

    {
        $result1 = $this->_unset($id);
        $result2 = $this->_unset('internal-metadatas---' . $id);

        return $result1 && $result2;
    }

save()

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

Save some string datas into a cache record

Note : $data is always "string" (serialization is done by the core not by the backend)

Parameters

string	$data	datas to cache
string	$id	cache id
array	$tags	array of strings, the cache record will be tagged by each string entry
int	$specificLifetime	if != false, set a specific lifetime for this cache record (null => infinite lifetime)

Returns

boolean true if no problem

Implements Zend_Cache_Backend_Interface.

Definition at line 141 of file ZendServer.php.

    {
        $lifetime = $this->getLifetime($specificLifetime);
        $metadatas = array(
            'mtime' => time(),
            'expire' => $this->_expireTime($lifetime),
        );

        if (count($tags) > 0) {
            $this->_log('Zend_Cache_Backend_ZendServer::save() : tags are unsupported by the ZendServer backends');
        }

        return  $this->_store($data, $id, $lifetime) &&
                $this->_store($metadatas, 'internal-metadatas---' . $id, $lifetime);
    }

test()

test

(

$id

)

Test if a cache is available or not (for the given id)

Parameters

string

$id

cache id

Returns

mixed false (a cache is not available) or "last modified" timestamp (int) of the available cache record

Exceptions

Zend_Cache_Exception

Implements Zend_Cache_Backend_Interface.

Definition at line 104 of file ZendServer.php.

    {
        $tmp = $this->_fetch('internal-metadatas---' . $id);
        if ($tmp !== false) {
            if (!is_array($tmp) || !isset($tmp['mtime'])) {
                Zend_Cache::throwException('Cache metadata for \'' . $id . '\' id is corrupted' );
            }
            return $tmp['mtime'];
        }
        return false;
    }

Field Documentation

$_options

$_options

protected

Initial value:

= array(
        'namespace' => 'zendframework'
    )

Definition at line 47 of file ZendServer.php.

---

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

• vendor/magento/zendframework1/library/Zend/Cache/Backend/ZendServer.php