Eaccelerator Class Reference

Inheritance diagram for Eaccelerator:

Public Member Functions
	__construct (array $options=[])
	load ($id, $doNotTestCacheValidity=false)
	test ($id)
	save ($data, $id, $tags=[], $specificLifetime=false)
	remove ($id)
	clean ($mode=\Zend_Cache::CLEANING_MODE_ALL, $tags=[])
	getFillingPercentage ()
	getTags ()
	getIdsMatchingTags ($tags=[])
	getIdsNotMatchingTags ($tags=[])
	getIdsMatchingAnyTags ($tags=[])
	getIds ()
	getMetadatas ($id)
	touch ($id, $extraLifetime)
	getCapabilities ()
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)

Data Fields
const	TAGS_UNSUPPORTED_BY_CLEAN_OF_EACCELERATOR_BACKEND
const	TAGS_UNSUPPORTED_BY_SAVE_OF_EACCELERATOR_BACKEND

Additional Inherited Members
Protected Member Functions inherited from Zend_Cache_Backend
	_isGoodTmpDir ($dir)
	_loggerSanity ()
	_log ($message, $priority=4)
Protected Attributes inherited from Zend_Cache_Backend
	$_directives
	$_options = array()

Detailed Description

Definition at line 9 of file Eaccelerator.php.

Constructor & Destructor Documentation

__construct()

__construct

(

array

$options = []

)

Constructor

Parameters

array

$options

associative array of options

Exceptions

Definition at line 26 of file Eaccelerator.php.

    {
        if (!extension_loaded('eaccelerator')) {
            \Zend_Cache::throwException('The eaccelerator extension must be loaded for using this backend !');
        }
        parent::__construct($options);
    }

Member Function Documentation

clean()

clean	(		$mode = \Zend_Cache::CLEANING_MODE_ALL,
			$tags = []
	)

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
	string[]	$tags array of tags

Exceptions

Implements Zend_Cache_Backend_Interface.

Definition at line 117 of file Eaccelerator.php.

    {
        switch ($mode) {
            case \Zend_Cache::CLEANING_MODE_ALL:
                return eaccelerator_clean();
                break;
            case \Zend_Cache::CLEANING_MODE_OLD:
                $this->_log(
                    "Magento\Framework\Cache\Backend\Eaccelerator::clean() : ".
                    "CLEANING_MODE_OLD is unsupported by the Eaccelerator backend"
                );
                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->_log(self::TAGS_UNSUPPORTED_BY_CLEAN_OF_EACCELERATOR_BACKEND);
                break;
            default:
                \Zend_Cache::throwException('Invalid mode for clean() method');
                break;
        }
    }

getCapabilities()

getCapabilities

(

)

Return an associative array of capabilities (booleans) of the backend

The array must include these keys :

• automatic_cleaning (is automating cleaning necessary)
• tags (are tags supported)
• expired_read (is it possible to read expired cache records (for doNotTestCacheValidity option for example))
• priority does the backend deal with priority when saving
• infinite_lifetime (is infinite lifetime can work with this backend)
• get_list (is it possible to get the list of cache ids and the complete list of tags)

Returns

array associative of with capabilities

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 305 of file Eaccelerator.php.

    {
        return [
            'automatic_cleaning' => false,
            'tags' => false,
            'expired_read' => false,
            'priority' => false,
            'infinite_lifetime' => false,
            'get_list' => true
        ];
    }

getFillingPercentage()

getFillingPercentage

(

)

Return the filling percentage of the backend storage

Exceptions

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 146 of file Eaccelerator.php.

    {
        $mem = eaccelerator_info();
        $memSize = $mem['memorySize'];
        $memAvailable = $mem['memoryAvailable'];
        $memUsed = $memSize - $memAvailable;
        if ($memSize == 0) {
            \Zend_Cache::throwException('can\'t get eaccelerator memory size');
        }
        if ($memUsed > $memSize) {
            return 100;
        }
        return (int)(100. * ($memUsed / $memSize));
    }

getIds()

getIds

(

)

Return an array of stored cache ids

Returns

string[] array of stored cache ids (string) @SuppressWarnings(PHPMD.UnusedLocalVariable)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 223 of file Eaccelerator.php.

    {
        $res = [];
        $array = eaccelerator_list_keys();
        foreach ($array as $key => $info) {
            $res[] = $key;
        }
        return $res;
    }

getIdsMatchingAnyTags()

getIdsMatchingAnyTags

(

$tags = []

)

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

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

Parameters

string[]

$tags array of tags

Returns

string[] array of any matching cache ids (string) @SuppressWarnings(PHPMD.UnusedFormalParameter)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 211 of file Eaccelerator.php.

    {
        $this->_log(self::TAGS_UNSUPPORTED_BY_SAVE_OF_EACCELERATOR_BACKEND);
        return [];
    }

getIdsMatchingTags()

getIdsMatchingTags

(

$tags = []

)

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

string[] array of matching cache ids (string) @SuppressWarnings(PHPMD.UnusedFormalParameter)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 181 of file Eaccelerator.php.

    {
        $this->_log(self::TAGS_UNSUPPORTED_BY_SAVE_OF_EACCELERATOR_BACKEND);
        return [];
    }

