Class ApcEngine

clearsource public

clear( boolean $check )

Delete all keys from the cache. This will clear every cache config using APC.

Parameters

boolean $check

If true, nothing will be cleared, as entries are removed from APC as they expired. This flag is really only used by FileEngine.

Returns

boolean
True Returns true.

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

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

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

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

See

CacheEngine::__defaults

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

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

array()

null

array()