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 igbibnary serialization (if memcached extension compiled with --enable-igbinary) Compressed keys can also be incremented/decremented
- CacheEngine
-
MemcachedEngine
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Location: Cake/Cache/Engine/MemcachedEngine.php
Properties summary
-
$_MemcachedprotectedMemcachememcached wrapper. -
$_serializersprotectedarrayList of available serializer engines -
$settingspublicarraySettings
Inherited Properties
Method Summary
-
_parseServerString() protected
Parses the server address into the host/port. Handles both IPv6 and IPv4 addresses and Unix sockets
-
_setOptions() protected
Settings the memcached instance -
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 -
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 -
read() public
Read a key from the cache -
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.
Method Detail
_parseServerString() 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
Array containing host, port
clear() public ¶
clear( boolean $check )
Delete all keys from the cache
Parameters
- boolean $check
If true no deletes will occur and instead CakePHP will rely on key TTL values.
Returns
True if the cache was successfully cleared, false otherwise. Will also return false if you are using a binary protocol.
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
- The group to clear.
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
decremented value, false otherwise
Throws
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
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
incremented value, false otherwise
Throws
init() public ¶
init( array $settings = array() )
Initialize the Cache Engine
Called automatically by the cache frontend To reinitialize the settings call Cache::engine('EngineName', [optional] settings = array());
Parameters
- array $settings optional array()
- array of setting for the engine
Returns
True if the engine has been successfully initialized, false if not
Throws
Overrides
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
write() public ¶
write( string $key , mixed $value , integer $duration )
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
- integer $duration
- How long to cache the data, in seconds
Returns
True if the data was successfully cached, false on failure
See
Methods inherited from CacheEngine
gc() public ¶
gc( integer $expires = null )
Garbage collection
Permanently remove all expired and deleted data
Parameters
- integer $expires optional null
- [optional] An expires timestamp, invalidating all data before.
Properties detail
$_serializers ¶
List of available serializer engines
Memcached must be compiled with json and igbinary support to use these engines
array( 'igbinary' => Memcached::SERIALIZER_IGBINARY, 'json' => Memcached::SERIALIZER_JSON, 'php' => Memcached::SERIALIZER_PHP )
$settings ¶
Settings
- servers = string or array of memcached servers, default => 127.0.0.1. If an
array MemcacheEngine will use them as a pool.
- compress = boolean, default => false
- persistent = string The name of the persistent connection. All configurations using the same persistent value will share a single underlying connection.
- serialize = string, default => php. 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.
- options - Additional options for the memcached client. Should be an array of option => value. Use the Memcached::OPT_* constants as keys.
array()