Inheritance diagram for Zend_Cache_Backend_BlackHole:

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

	getIds ()

	getTags ()

	getIdsMatchingTags ($tags=array())

	getIdsNotMatchingTags ($tags=array())

	getIdsMatchingAnyTags ($tags=array())

	getFillingPercentage ()

	getMetadatas ($id)

	touch ($id, $extraLifetime)

	getCapabilities ()

	___expire ($id)

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)

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 39 of file BlackHole.php.

Member Function Documentation

◆ ___expire()

___expire ( $id )

PUBLIC METHOD FOR UNIT TESTING ONLY !

Force a cache record to expire

Parameters

string $id cache id

Definition at line 247 of file BlackHole.php.

248 {

249 }

◆ 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' => remove too old cache entries ($tags is not used) 'matchingTag' => remove cache entries matching all given tags ($tags can be an array of strings or a single string) 'notMatchingTag' => remove cache entries not matching one of the given tags ($tags can be an array of strings or a single string) 'matchingAnyTag' => remove cache entries matching any given tags ($tags can be an array of strings or a single string)

Parameters

string	$mode	clean mode
	tags	array $tags array of tags

Returns: boolean true if no problem

Implements Zend_Cache_Backend_Interface.

Definition at line 111 of file BlackHole.php.

     {
         return true;
     }

◆ 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 228 of file BlackHole.php.

     {
         return array(
             'automatic_cleaning' => true,
             'tags'               => true,
             'expired_read'       => true,
             '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

Exceptions

Zend_Cache_Exception

Implements Zend_Cache_Backend_ExtendedInterface.

Definition at line 181 of file BlackHole.php.

     {
         return 0;
     }

◆ 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 121 of file BlackHole.php.

     {
         return array();
     }

◆ 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 170 of file BlackHole.php.

     {
         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 144 of file BlackHole.php.

     {
         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 157 of file BlackHole.php.

     {
         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 197 of file BlackHole.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 131 of file BlackHole.php.

     {
         return array();
     }

◆ 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|false cached datas

Implements Zend_Cache_Backend_Interface.

Definition at line 50 of file BlackHole.php.

     {
         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 89 of file BlackHole.php.

     {
         return true;
     }

◆ 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 78 of file BlackHole.php.

     {
         return true;
     }

◆ 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 61 of file BlackHole.php.

     {
         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 209 of file BlackHole.php.

     {
         return false;
     }

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

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

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ ___expire()

◆ clean()

◆ getCapabilities()

◆ getFillingPercentage()

◆ getIds()

◆ getIdsMatchingAnyTags()

◆ getIdsMatchingTags()

◆ getIdsNotMatchingTags()

◆ getMetadatas()

◆ getTags()

◆ load()

◆ remove()

◆ save()

◆ test()

◆ touch()