Class MemcacheEngine

_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

clearsource 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

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

The group to clear.

Returns

boolean
success

Overrides

CacheEngine::clearGroup()

connectsource public

connect( string $host , integer $port 11211 )

Connects to a server in connection pool

Parameters

string $host

host ip address or name

integer $port optional 11211

Server port

Returns

boolean
True if memcache server was connected

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

New
decremented value, false otherwise

Throws

CacheException
when you try to decrement with compress = true

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

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

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

New
incremented value, false otherwise

Throws

CacheException
when you try to increment with compress = true

initsource 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

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

Overrides

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

writesource public

write( string $key , mixed $value , integer $duration )

Write data for key into cache. When using memcache as your cache engine remember that the Memcache 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

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

See

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

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

keysource public

key( string $key )

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

Parameters

string $key

the key passed over

Returns

mixed
string $key or false

settingssource public

settings( )

Cache Engine settings

Returns

array
settings

null

array()

array()

null