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

Public Member Functions

 clear ()
 
 connect ($host, $port=11211)
 
 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)
 

Public Attributes

 $memcache = null
 
 $settings = array()
 
- Public Attributes inherited from XoopsCacheEngine
 $settings
 

Detailed Description

Definition at line 54 of file memcache.php.

Member Function Documentation

XoopsCacheMemcache::clear ( )

Delete all keys from the cache

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

Definition at line 157 of file memcache.php.

XoopsCacheMemcache::connect (   $host,
  $port = 11211 
)

Connects to a server in connection pool

Parameters
string$hosthost ip address or name
integer$portServer port
Returns
boolean True if memcache server was connected public

Definition at line 169 of file memcache.php.

XoopsCacheMemcache::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 147 of file memcache.php.

XoopsCacheMemcache::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 public

Definition at line 82 of file memcache.php.

XoopsCacheMemcache::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 136 of file memcache.php.

XoopsCacheMemcache::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 125 of file memcache.php.

Member Data Documentation

XoopsCacheMemcache::$memcache = null

Definition at line 62 of file memcache.php.

XoopsCacheMemcache::$settings = array()

Definition at line 71 of file memcache.php.


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