DStruct PHP Framework
Back to top  

Singleton class wrapping APC caching.

see \global\DStructCacheInterface
package dstruct_common

 Methods

Add to cache.

add(string $key, mixed $var, integer $expire) : boolean
see \DStructCacheInterface::add()

Parameters

$key

string

$var

mixed

$expire

integer

Time the data is valid for in seconds

Returns

booleanTRUE if value was actually added, FALSE if otherwise

Delete from cache.

delete(string $key) : boolean
see \DStructCacheInterface::delete()

Parameters

$key

string

Returns

boolean

Fetch from cache.

get(string $key) : mixed
see \DStructCacheInterface::get()

Parameters

$key

string

Returns

mixed

Get an instance of this Singleton class.

getInstance() : object
Static

Objects are singletons and so use this method to get an instance. If you impliment this interface, it is recommended that you declare the __constructor() as protected

see \DStructCacheInterface::getInstance()
todo rewrite to handle pools

Returns

object

Cache is available.

hasServer() : boolean

Is the cache server this object uses available to be used by the system

Returns

boolean

Cache hits.

hits() : integer

Not persistent. Counts the number of times this cache object has been queried and returned existing data. Please check the documentation for each classes implimentation of this method, as the functionallity may vary across classes.

see \DStructCacheInterface::hits()

Returns

integer

Cache misses.

misses() : integer

Not persistent. Counts the number of times this cache object has been queried but had no data for that key. Please check the documentation for each classes implimentation of this method, as the functionallity may vary across classes.

see \DStructCacheInterface::misses()

Returns

integer

Add to the cache, overwriting if the key already exists.

set(string $key, mixed $var, integer $expire) : boolean

Default expiration is one week (604800).

see \DStructCacheInterface::set()

Parameters

$key

string

$var

mixed

$expire

integer

Time the data is valid for in seconds

Returns

booleanTRUE if value was actually added, FALSE if otherwise

Cache writes.

writes() 

Not persistent. Counts the number of times this cache object has been written to. Please check the documentation for each classes implimentation of this method, as the functionallity may vary across classes.

see \DStructCacheInterface::writes()

Class constructor Object is singleton.

__construct() 

Creating instance of class checks whether APC is available or not: APCCache::hasServer()

 Properties

 

$failedwrites : integer
 

$hasserver : boolean
see \DStructCacheInterface::hasServer()
 

$hits : integer
see \DStructCacheInterface::hits()
 

$instance : mixed
 

$misses : integer
see \DStructCacheInterface::misses()
 

$writes : integer
see \DStructCacheInterface::writes()