Magento 2 Documentation
2.3
Documentation for Magento 2 CMS v2.3 (December 2018)
|
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 () | |
setDirectives ($directives) | |
getIds () | |
getTags () | |
getIdsMatchingTags ($tags=array()) | |
getIdsNotMatchingTags ($tags=array()) | |
getIdsMatchingAnyTags ($tags=array()) | |
getFillingPercentage () | |
getMetadatas ($id) | |
touch ($id, $extraLifetime) | |
getCapabilities () | |
![]() | |
__construct (array $options=array()) | |
setDirectives ($directives) | |
setOption ($name, $value) | |
getOption ($name) | |
getLifetime ($specificLifetime) | |
isAutomaticCleaningAvailable () | |
getTmpDir () | |
Data Fields | |
const | DEFAULT_HOST = '127.0.0.1' |
const | DEFAULT_PORT = 11211 |
const | DEFAULT_PERSISTENT = true |
const | DEFAULT_WEIGHT = 1 |
const | DEFAULT_TIMEOUT = 1 |
const | DEFAULT_RETRY_INTERVAL = 15 |
const | DEFAULT_STATUS = true |
const | DEFAULT_FAILURE_CALLBACK = null |
const | TAGS_UNSUPPORTED_BY_CLEAN_OF_MEMCACHED_BACKEND = 'Zend_Cache_Backend_Memcached::clean() : tags are unsupported by the Memcached backend' |
const | TAGS_UNSUPPORTED_BY_SAVE_OF_MEMCACHED_BACKEND = 'Zend_Cache_Backend_Memcached::save() : tags are unsupported by the Memcached backend' |
Protected Attributes | |
$_options | |
$_memcache = null | |
![]() | |
$_directives | |
$_options = array() | |
Additional Inherited Members | |
![]() | |
_isGoodTmpDir ($dir) | |
_loggerSanity () | |
_log ($message, $priority=4) | |
Definition at line 41 of file Memcached.php.
__construct | ( | array | $options = array() | ) |
Constructor
array | $options | associative array of options |
Zend_Cache_Exception |
Definition at line 120 of file Memcached.php.
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
string | $mode | Clean mode |
array | $tags | Array of tags |
Zend_Cache_Exception |
Implements Zend_Cache_Backend_Interface.
Definition at line 259 of file Memcached.php.
getCapabilities | ( | ) |
Return an associative array of capabilities (booleans) of the backend
The array must include these keys :
Implements Zend_Cache_Backend_ExtendedInterface.
Definition at line 497 of file Memcached.php.
getFillingPercentage | ( | ) |
Return the filling percentage of the backend storage
Zend_Cache_Exception |
Couchbase 1.x uses 'mem_used' instead of 'bytes'
Implements Zend_Cache_Backend_ExtendedInterface.
Definition at line 380 of file Memcached.php.
getIds | ( | ) |
Return an array of stored cache ids
Implements Zend_Cache_Backend_ExtendedInterface.
Definition at line 315 of file Memcached.php.
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
array | $tags | array of tags |
Implements Zend_Cache_Backend_ExtendedInterface.
Definition at line 368 of file Memcached.php.
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
array | $tags | array of tags |
Implements Zend_Cache_Backend_ExtendedInterface.
Definition at line 340 of file Memcached.php.
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
array | $tags | array of tags |
Implements Zend_Cache_Backend_ExtendedInterface.
Definition at line 354 of file Memcached.php.
getMetadatas | ( | $id | ) |
Return an array of metadatas for the given cache id
The array must include these keys :
string | $id | cache id |
Implements Zend_Cache_Backend_ExtendedInterface.
Definition at line 425 of file Memcached.php.
getTags | ( | ) |
Return an array of stored tags
Implements Zend_Cache_Backend_ExtendedInterface.
Definition at line 326 of file Memcached.php.
isAutomaticCleaningAvailable | ( | ) |
Return true if the automatic cleaning is available for the backend
Definition at line 284 of file Memcached.php.
load | ( | $id, | |
$doNotTestCacheValidity = false |
|||
) |
Test if a cache is available for the given id and (if yes) return it (false else)
string | $id | Cache id |
boolean | $doNotTestCacheValidity | If set to true, the cache validity won't be tested |
Implements Zend_Cache_Backend_Interface.
Definition at line 178 of file Memcached.php.
remove | ( | $id | ) |
Remove a cache record
string | $id | Cache id |
Implements Zend_Cache_Backend_Interface.
Definition at line 239 of file Memcached.php.
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)
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) |
Implements Zend_Cache_Backend_Interface.
Definition at line 214 of file Memcached.php.
setDirectives | ( | $directives | ) |
Set the frontend directives
array | $directives | Assoc of directives |
Zend_Cache_Exception |
Implements Zend_Cache_Backend_Interface.
Definition at line 296 of file Memcached.php.
test | ( | $id | ) |
Test if a cache is available or not (for the given id)
string | $id | Cache id |
Implements Zend_Cache_Backend_Interface.
Definition at line 193 of file Memcached.php.
touch | ( | $id, | |
$extraLifetime | |||
) |
Give (if possible) an extra lifetime to the given cache id
string | $id | cache id |
int | $extraLifetime |
Implements Zend_Cache_Backend_ExtendedInterface.
Definition at line 453 of file Memcached.php.
|
protected |
Definition at line 111 of file Memcached.php.
|
protected |
Definition at line 91 of file Memcached.php.
const DEFAULT_FAILURE_CALLBACK = null |
Definition at line 53 of file Memcached.php.
const DEFAULT_HOST = '127.0.0.1' |
Default Values
Definition at line 46 of file Memcached.php.
const DEFAULT_PERSISTENT = true |
Definition at line 48 of file Memcached.php.
const DEFAULT_PORT = 11211 |
Definition at line 47 of file Memcached.php.
const DEFAULT_RETRY_INTERVAL = 15 |
Definition at line 51 of file Memcached.php.
const DEFAULT_STATUS = true |
Definition at line 52 of file Memcached.php.
const DEFAULT_TIMEOUT = 1 |
Definition at line 50 of file Memcached.php.
const DEFAULT_WEIGHT = 1 |
Definition at line 49 of file Memcached.php.
const TAGS_UNSUPPORTED_BY_CLEAN_OF_MEMCACHED_BACKEND = 'Zend_Cache_Backend_Memcached::clean() : tags are unsupported by the Memcached backend' |
Log message
Definition at line 58 of file Memcached.php.
const TAGS_UNSUPPORTED_BY_SAVE_OF_MEMCACHED_BACKEND = 'Zend_Cache_Backend_Memcached::save() : tags are unsupported by the Memcached backend' |
Definition at line 59 of file Memcached.php.