Zend_Cache_Backend_ZendPlatform Class Reference

Inheritance diagram for Zend_Cache_Backend_ZendPlatform:

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())
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_PREFIX = "internal_ZPtag:"

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 42 of file ZendPlatform.php.

Constructor & Destructor Documentation

__construct()

__construct

(

array

$options = array()

)

Constructor Validate that the Zend Platform is loaded and licensed

Parameters

array

$options

Associative array of options

Exceptions

Zend_Cache_Exception

Returns

void

Definition at line 57 of file ZendPlatform.php.

    {
        if (!function_exists('accelerator_license_info')) {
            Zend_Cache::throwException('The Zend Platform extension must be loaded for using this backend !');
        }
        if (!function_exists('accelerator_get_configuration')) {
            $licenseInfo = accelerator_license_info();
            Zend_Cache::throwException('The Zend Platform extension is not loaded correctly: '.$licenseInfo['failure_reason']);
        }
        $accConf = accelerator_get_configuration();
        if (@!$accConf['output_cache_licensed']) {
            Zend_Cache::throwException('The Zend Platform extension does not have the proper license to use content caching features');
        }
        if (@!$accConf['output_cache_enabled']) {
            Zend_Cache::throwException('The Zend Platform content caching feature must be enabled for using this backend, set the \'zend_accelerator.output_cache_enabled\' directive to On !');
        }
        if (!is_writable($accConf['output_cache_dir'])) {
            Zend_Cache::throwException('The cache copies directory \''. ini_get('zend_accelerator.output_cache_dir') .'\' must be writable !');
        }
        parent:: __construct($options);
    }

Member Function Documentation

clean()

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

Clean some cache records

Available modes are : Zend_Cache::CLEANING_MODE_ALL (default) => remove all cache entries ($tags is not used) Zend_Cache::CLEANING_MODE_OLD => remove too old cache entries ($tags is not used) This mode is not supported in this backend Zend_Cache::CLEANING_MODE_MATCHING_TAG => remove cache entries matching all given tags ($tags can be an array of strings or a single string) Zend_Cache::CLEANING_MODE_NOT_MATCHING_TAG => unsupported Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG => remove cache entries matching any given tags ($tags can be an array of strings or a single string)

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 185 of file ZendPlatform.php.

    {
        switch ($mode) {
            case Zend_Cache::CLEANING_MODE_ALL:
            case Zend_Cache::CLEANING_MODE_OLD:
                $cache_dir = ini_get('zend_accelerator.output_cache_dir');
                if (!$cache_dir) {
                    return false;
                }
                $cache_dir .= '/.php_cache_api/';
                return $this->_clean($cache_dir, $mode);
                break;
            case Zend_Cache::CLEANING_MODE_MATCHING_TAG:
                $idlist = null;
                foreach ($tags as $tag) {
                    $next_idlist = output_cache_get(self::TAGS_PREFIX.$tag, $this->_directives['lifetime']);
                    if ($idlist) {
                        $idlist = array_intersect_assoc($idlist, $next_idlist);
                    } else {
                        $idlist = $next_idlist;
                    }
                    if (count($idlist) == 0) {
                        // if ID list is already empty - we may skip checking other IDs
                        $idlist = null;
                        break;
                    }
                }
                if ($idlist) {
                    foreach ($idlist as $id) {
                        output_cache_remove_key($id);
                    }
                }
                return true;
                break;
            case Zend_Cache::CLEANING_MODE_NOT_MATCHING_TAG:
                $this->_log("Zend_Cache_Backend_ZendPlatform::clean() : CLEANING_MODE_NOT_MATCHING_TAG is not supported by the Zend Platform backend");
                return false;
                break;
            case Zend_Cache::CLEANING_MODE_MATCHING_ANY_TAG:
                $idlist = null;
                foreach ($tags as $tag) {
                    $next_idlist = output_cache_get(self::TAGS_PREFIX.$tag, $this->_directives['lifetime']);
                    if ($idlist) {
                        $idlist = array_merge_recursive($idlist, $next_idlist);
                    } else {
                        $idlist = $next_idlist;
                    }
                    if (count($idlist) == 0) {
                        // if ID list is already empty - we may skip checking other IDs
                        $idlist = null;
                        break;
                    }
                }
                if ($idlist) {
                    foreach ($idlist as $id) {
                        output_cache_remove_key($id);
                    }
                }
                return true;
                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 data (or false)

Implements Zend_Cache_Backend_Interface.

Definition at line 86 of file ZendPlatform.php.

    {
        // doNotTestCacheValidity implemented by giving zero lifetime to the cache
        if ($doNotTestCacheValidity) {
            $lifetime = 0;
        } else {
            $lifetime = $this->_directives['lifetime'];
        }
        $res = output_cache_get($id, $lifetime);
        if($res) {
            return $res[0];
        } else {
            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 161 of file ZendPlatform.php.

    {
        return output_cache_remove_key($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	Data 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 130 of file ZendPlatform.php.

    {
        if (!($specificLifetime === false)) {
            $this->_log("Zend_Cache_Backend_ZendPlatform::save() : non false specifc lifetime is unsuported for this backend");
        }

        $lifetime = $this->_directives['lifetime'];
        $result1  = output_cache_put($id, array($data, time()));
        $result2  = (count($tags) == 0);

        foreach ($tags as $tag) {
            $tagid = self::TAGS_PREFIX.$tag;
            $old_tags = output_cache_get($tagid, $lifetime);
            if ($old_tags === false) {
                $old_tags = array();
            }
            $old_tags[$id] = $id;
            output_cache_remove_key($tagid);
            $result2 = output_cache_put($tagid, $old_tags);
        }

        return $result1 && $result2;
    }

test()

test

(

$id

)

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

Parameters

string

$id

Cache id

Returns

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

Implements Zend_Cache_Backend_Interface.

Definition at line 109 of file ZendPlatform.php.

    {
        $result = output_cache_get($id, $this->_directives['lifetime']);
        if ($result) {
            return $result[1];
        }
        return false;
    }

Field Documentation

TAGS_PREFIX

const TAGS_PREFIX = "internal_ZPtag:"

internal ZP prefix

Definition at line 47 of file ZendPlatform.php.

---

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

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