PHP Class CacheEngine

Show file Open project: sourcefabric/newscoop Class Usage Examples

Public Methods

Method Description
AvailableEngines ( $p_path = null ) : array Returns an array of available engines containing engine name -> info pairs.
Factory ( $p_engineName, $p_path = null ) : boolean Loads the engine specified by the given name.
addValue ( $p_key, $p_value, $p_ttl ) : boolean Inserts the value identified by the given key in the cache.
clearPages ( ) : void Deletes the pages stored in the cache.
clearValues ( ) : void Deletes the values stored in the cache.
deletePage ( $p_key ) : void Delete the page identified by the given key from the cache.
deleteValue ( $p_key ) : void Delete the value identified by the given key from the cache.
description ( ) : string Returns a short description of the cache engine.
fetchValue ( $p_key ) : mixed Fetches the value identified by the given key from the cache.
garbageCollector ( ) : void Deletes the expired values and pages stored in the cache.
getInfo ( $p_type = self::CACHE_VALUES_INFO ) : array Returns an array of cached data; false if invalid type.
getMemInfo ( ) : array Returns an array of shared memory data
getName ( )
hasValueKey ( $p_key ) : mixed Returns true if a value identified by the given key was stored in the cache.
isSupported ( ) : boolean Returns true if the engine was supported in PHP, false otherwise.
pageCachingSupported ( ) : boolean Returns true if the page caching was supported, false otherwise.
storePage ( $p_key, $p_value, $p_ttl ) : boolean Stores the current page under the given key (identifier).
storeValue ( $p_key, $p_value, $p_ttl ) : boolean Stores the value identified by the given key in the cache.

Method Details

AvailableEngines() public static method

Returns an array of available engines containing engine name -> info pairs.
public static AvailableEngines ( $p_path = null ) : array
$p_path
return array

Factory() public static method

Loads the engine specified by the given name.
public static Factory ( $p_engineName, $p_path = null ) : boolean
$p_engineName
return boolean

addValue() abstract public method

Returns false if the key already existed and does not overwrite the existing key.
abstract public addValue ( $p_key, $p_value, $p_ttl ) : boolean
$p_key
$p_value
return boolean

clearPages() abstract public method

Deletes the pages stored in the cache.
abstract public clearPages ( ) : void
return void

clearValues() abstract public method

Deletes the values stored in the cache.
abstract public clearValues ( ) : void
return void

deletePage() abstract public method

Delete the page identified by the given key from the cache.
abstract public deletePage ( $p_key ) : void
return void

deleteValue() abstract public method

Delete the value identified by the given key from the cache.
abstract public deleteValue ( $p_key ) : void
return void

description() abstract public method

Returns a short description of the cache engine.
abstract public description ( ) : string
return string

fetchValue() abstract public method

Fetches the value identified by the given key from the cache.
abstract public fetchValue ( $p_key ) : mixed
return mixed

garbageCollector() abstract public method

Deletes the expired values and pages stored in the cache.
abstract public garbageCollector ( ) : void
return void

getInfo() abstract public method

Returns an array of cached data; false if invalid type.
abstract public getInfo ( $p_type = self::CACHE_VALUES_INFO ) : array
$p_type
return array

getMemInfo() abstract public method

Returns an array of shared memory data
abstract public getMemInfo ( ) : array
return array

getName() abstract public method

abstract public getName ( )

hasValueKey() abstract public method

Returns true if a value identified by the given key was stored in the cache.
abstract public hasValueKey ( $p_key ) : mixed
return mixed

isSupported() abstract public method

Returns true if the engine was supported in PHP, false otherwise.
abstract public isSupported ( ) : boolean
return boolean

pageCachingSupported() abstract public method

Returns true if the page caching was supported, false otherwise.
abstract public pageCachingSupported ( ) : boolean
return boolean

storePage() abstract public method

Returns true on success, false on failure.
abstract public storePage ( $p_key, $p_value, $p_ttl ) : boolean
$p_key
$p_value
return boolean

storeValue() abstract public method

Returns true on success, false on failure.
abstract public storeValue ( $p_key, $p_value, $p_ttl ) : boolean
$p_key
$p_value
return boolean