Inheritance diagram for Zend_Cache_Backend_Test:

Public Member Functions
	__construct ($options=array())

	setDirectives ($directives)

	load ($id, $doNotTestCacheValidity=false)

	test ($id)

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

	remove ($id)

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

	getLastLog ()

	getLogIndex ()

	getAllLogs ()

	isAutomaticCleaningAvailable ()

	getIds ()

	getTags ()

	getIdsMatchingTags ($tags=array())

	getIdsNotMatchingTags ($tags=array())

	getIdsMatchingAnyTags ($tags=array())

	getFillingPercentage ()

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

Protected Attributes
	$_options = array()

	$_directives = array()

Protected Attributes inherited from Zend_Cache_Backend
	$_directives

	$_options = array()

Additional Inherited Members
Protected Member Functions inherited from Zend_Cache_Backend
	_isGoodTmpDir ($dir)

	_loggerSanity ()

	_log ($message, $priority=4)

Detailed Description

Definition at line 40 of file Test.php.

Constructor & Destructor Documentation

◆ __construct()

__construct ( $options = array() )

Constructor

Parameters

array $options associative array of options

Returns: void

Definition at line 76 of file Test.php.

     {
         $this->_addLog('construct', array($options));
     }

Member Function Documentation

◆ clean()

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

Clean some cache records

For this test backend only, if $mode == 'false', then the method will return false (true else)

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) 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 => remove cache entries not {matching one of the given tags} ($tags can be an array of strings or a single string)

Parameters

string	$mode	Clean mode
array	$tags	Array of tags

Returns: boolean True if no problem

Implements Zend_Cache_Backend_Interface.

Definition at line 212 of file Test.php.

     {
         $this->_addLog('clean', array($mode, $tags));
         if ($mode=='false') {
             return false;
         }
         return true;
     }

◆ getAllLogs()

getAllLogs ( )

Get the complete log array

Returns: array Complete log array

Definition at line 246 of file Test.php.

     {
         return $this->_log;
     }

◆ 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 388 of file Test.php.

     {
         return array(
             'automatic_cleaning' => true,
             'tags'               => true,
             'expired_read'       => false,
             'priority'           => true,
             'infinite_lifetime'  => true,
             'get_list'           => true
         );
     }

◆ getFillingPercentage()

getFillingPercentage ( )

Return the filling percentage of the backend storage

Returns: int integer between 0 and 100

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 341 of file Test.php.

     {
         return 50;
     }

◆ 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 266 of file Test.php.

     {
         return array(
             'prefix_id1', 'prefix_id2'
         );
     }

◆ 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 327 of file Test.php.

     {
         if ($tags == array('tag5', 'tag6')) {
             return array('prefix_id5', 'prefix_id6');
         }
 
         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 293 of file Test.php.

     {
         if ($tags == array('tag1', 'tag2')) {
             return array('prefix_id1', 'prefix_id2');
         }
 
         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 310 of file Test.php.

     {
         if ($tags == array('tag3', 'tag4')) {
             return array('prefix_id3', 'prefix_id4');
         }
 
         return array();
     }

◆ getLastLog()

getLastLog ( )

Get the last log

Returns: string The last log

Definition at line 226 of file Test.php.

     {
         return $this->_log[$this->_index - 1];
     }

◆ getLogIndex()

getLogIndex ( )

Get the log index

Returns: int Log index

Definition at line 236 of file Test.php.

     {
         return $this->_index;
     }

◆ 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 357 of file Test.php.

     {
         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 278 of file Test.php.

     {
         return array(
             'tag1', 'tag2'
         );
     }

◆ isAutomaticCleaningAvailable()

isAutomaticCleaningAvailable ( )

Return true if the automatic cleaning is available for the backend

Returns: boolean

Definition at line 256 of file Test.php.

     {
         return true;
     }

◆ load()

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

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

For this test backend only, if $id == 'false', then the method will return false if $id == 'serialized', the method will return a serialized array ('foo' 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 103 of file Test.php.

     {
         $this->_addLog('get', array($id, $doNotTestCacheValidity));
 
         if ( $id == 'false'
           || $id == 'd8523b3ee441006261eeffa5c3d3a0a7'
           || $id == 'e83249ea22178277d5befc2c5e2e9ace'
           || $id == '40f649b94977c0a6e76902e2a0b43587'
           || $id == '88161989b73a4cbfd0b701c446115a99'
           || $id == '205fc79cba24f0f0018eb92c7c8b3ba4'
           || $id == '170720e35f38150b811f68a937fb042d')
         {
             return false;
         }
         if ($id=='serialized') {
             return serialize(array('foo'));
         }
         if ($id=='serialized2') {
             return serialize(array('headers' => array(), 'data' => 'foo'));
         }
         if ( $id == '71769f39054f75894288e397df04e445' || $id == '615d222619fb20b527168340cebd0578'
           || $id == '8a02d218a5165c467e7a5747cc6bd4b6' || $id == '648aca1366211d17cbf48e65dc570bee'
           || $id == '4a923ef02d7f997ca14d56dfeae25ea7') {
             return serialize(array('foo', 'bar'));
         }
         if ( $id == 'f53c7d912cc523d9a65834c8286eceb9') {
             return serialize(array('foobar'));
         }
         return 'foo';
     }

◆ remove()

remove ( $id )

Remove a cache record

For this test backend only, if $id == 'false', then the method will return false (true else)

Parameters

string $id Cache id

Returns: boolean True if no problem

Implements Zend_Cache_Backend_Interface.

Definition at line 185 of file Test.php.

     {
         $this->_addLog('remove', array($id));
         if (substr($id,-5)=='false') {
             return false;
         }
         return true;
     }

◆ save()

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

Save some string datas into a cache record

For this test backend only, if $id == 'false', then the method will return false (true else)

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 167 of file Test.php.

     {
         $this->_addLog('save', array($data, $id, $tags));
         if (substr($id,-5)=='false') {
             return false;
         }
         return true;
     }

◆ setDirectives()

setDirectives ( $directives )

Set the frontend directives

Parameters

array $directives assoc of directives

Returns: void

Implements Zend_Cache_Backend_Interface.

Definition at line 87 of file Test.php.

     {
         $this->_addLog('setDirectives', array($directives));
     }

◆ test()

test ( $id )

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

For this test backend only, if $id == 'false', then the method will return false (123456 else)

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 143 of file Test.php.

     {
         $this->_addLog('test', array($id));
         if ($id=='false') {
             return false;
         }
         if (($id=='3c439c922209e2cb0b54d6deffccd75a')) {
             return false;
         }
         return 123456;
     }

◆ 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 369 of file Test.php.

     {
         return true;
     }

Field Documentation

◆ $_directives

$_directives = array()

protected

Definition at line 54 of file Test.php.

◆ $_options

$_options = array()

protected

Definition at line 47 of file Test.php.

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

vendor/magento/zendframework1/library/Zend/Cache/Backend/Test.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ clean()

◆ getAllLogs()

◆ getCapabilities()

◆ getFillingPercentage()

◆ getIds()

◆ getIdsMatchingAnyTags()

◆ getIdsMatchingTags()

◆ getIdsNotMatchingTags()

◆ getLastLog()

◆ getLogIndex()

◆ getMetadatas()

◆ getTags()

◆ isAutomaticCleaningAvailable()

◆ load()

◆ remove()

◆ save()

◆ setDirectives()

◆ test()

◆ touch()

Field Documentation

◆ $_directives

◆ $_options