Class RedisEngine

Redis storage engine for cache.

CacheEngine
Extended by RedisEngine
Package: Cake\Cache\Engine
Copyright: Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
License: MIT License
Located at Cake/Cache/Engine/RedisEngine.php

Method Detail

__destructsource public

__destruct( )

Disconnects from the redis server

_connectsource protected

_connect( )

Connects to a Redis server

Returns

boolean
True if Redis server was connected

clearsource public

clear( boolean $check )

Delete all keys from the cache

Parameters

boolean $check
Whether or not expiration keys should be checked. If true, no keys will be removed as cache will rely on redis TTL's.

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 name to clear.

Returns

boolean
success

Overrides

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

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.

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

Methods inherited from CacheEngine

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

Properties summary

$_Redissource

protected Redis

Redis wrapper.

null

$settingssource

public array

Settings

  • server = string URL or ip to the Redis server host - database = integer database number to use for connection - port = integer port number to the Redis server (default: 6379) - timeout = float timeout in seconds (default: 0) - persistent = boolean Connects to the Redis server with a persistent connection (default: true) - unix_socket = path to the unix socket file (default: false)
array()

Properties inherited from CacheEngine

$_groupPrefixsource

protected string

Contains the compiled string with all groups prefixes to be prepended to every key in this cache engine

null

© 2005–2016 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.
http://api.cakephp.org/2.7/class-RedisEngine.html