• Home
  • CacheEngine_APC

PHP Class CacheEngine_APC

Inheritance: extends CacheEngine
Show file Open project: sourcefabric/newscoop

Public Methods

Method Description
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 ( ) : boolean 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 ) : boolean 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

addValue() public method

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

clearPages() public method

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

clearValues() public method

Returns true on success, false on failure.
public clearValues ( ) : boolean
return boolean

deletePage() public method

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

deleteValue() public method

Returns true on success, false on failure.
public deleteValue ( $p_key ) : boolean
return boolean

description() public method

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

fetchValue() public method

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

garbageCollector() public method

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

getInfo() public method

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

getMemInfo() public method

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

getName() public method

public getName ( )

hasValueKey() public method

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

isSupported() public method

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

pageCachingSupported() public method

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

storePage() public method

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

storeValue() public method

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