Class FileEngine

_activesource protected

_active( )

Determine is cache directory is writable

Returns

boolean
bool

_clearDirectorysource protected

_clearDirectory( string $path , integer $now , integer $threshold )

Used to clear a directory of matching files.

Parameters

string $path

The path to search.

integer $now

The current timestamp

integer $threshold

Any file not modified after this value will be deleted.

_setKeysource protected

_setKey( string $key , boolean $createKey false )

Sets the current cache key this class is managing, and creates a writable SplFileObject for the cache file the key is referring to.

Parameters

string $key

The key

boolean $createKey optional false

Whether the key should be created if it doesn't exists, or not

Returns

boolean
true if the cache key could be set, false otherwise

clearsource public

clear( boolean $check )

Delete all values from the cache

Parameters

boolean $check

Optional - only delete expired cache items

Returns

boolean
True if the cache was successfully cleared, false otherwise

clearGroupsource public

clearGroup( string $group )

Recursively deletes all files under any directory named as $group

Parameters

string $group

The group to clear.

Returns

boolean
success

Overrides

CacheEngine::clearGroup()

decrementsource public

decrement( string $key , integer $offset 1 )

Not implemented

Parameters

string $key

The key to decrement

integer $offset optional 1

The number to offset

Throws

CacheException
CacheException

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

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.

Returns

boolean
True if garbage collection was successful, false on failure

Overrides

CacheEngine::gc()

incrementsource public

increment( string $key , integer $offset 1 )

Not implemented

Parameters

string $key

The key to decrement

integer $offset optional 1

The number to offset

Throws

CacheException
CacheException

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

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

Overrides

CacheEngine::key()

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 $data , integer $duration )

Write data for key into cache

Parameters

string $key

Identifier for the data

mixed $data

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

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

settingssource public

settings( )

Cache Engine settings

Returns

array
settings

null

true

array()

null