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.
string
'key'
string
'value'
\Memcached
memcached wrapper.
string[]
array
Runtime config
bool
Whether the config property has already been configured with defaults
array
The default config used unless overridden by runtime configuration
string
Contains the compiled string with all group prefixes to be prepended to every key in this cache engine
array
List of available serializer engines
Increments the group value to simulate deletion of all keys under a group old values will remain in storage until they expire.
Merge provided config with existing config. Unlike config()
which does a recursive merge for nested keys, this method does a simple merge.
Returns the group value
for each of the configured groups If the group initial value was not found, then it initializes the group accordingly.
Parses the server address into the host/port. Handles both IPv6 and IPv4 addresses and Unix sockets
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 real Unix time value rather than an offset from current time.
Cache Engines may trigger warnings if they encounter failures during operation, if option warnOnWriteFailures is set to true.
_configDelete(string $key)
Deletes a single config key.
string
$key Key to delete.
Cake\Core\Exception\Exception
_configRead(?string $key)
Reads a config key.
string|null
$key Key to read.
mixed
_configWrite(mixed $key, mixed $value, mixed $merge)
Writes a config key.
string|array
$key Key to write to.
mixed
$value Value to write.
bool|string
$merge optional True to merge recursively, 'shallow' for simple merge, false to overwrite, defaults to false.
Cake\Core\Exception\Exception
_key(mixed $key)
Generates a key for cache backend usage.
If the requested key is valid, the group prefix value and engine prefix are applied. Whitespace in keys will be replaced.
string
$key the key passed over
string
Prefixed key with potentially unsafe characters replaced.
Cake\Cache\InvalidArgumentException
_setOptions()
Settings the memcached instance
InvalidArgumentException
add(string $key, mixed $value)
Add a key to the cache if it does not already exist.
string
$key Identifier for the data.
mixed
$value Data to be cached.
bool
True if the data was successfully cached, false on failure.
clear()
Delete all keys from the cache
bool
True if the cache was successfully cleared, false otherwise
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.
string
$group name of the group to be cleared
bool
success
configShallow(mixed $key, mixed $value)
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']);
string|array
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
$this
decrement(string $key, int $offset)
Decrements the value of an integer cached key
string
$key Identifier for the data
int
$offset optional How much to subtract
int|false
New decremented value, false otherwise
delete(mixed $key)
Delete a key from the cache
string
$key Identifier for the data
bool
True if the value was successfully deleted, false if it didn't exist or couldn't be removed.
deleteMultiple(mixed $keys)
Delete many keys from the cache at once
iterable
$keys An array of identifiers for the data
bool
of boolean values that are true if the key was successfully deleted, false if it didn't exist or couldn't be removed.
duration(mixed $ttl)
Convert the various expressions of a TTL value into duration in seconds
\DateInterval|int|null
$ttl The TTL value of this item. If null is sent, the driver's default duration will be used.
int
ensureValidKey(mixed $key)
Ensure the validity of the given cache key.
string
$key Key to check.
Cake\Cache\InvalidArgumentException
ensureValidType(mixed $iterable, string $check)
Ensure the validity of the argument type and cache keys.
iterable
$iterable The iterable to check.
string
$check optional Whether to check keys or values.
Cake\Cache\InvalidArgumentException
get(mixed $key, mixed $default)
Read a key from the cache
string
$key Identifier for the data
mixed
$default optional Default value to return if the key does not exist.
mixed
The cached data, or default value if the data doesn't exist, has expired, or if there was an error fetching it.
getConfig(?string $key, mixed $default)
Returns the config.
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');
string|null
$key optional The key to get or null for the whole config.
mixed
$default optional The return value when the key does not exist.
mixed
Configuration data at the named key or null if the key does not exist.
getConfigOrFail(string $key)
Returns the config for this specific key.
The config value for this key must exist, it can never be null.
string
$key The key to get.
mixed
Configuration data at the named key
InvalidArgumentException
getMultiple(mixed $keys, mixed $default)
Read many keys from the cache at once
iterable
$keys An array of identifiers for the data
mixed
$default optional Default value to return for keys that do not exist.
array
An array containing, for each of the given $keys, the cached data or false if cached data could not be retrieved.
getOption(int $name)
Read an option value from the memcached connection.
int
$name The option name to read.
string|int|bool|null
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.
string[]
has(mixed $key)
Determines whether an item is present in the cache.
NOTE: It is recommended that has() is only to be used for cache warming type purposes and not to be used within your live applications operations for get/set, as this method is subject to a race condition where your has() will return true and immediately after, another script can remove it making the state of your app out of date.
string
$key The cache item key.
bool
Cake\Cache\InvalidArgumentException
increment(string $key, int $offset)
Increments the value of an integer cached key
string
$key Identifier for the data
int
$offset optional How much to increment
int|false
New incremented value, false otherwise
init(array $config)
Initialize the Cache Engine
Called automatically by the cache frontend
array
$config optional array of setting for the engine
bool
True if the engine has been successfully initialized, false if not
InvalidArgumentException
parseServerString(string $server)
Parses the server address into the host/port. Handles both IPv6 and IPv4 addresses and Unix sockets
string
$server The server address string.
array
Array containing host, port
set(mixed $key, mixed $value, mixed $ttl)
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 real Unix time value rather than an offset from current time.
string
$key Identifier for the data
mixed
$value Data to be cached
\DateInterval|int|null
$ttl optional Optional. The TTL value of this item. If no value is sent and the driver supports TTL then the library may set a default value for it or let the driver take care of that.
bool
True if the data was successfully cached, false on failure
setConfig(mixed $key, mixed $value, mixed $merge)
Sets the config.
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']);
string|array
$key The key to set, or a complete array of configs.
mixed|null
$value optional The value to set.
bool
$merge optional Whether to recursively merge or overwrite existing config, defaults to true.
$this
Cake\Core\Exception\Exception
setMultiple(mixed $values, mixed $ttl)
Write many cache entries to the cache at once
iterable
$values An array of data to be stored in the cache
\DateInterval|int|null
$ttl optional Optional. The TTL value of this item. If no value is sent and the driver supports TTL then the library may set a default value for it or let the driver take care of that.
bool
Whether the write was successful or not.
warning(string $message)
Cache Engines may trigger warnings if they encounter failures during operation, if option warnOnWriteFailures is set to true.
string
$message The warning message.
memcached wrapper.
\Memcached
string[]
Runtime config
array
Whether the config property has already been configured with defaults
bool
The default config used unless overridden by runtime configuration
compress
Whether to compress dataduration
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 serverpassword
Password to access the Memcache serverpersistent
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.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.array
Contains the compiled string with all group prefixes to be prepended to every key in this cache engine
string
List of available serializer engines
Memcached must be compiled with JSON and igbinary support to use these engines
array
© 2005–present 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/4.1/class-Cake.Cache.Engine.MemcachedEngine.html