CacheEngine (class)

clearsource abstract 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 )

Clears all values belonging to a group. Is up to the implementing engine to decide whether actually delete the keys or just simulate it to achieve the same result.

Parameters

string $group

name of the group to be cleared

Returns

boolean
bool

decrementsource abstract public

decrement( string $key , integer $offset 1 )

Decrement a number under the key and return decremented value

Parameters

string $key

Identifier for the data

integer $offset optional 1

How much to subtract

Returns

New
incremented value, false otherwise

deletesource abstract 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

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.

groupssource public

groups( )

Does whatever initialization for each group is required and returns the group value for each of them, this is the token representing each group in the cache key

Returns

array
array

incrementsource abstract public

increment( string $key , integer $offset 1 )

Increment a number under the key and return incremented value

Parameters

string $key

Identifier for the data

integer $offset optional 1

How much to add

Returns

New
incremented value, false otherwise

initsource public

init( array $settings array() )

Initialize the cache engine

Called automatically by the cache frontend

Parameters

array $settings optional array()

Associative array of parameters for the engine

Returns

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

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

readsource abstract 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

settingssource public

settings( )

Cache Engine settings

Returns

array
settings

writesource abstract public

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

Write value for a key into cache

Parameters

string $key

Identifier for the data

mixed $value

Data to be cached

integer $duration

How long to cache for.

Returns

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

null

array()