MemcachedEngine (class)

_parseServerStringsource 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
Array containing host, port

_setOptionssource protected

_setOptions( )

Settings the memcached instance

Throws

InvalidArgumentException
When the Memcached extension is not built with the desired serializer engine.

addsource 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

boolean
True if the data was successfully cached, false on failure.

Overrides

Cake\Cache\CacheEngine::add()

clearsource public

clear( boolean $check )

Delete all keys from the cache

Parameters

boolean $check

If true will check expiration, otherwise delete all.

Returns

boolean
True if the cache was successfully cleared, false otherwise

clearGroupsource 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

boolean
success

Overrides

Cake\Cache\CacheEngine::clearGroup()

decrementsource 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|integer
New decremented value, false otherwise

deletesource public

delete( string $key )

Delete a key from the cache

Parameters

string $key

Identifier for the data

Returns

boolean
True if the value was successfully deleted, false if it didn't exist or couldn't be removed.

deleteManysource public

deleteMany( array $keys )

Delete many keys from the cache at once

Parameters

array $keys

An array of identifiers for the data

Returns

array
of 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()

groupssource 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

array
array

Overrides

Cake\Cache\CacheEngine::groups()

incrementsource 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|integer
New incremented value, false otherwise

initsource 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

boolean
True if the engine has been successfully initialized, false if not

Throws

InvalidArgumentException
When you try use authentication without Memcached compiled with SASL support

Overrides

Cake\Cache\CacheEngine::init()

readsource public

read( string $key )

Read a key from the cache

Parameters

string $key

Identifier for the data

Returns

mixed
The cached data, or false if the data doesn't exist, has expired, or if there was an error fetching it.

readManysource public

readMany( array $keys )

Read many keys from the cache at once

Parameters

array $keys

An array of identifiers for the data

Returns

array
An 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()

writesource 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

boolean
True if the data was successfully cached, false on failure

See

http://php.net/manual/en/memcache.set.php

writeManysource 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

array
of bools for each key provided, true if the data was successfully cached, false on failure

Overrides

Cake\Cache\CacheEngine::writeMany()

_keysource protected

_key( string $key )

Generates a safe key, taking account of the configured key prefix

Parameters

string $key

the key passed over

Returns

mixed
string $key or false

Throws

InvalidArgumentException
If key's value is empty

gcsource 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.

keysource public

key( string $key )

Generates a safe key for use with cache engine storage engines.

Parameters

string $key

the key passed over

Returns

boolean|string
string key or false

_configDeletesource protected

_configDelete( string $key )

Delete a single config key

Parameters

string $key

Key to delete.

Throws

Cake\Core\Exception\Exception
if attempting to clobber existing config

_configReadsource protected

_configRead( string|null $key )

Read a config variable

Parameters

string|null $key

Key to read.

Returns

mixed
mixed

_configWritesource protected

_configWrite( string|array $key , mixed $value , boolean|string $merge false )

Write a config variable

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

configsource public

config( string|array|null $key null , mixed|null $value null , boolean $merge true )

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']);

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

mixed
Config value being read, or the object itself on write operations.

Throws

Cake\Core\Exception\Exception
When trying to set a key that is invalid.

configShallowsource 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

mixed
$this The object itself.

null

[
    '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' => [],
]

[]

null

[]

false