Class MemcachedEngine
Memcached storage engine for cache. Memcached has some limitations in the amount of control you have over expire times far in the future. See MemcachedEngine::write() for more information.
Memcached engine supports binary protocol and igbinary serialization (if memcached extension is compiled with --enable-igbinary). Compressed keys can also be incremented/decremented.
- Cake\Cache\CacheEngine uses Cake\Core\InstanceConfigTrait
-
Cake\Cache\Engine\MemcachedEngine
Properties summary
-
$_MemcachedprotectedMemcachedmemcached wrapper. -
$_compiledGroupNamesprotectedstring[] -
$_defaultConfigprotectedarrayThe default config used unless overridden by runtime configuration -
$_serializersprotectedarrayList of available serializer engines
Inherited Properties
Method Summary
-
_parseServerString() protected deprecated
Backwards compatible alias of parseServerString -
_setOptions() protected
Settings the memcached instance -
add() public
Add a key to the cache if it does not already exist. -
clear() public
Delete all keys from the cache -
clearGroup() public
Increments the group value to simulate deletion of all keys under a group old values will remain in storage until they expire.
-
decrement() public
Decrements the value of an integer cached key -
delete() public
Delete a key from the cache -
deleteMany() public
Delete many keys from the cache at once -
getOption() public
Read an option value from the memcached connection. -
groups() public
Returns the
group valuefor each of the configured groups If the group initial value was not found, then it initializes the group accordingly. -
increment() public
Increments the value of an integer cached key -
init() public
Initialize the Cache Engine -
parseServerString() public
Parses the server address into the host/port. Handles both IPv6 and IPv4 addresses and Unix sockets
-
read() public
Read a key from the cache -
readMany() public
Read many keys from the cache at once -
write() public
Write data for key into cache. When using memcached as your cache engine remember that the Memcached pecl extension does not support cache expiry times greater than 30 days in the future. Any duration greater than 30 days will be treated as never expiring.
-
writeMany() public
Write many cache entries to the cache at once
Method Detail
_parseServerString() protected deprecated ¶
_parseServerString( string $server )
Backwards compatible alias of parseServerString
Deprecated
Parameters
- string $server
- The server address string.
Returns
Array containing host, port
_setOptions() protected ¶
_setOptions( )
Settings the memcached instance
Throws
When the Memcached extension is not built with the desired serializer engine.
add() public ¶
add( string $key , mixed $value )
Add a key to the cache if it does not already exist.
Parameters
- string $key
- Identifier for the data.
- mixed $value
- Data to be cached.
Returns
True if the data was successfully cached, false on failure.
Overrides
clear() public ¶
clear( boolean $check )
Delete all keys from the cache
Parameters
- boolean $check
- If true will check expiration, otherwise delete all.
Returns
True if the cache was successfully cleared, false otherwise
clearGroup() public ¶
clearGroup( string $group )
Increments the group value to simulate deletion of all keys under a group old values will remain in storage until they expire.
Parameters
- string $group
- name of the group to be cleared
Returns
success
Overrides
decrement() public ¶
decrement( string $key , integer $offset = 1 )
Decrements the value of an integer cached key
Parameters
- string $key
- Identifier for the data
- integer $offset optional 1
- How much to subtract
Returns
New decremented value, false otherwise
delete() public ¶
delete( string $key )
Delete a key from the cache
Parameters
- string $key
- Identifier for the data
Returns
True if the value was successfully deleted, false if it didn't exist or couldn't be removed.
deleteMany() public ¶
deleteMany( array $keys )
Delete many keys from the cache at once
Parameters
- array $keys
- An array of identifiers for the data
Returns
of boolean values that are true if the key was successfully deleted, false if it didn't exist or couldn't be removed.
Overrides
getOption() public ¶
getOption( string $name )
Read an option value from the memcached connection.
Parameters
- string $name
- The option name to read.
Returns
groups() public ¶
groups( )
Returns the group value for each of the configured groups
If the group initial value was not found, then it initializes
the group accordingly.
Returns
Overrides
increment() public ¶
increment( string $key , integer $offset = 1 )
Increments the value of an integer cached key
Parameters
- string $key
- Identifier for the data
- integer $offset optional 1
- How much to increment
Returns
New incremented value, false otherwise
init() public ¶
init( array $config = [] )
Initialize the Cache Engine
Called automatically by the cache frontend
Parameters
- array $config optional []
- array of setting for the engine
Returns
True if the engine has been successfully initialized, false if not
Throws
When you try use authentication without Memcached compiled with SASL support
Overrides
parseServerString() public ¶
parseServerString( string $server )
Parses the server address into the host/port. Handles both IPv6 and IPv4 addresses and Unix sockets
Parameters
- string $server
- The server address string.
Returns
Array containing host, port
read() public ¶
read( string $key )
Read a key from the cache
Parameters
- string $key
- Identifier for the data
Returns
The cached data, or false if the data doesn't exist, has expired, or if there was an error fetching it.
readMany() public ¶
readMany( array $keys )
Read many keys from the cache at once
Parameters
- array $keys
- An array of identifiers for the data
Returns
An array containing, for each of the given $keys, the cached data or false if cached data could not be retrieved.
Overrides
write() public ¶
write( string $key , mixed $value )
Write data for key into cache. When using memcached as your cache engine remember that the Memcached pecl extension does not support cache expiry times greater than 30 days in the future. Any duration greater than 30 days will be treated as never expiring.
Parameters
- string $key
- Identifier for the data
- mixed $value
- Data to be cached
Returns
True if the data was successfully cached, false on failure
See
writeMany() public ¶
writeMany( array $data )
Write many cache entries to the cache at once
Parameters
- array $data
- An array of data to be stored in the cache
Returns
of bools for each key provided, true if the data was successfully cached, false on failure
Overrides
Methods inherited from Cake\Cache\CacheEngine
_key() protected ¶
_key( string $key )
Generates a safe key, taking account of the configured key prefix
Parameters
- string $key
- the key passed over
Returns
Key
Throws
If key's value is empty
gc() public ¶
gc( integer|null $expires = null )
Garbage collection
Permanently remove all expired and deleted data
Parameters
- integer|null $expires optional null
- [optional] An expires timestamp, invalidating all data before.
Methods used from Cake\Core\InstanceConfigTrait
_configDelete() protected ¶
_configDelete( string $key )
Deletes a single config key.
Parameters
- string $key
- Key to delete.
Throws
_configRead() protected ¶
_configRead( string|null $key )
Reads a config key.
Parameters
- string|null $key
- Key to read.
Returns
_configWrite() protected ¶
_configWrite( string|array $key , mixed $value , boolean|string $merge = false )
Writes a config key.
Parameters
- string|array $key
- Key to write to.
- mixed $value
- Value to write.
- boolean|string $merge optional false
True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Throws
config() public deprecated ¶
config( string|array|null $key = null , mixed|null $value = null , boolean $merge = true )
Gets/Sets the config.
Usage
Reading the whole config:
$this->config();
Reading a specific value:
$this->config('key');
Reading a nested value:
$this->config('some.nested.key');
Setting a specific value:
$this->config('key', $value);
Setting a nested value:
$this->config('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->config(['one' => 'value', 'another' => 'value']);
Deprecated
Parameters
- string|array|null $key optional null
- The key to get/set, or a complete array of configs.
- mixed|null $value optional null
- The value to set.
- boolean $merge optional true
- Whether to recursively merge or overwrite existing config, defaults to true.
Returns
Config value being read, or the object itself on write operations.
Throws
configShallow() public ¶
configShallow( string|array $key , mixed|null $value = null )
Merge provided config with existing config. Unlike config() which does
a recursive merge for nested keys, this method does a simple merge.
Setting a specific value:
$this->configShallow('key', $value);
Setting a nested value:
$this->configShallow('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->configShallow(['one' => 'value', 'another' => 'value']);
Parameters
- string|array $key
- The key to set, or a complete array of configs.
- mixed|null $value optional null
- The value to set.
Returns
$this
getConfig() public ¶
getConfig( string|null $key = null , mixed $default = null )
Returns the config.
Usage
Reading the whole config:
$this->getConfig();
Reading a specific value:
$this->getConfig('key');
Reading a nested value:
$this->getConfig('some.nested.key');
Reading with default value:
$this->getConfig('some-key', 'default-value');
Parameters
- string|null $key optional null
- The key to get or null for the whole config.
- mixed $default optional null
- The return value when the key does not exist.
Returns
Configuration data at the named key or null if the key does not exist.
setConfig() public ¶
setConfig( string|array $key , mixed|null $value = null , boolean $merge = true )
Sets the config.
Usage
Setting a specific value:
$this->setConfig('key', $value);
Setting a nested value:
$this->setConfig('some.nested.key', $value);
Updating multiple config settings at the same time:
$this->setConfig(['one' => 'value', 'another' => 'value']);
Parameters
- string|array $key
- The key to set, or a complete array of configs.
- mixed|null $value optional null
- The value to set.
- boolean $merge optional true
- Whether to recursively merge or overwrite existing config, defaults to true.
Returns
$this
Throws
Properties detail
$_defaultConfig ¶
The default config used unless overridden by runtime configuration
compressWhether to compress datadurationSpecify how long items in this cache configuration last.groupsList of groups or 'tags' associated to every key stored in this config. handy for deleting a complete group from cache.usernameLogin to access the Memcache serverpasswordPassword to access the Memcache serverpersistentThe name of the persistent connection. All configurations using the same persistent value will share a single underlying connection.prefixPrepended to all entries. Good for when you need to share a keyspace with either another cache config or another application.probabilityProbability of hitting a cache gc cleanup. Setting to 0 will disable cache::gc from ever being called automatically.serializeThe serializer engine used to serialize data. Available engines are php, igbinary and json. Beside php, the memcached extension must be compiled with the appropriate serializer support.serversString or array of memcached servers. If an array MemcacheEngine will use them as a pool.options- Additional options for the memcached client. Should be an array of option => value. Use the \Memcached::OPT_* constants as keys.
[
'compress' => false,
'duration' => 3600,
'groups' => [],
'host' => null,
'username' => null,
'password' => null,
'persistent' => false,
'port' => null,
'prefix' => 'cake_',
'probability' => 100,
'serialize' => 'php',
'servers' => ['127.0.0.1'],
'options' => [],
]
$_serializers ¶
List of available serializer engines
Memcached must be compiled with json and igbinary support to use these engines
[]