getIdsNotMatchingTags()

getIdsNotMatchingTags

(

$tags = []

)

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

string[]

$tags array of tags

Returns

string[] array of not matching cache ids (string) @SuppressWarnings(PHPMD.UnusedFormalParameter)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 196 of file Eaccelerator.php.

    {
        $this->_log(self::TAGS_UNSUPPORTED_BY_SAVE_OF_EACCELERATOR_BACKEND);
        return [];
    }

getMetadatas()

getMetadatas

(

$id

)

Return an array of metadatas for the given cache id

The array must 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|false array of metadatas (false if the cache id is not found) @SuppressWarnings(PHPMD.UnusedLocalVariable)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 245 of file Eaccelerator.php.

    {
        $tmp = eaccelerator_get($id);
        if (is_array($tmp)) {
            $data = $tmp[0];
            $mtime = $tmp[1];
            if (!isset($tmp[2])) {
                // because this record is only with 1.7 release
                // if old cache records are still there...
                return false;
            }
            $lifetime = $tmp[2];
            return ['expire' => $mtime + $lifetime, 'tags' => [], 'mtime' => $mtime];
        }
        return false;
    }

getTags()

getTags

(

)

Return an array of stored tags

Returns

string[] array of stored tags (string)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 166 of file Eaccelerator.php.

    {
        $this->_log(self::TAGS_UNSUPPORTED_BY_SAVE_OF_EACCELERATOR_BACKEND);
        return [];
    }

load()

load	(		$id,
			$doNotTestCacheValidity = false
	)

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

WARNING $doNotTestCacheValidity=true is unsupported by the Eaccelerator backend

Parameters

string	$id	cache id
boolean	$doNotTestCacheValidity	if set to true, the cache validity won't be tested

Returns

string cached datas (or false) @SuppressWarnings(PHPMD.UnusedFormalParameter)

Implements Zend_Cache_Backend_Interface.

Definition at line 44 of file Eaccelerator.php.

    {
        $tmp = eaccelerator_get($id);
        if (is_array($tmp)) {
            return $tmp[0];
        }
        return false;
    }

remove()

remove

(

$id

)

Remove a cache record

Parameters

string

$id

cache id

Returns

bool true if no problem

Implements Zend_Cache_Backend_Interface.

Definition at line 96 of file Eaccelerator.php.

    {
        return eaccelerator_rm($id);
    }

save()

save	(		$data,
			$id,
			$tags = [],
			$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
	string[]	$tags array of strings, the cache record will be tagged by each string entry
int | bool	$specificLifetime	Integer to set a specific lifetime or null for infinite lifetime

Returns

bool true if no problem

Implements Zend_Cache_Backend_Interface.

Definition at line 80 of file Eaccelerator.php.

    {
        $lifetime = $this->getLifetime($specificLifetime);
        $result = eaccelerator_put($id, [$data, time(), $lifetime], $lifetime);
        if (count($tags) > 0) {
            $this->_log(self::TAGS_UNSUPPORTED_BY_SAVE_OF_EACCELERATOR_BACKEND);
        }
        return $result;
    }

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

Implements Zend_Cache_Backend_Interface.

Definition at line 59 of file Eaccelerator.php.

    {
        $tmp = eaccelerator_get($id);
        if (is_array($tmp)) {
            return $tmp[1];
        }
        return false;
    }

touch()

touch	(		$id,
			$extraLifetime
	)

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

Parameters

string	$id	cache id
int	$extraLifetime

Returns

bool true if ok

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 269 of file Eaccelerator.php.

    {
        $tmp = eaccelerator_get($id);
        if (is_array($tmp)) {
            $data = $tmp[0];
            $mtime = $tmp[1];
            if (!isset($tmp[2])) {
                // because this record is only with 1.7 release
                // if old cache records are still there...
                return false;
            }
            $lifetime = $tmp[2];
            $newLifetime = $lifetime - (time() - $mtime) + $extraLifetime;
            if ($newLifetime <= 0) {
                return false;
            }
            eaccelerator_put($id, [$data, time(), $newLifetime], $newLifetime);
            return true;
        }
        return false;
    }

Field Documentation

TAGS_UNSUPPORTED_BY_CLEAN_OF_EACCELERATOR_BACKEND

const TAGS_UNSUPPORTED_BY_CLEAN_OF_EACCELERATOR_BACKEND

Initial value:

=
        'Magento\Framework\Cache\Backend\Eaccelerator::clean() : tags are unsupported by the Eaccelerator backend'

Log message

Definition at line 14 of file Eaccelerator.php.

TAGS_UNSUPPORTED_BY_SAVE_OF_EACCELERATOR_BACKEND

const TAGS_UNSUPPORTED_BY_SAVE_OF_EACCELERATOR_BACKEND

Initial value:

=
        'Magento\Framework\Cache\Backend\Eaccelerator::save() : tags are unsupported by the Eaccelerator backend'

Definition at line 17 of file Eaccelerator.php.

---

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

• vendor/magento/framework/Cache/Backend/Eaccelerator.php