MemcachedEngine (class)
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.
Main advantage of this Memcached engine over the memcached engine is support of binary protocol, and igbinary serialization (if memcached extension compiled with --enable-igbinary) Compressed keys can also be incremented/decremented
- Cake\Cache\CacheEngine uses Cake\Core\InstanceConfigTrait
-
Cake\Cache\Engine\MemcachedEngine
Properties summary
-
$_Memcached
protectedmemcached wrapper.Memcached
-
$_compiledGroupNames
protectedstring[]
-
$_defaultConfig
protectedThe default config used unless overridden by runtime configurationarray
-
$_serializers
protectedList of available serializer enginesarray
Inherited Properties
Method Summary
- _parseServerString() protected
Parses the server address into the host/port. Handles both IPv6 and IPv4 addresses and Unix sockets
- _setOptions() protectedSettings the memcached instance
- add() publicAdd a key to the cache if it does not already exist.
- clear() publicDelete 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() publicDecrements the value of an integer cached key
- delete() publicDelete a key from the cache
- deleteMany() publicDelete many keys from the cache at once
- groups() public
Returns the
group value
for each of the configured groups If the group initial value was not found, then it initializes the group accordingly. - increment() publicIncrements the value of an integer cached key
- init() publicInitialize the Cache Engine
- read() publicRead a key from the cache
- readMany() publicRead 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() publicWrite many cache entries to the cache at once
Method Detail
_parseServerString()source protected
_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
arrayArray containing host, port
_setOptions()source protected
_setOptions( )
Settings the memcached instance
Throws
InvalidArgumentExceptionWhen the Memcached extension is not built with the desired serializer engine.
add()source 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
booleanTrue if the data was successfully cached, false on failure.
Overrides
Cake\Cache\CacheEngine::add()
clear()source public
clear( boolean $check )
Delete all keys from the cache
Parameters
- boolean
$check
- If true will check expiration, otherwise delete all.
Returns
booleanTrue if the cache was successfully cleared, false otherwise
clearGroup()source 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
booleansuccess
Overrides
Cake\Cache\CacheEngine::clearGroup()
decrement()source 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
boolean|integerNew decremented value, false otherwise
delete()source public
delete( string $key )
Delete a key from the cache
Parameters
- string
$key
- Identifier for the data
Returns
booleanTrue if the value was successfully deleted, false if it didn't exist or couldn't be removed.
deleteMany()source public
deleteMany( array $keys )
Delete many keys from the cache at once
Parameters
- array
$keys
- An array of identifiers for the data
Returns
arrayof boolean values that are true if the key was successfully deleted, false if it didn't exist or couldn't be removed.
Overrides
Cake\Cache\CacheEngine::deleteMany()
groups()source 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
arrayOverrides
Cake\Cache\CacheEngine::groups()
increment()source 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
boolean|integerNew incremented value, false otherwise
init()source 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
booleanTrue if the engine has been successfully initialized, false if not
Throws
InvalidArgumentExceptionWhen you try use authentication without Memcached compiled with SASL support
Overrides
Cake\Cache\CacheEngine::init()
read()source public
read( string $key )
Read a key from the cache
Parameters
- string
$key
- Identifier for the data
Returns
mixedThe cached data, or false if the data doesn't exist, has expired, or if there was an error fetching it.
readMany()source public
readMany( array $keys )
Read many keys from the cache at once
Parameters
- array
$keys
- An array of identifiers for the data
Returns
arrayAn array containing, for each of the given $keys, the cached data or false if cached data could not be retrieved.
Overrides
Cake\Cache\CacheEngine::readMany()
write()source 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
booleanTrue if the data was successfully cached, false on failure
See
http://php.net/manual/en/memcache.set.phpwriteMany()source 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
arrayof bools for each key provided, true if the data was successfully cached, false on failure
Overrides
Cake\Cache\CacheEngine::writeMany()
Methods inherited from Cake\Cache\CacheEngine
_key()source protected
_key( string $key )
Generates a safe key, taking account of the configured key prefix
Parameters
- string
$key
- the key passed over
Returns
mixedstring $key or false
Throws
InvalidArgumentExceptionIf key's value is empty
gc()source 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.
key()source public
key( string $key )
Generates a safe key for use with cache engine storage engines.
Parameters
- string
$key
- the key passed over
Returns
boolean|stringstring key or false
Methods used from Cake\Core\InstanceConfigTrait
_configDelete()source protected
_configDelete( string $key )
Deletes a single config key.
Parameters
- string
$key
- Key to delete.
Throws
Cake\Core\Exception\Exception
if attempting to clobber existing config
_configRead()source protected
_configRead( string|null $key )
Reads a config key.
Parameters
- string|null
$key
- Key to read.
Returns
mixed_configWrite()source 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
Cake\Core\Exception\Exception
if attempting to clobber existing config
config()source public
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
3.4.0 use setConfig()/getConfig() instead.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
mixedConfig value being read, or the object itself on write operations.
Throws
Cake\Core\Exception\Exception
When trying to set a key that is invalid.
configShallow()source 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->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']);
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()source public
getConfig( string|null $key 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');
Parameters
- string|null
$key
optional null - The key to get or null for the whole config.
Returns
mixedConfig value being read.
setConfig()source 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
Cake\Core\Exception\Exception
When trying to set a key that is invalid.
Properties detail
$_defaultConfigsource
protected array
The default config used unless overridden by runtime configuration
-
compress
Whether to compress data -
duration
Specify how long items in this cache configuration last. -
groups
List of groups or 'tags' associated to every key stored in this config. handy for deleting a complete group from cache. -
username
Login to access the Memcache server -
password
Password to access the Memcache server -
persistent
The name of the persistent connection. All configurations using the same persistent value will share a single underlying connection. -
prefix
Prepended to all entries. Good for when you need to share a keyspace with either another cache config or another application. -
probability
Probability of hitting a cache gc cleanup. Setting to 0 will disable cache::gc from ever being called automatically. -
serialize
The 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. -
servers
String 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' => [], ]
$_serializerssource
protected array
List of available serializer engines
Memcached must be compiled with json and igbinary support to use these engines
[]
© 2005–2017 The Cake Software Foundation, Inc.
Licensed under the MIT License.
CakePHP is a registered trademark of Cake Software Foundation, Inc.
We are not endorsed by or affiliated with CakePHP.
https://api.cakephp.org/3.4/class-Cake.Cache.Engine.MemcachedEngine.html