Zend_Cache_Backend_Apc Class Reference

Inheritance diagram for Zend_Cache_Backend_Apc:

Public Member Functions
	__construct (array $options=array())
	load ($id, $doNotTestCacheValidity=false)
	test ($id)
	save ($data, $id, $tags=array(), $specificLifetime=false)
	remove ($id)
	clean ($mode=Zend_Cache::CLEANING_MODE_ALL, $tags=array())
	isAutomaticCleaningAvailable ()
	getFillingPercentage ()
	getTags ()
	getIdsMatchingTags ($tags=array())
	getIdsNotMatchingTags ($tags=array())
	getIdsMatchingAnyTags ($tags=array())
	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_APC_BACKEND = 'Zend_Cache_Backend_Apc::clean() : tags are unsupported by the Apc backend'
const	TAGS_UNSUPPORTED_BY_SAVE_OF_APC_BACKEND = 'Zend_Cache_Backend_Apc::save() : tags are unsupported by the Apc 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 41 of file Apc.php.

Constructor & Destructor Documentation

__construct()

__construct

(

array

$options = array()

)

Constructor

Parameters

array

$options

associative array of options

Exceptions

Zend_Cache_Exception

Returns

void

Definition at line 56 of file Apc.php.

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

Member Function Documentation

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 145 of file Apc.php.

    {
        switch ($mode) {
            case Zend_Cache::CLEANING_MODE_ALL:
                return apc_clear_cache('user');
                break;
            case Zend_Cache::CLEANING_MODE_OLD:
                $this->_log("Zend_Cache_Backend_Apc::clean() : CLEANING_MODE_OLD is unsupported by the Apc 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_APC_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 343 of file Apc.php.

    {
        return array(
            '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

Zend_Cache_Exception

Returns

int integer between 0 and 100

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 184 of file Apc.php.

    {
        $mem = apc_sma_info(true);
        $memSize    = $mem['num_seg'] * $mem['seg_size'];
        $memAvailable= $mem['avail_mem'];
        $memUsed = $memSize - $memAvailable;
        if ($memSize == 0) {
            Zend_Cache::throwException('can\'t get apc memory size');
        }
        if ($memUsed > $memSize) {
            return 100;
        }
        return ((int) (100. * ($memUsed / $memSize)));
    }

getIds()

getIds

(

)

Return an array of stored cache ids

Returns

array array of stored cache ids (string)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 257 of file Apc.php.

    {
        $ids      = array();
        $iterator = new APCIterator('user', null, APC_ITER_KEY);
        foreach ($iterator as $item) {
            $ids[] = $item['key'];
        }

        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 AND is made between tags

Parameters

array

$tags

array of tags

Returns

array array of any matching cache ids (string)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 246 of file Apc.php.

    {
        $this->_log(self::TAGS_UNSUPPORTED_BY_SAVE_OF_APC_BACKEND);
        return array();
    }

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)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 218 of file Apc.php.

    {
        $this->_log(self::TAGS_UNSUPPORTED_BY_SAVE_OF_APC_BACKEND);
        return array();
    }

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)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 232 of file Apc.php.

    {
        $this->_log(self::TAGS_UNSUPPORTED_BY_SAVE_OF_APC_BACKEND);
        return array();
    }

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 array of metadatas (false if the cache id is not found)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 279 of file Apc.php.

    {
        $tmp = apc_fetch($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 array(
                'expire' => $mtime + $lifetime,
                'tags' => array(),
                'mtime' => $mtime
            );
        }
        return false;
    }

getTags()

getTags

(

)

Return an array of stored tags

Returns

array array of stored tags (string)

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 204 of file Apc.php.

    {
        $this->_log(self::TAGS_UNSUPPORTED_BY_SAVE_OF_APC_BACKEND);
        return array();
    }

isAutomaticCleaningAvailable()

isAutomaticCleaningAvailable

(

)

Return true if the automatic cleaning is available for the backend

DEPRECATED : use getCapabilities() instead

Deprecated:

Returns

boolean

Definition at line 173 of file Apc.php.

    {
        return false;
    }

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 Apc 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)

Implements Zend_Cache_Backend_Interface.

Definition at line 73 of file Apc.php.

    {
        $tmp = apc_fetch($id);
        if (is_array($tmp)) {
            return $tmp[0];
        }
        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 125 of file Apc.php.

    {
        return apc_delete($id);
    }

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 109 of file Apc.php.

    {
        $lifetime = $this->getLifetime($specificLifetime);
        $result = apc_store($id, array($data, time(), $lifetime), $lifetime);
        if (count($tags) > 0) {
            $this->_log(self::TAGS_UNSUPPORTED_BY_SAVE_OF_APC_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 88 of file Apc.php.

    {
        $tmp = apc_fetch($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

boolean true if ok

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 307 of file Apc.php.

    {
        $tmp = apc_fetch($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;
            }
            apc_store($id, array($data, time(), $newLifetime), $newLifetime);
            return true;
        }
        return false;
    }

Field Documentation

TAGS_UNSUPPORTED_BY_CLEAN_OF_APC_BACKEND

const TAGS_UNSUPPORTED_BY_CLEAN_OF_APC_BACKEND = 'Zend_Cache_Backend_Apc::clean() : tags are unsupported by the Apc backend'

Log message

Definition at line 46 of file Apc.php.

TAGS_UNSUPPORTED_BY_SAVE_OF_APC_BACKEND

const TAGS_UNSUPPORTED_BY_SAVE_OF_APC_BACKEND = 'Zend_Cache_Backend_Apc::save() : tags are unsupported by the Apc backend'

Definition at line 47 of file Apc.php.

---

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

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