XOOPS 2.5.6  Final
 All Classes Namespaces Files Functions Variables Pages
XoopsCacheApc Class Reference
Inheritance diagram for XoopsCacheApc:
Inheritance graph

Public Member Functions

 clear ()
 
 delete ($key)
 
 init ($settings=array())
 
 read ($key)
 
 write ($key, &$value, $duration)
 
- Public Member Functions inherited from XoopsCacheEngine
 clear ($check)
 
 delete ($key)
 
 gc ()
 
 init ($settings=array())
 
 read ($key)
 
 settings ()
 
 write ($key, $value=null, $duration=null)
 

Additional Inherited Members

- Public Attributes inherited from XoopsCacheEngine
 $settings
 

Detailed Description

Definition at line 54 of file apc.php.

Member Function Documentation

XoopsCacheApc::clear ( )

Delete all keys from the cache

Returns
boolean True if the cache was succesfully cleared, false otherwise public

Definition at line 117 of file apc.php.

XoopsCacheApc::delete (   $key)

Delete a key from the cache

Parameters
string$keyIdentifier for the data
Returns
boolean True if the value was succesfully deleted, false if it didn't exist or couldn't be removed public

Definition at line 106 of file apc.php.

XoopsCacheApc::init (   $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$settingarray of setting for the engine
Returns
boolean True if the engine has been successfully initialized, false if not
See Also
CacheEngine::__defaults public

Definition at line 67 of file apc.php.

XoopsCacheApc::read (   $key)

Read a key from the cache

Parameters
string$keyIdentifier 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 public

Definition at line 94 of file apc.php.

XoopsCacheApc::write (   $key,
$value,
  $duration 
)

Write data for key into cache

Parameters
string$keyIdentifier for the data
mixed$valueData to be cached
integer$durationHow long to cache the data, in seconds
Returns
boolean True if the data was succesfully cached, false on failure public

Definition at line 82 of file apc.php.


The documentation for this class was generated from the following file: