Provides consistant caching interface.
Cache objects can extend this interface and be used by the system or by users in their scripts. Objects should be Singletons
| author | David Lidstone |
|---|---|
| package | dstruct_common |
add(string $key, mixed $var, integer $expire) : boolean
string
mixed
integerTime the data is valid for in seconds
booleanTRUE if value was actually added, FALSE if otherwisedelete(string $key) : boolean
string
booleanget(string $key) : mixed
string
mixedgetInstance() : object
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
objecthasServer() : boolean
Is the cache server this object uses available to be used by the system
booleanhits() : 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.
integermisses()
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.
set(string $key, mixed $var, integer $expire) : boolean
string
mixed
integerTime the data is valid for in seconds
booleanTRUE if value was actually added, FALSE if otherwisewrites()
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.