MemcacheEngine Class Reference

Inheritance diagram for MemcacheEngine:

CacheEngine Object

List of all members.


Public Member Functions

 clear ()
 connect ($host, $port=11211)
 delete ($key)
 init ($settings=array())
 read ($key)
 write ($key, &$value, $duration)

Public Attributes

 $settings = array()

Detailed Description

Definition at line 34 of file memcache.php.

Member Function Documentation

MemcacheEngine::clear (  ) 

Delete all keys from the cache

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

Definition at line 131 of file memcache.php.

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

Connects to a server in connection pool

Parameters:
string $host host ip address or name
integer $port Server port
Returns:
boolean True if memcache server was connected public

Definition at line 142 of file memcache.php.

MemcacheEngine::delete ( $  key  ) 

Delete a key from the cache

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

Reimplemented from CacheEngine.

Definition at line 122 of file memcache.php.

MemcacheEngine::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 $setting array of setting for the engine
Returns:
boolean True if the engine has been successfully initialized, false if not public

Reimplemented from CacheEngine.

Definition at line 61 of file memcache.php.

References $settings, CacheEngine::settings(), and Inflector::slug().

MemcacheEngine::read ( $  key  ) 

Read a key from the cache

Parameters:
string $key Identifier 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

Reimplemented from CacheEngine.

Definition at line 112 of file memcache.php.

MemcacheEngine::write ( $  key,
&$  value,
$  duration 
)

Write data for key into cache

Parameters:
string $key Identifier for the data
mixed $value Data to be cached
integer $duration How long to cache the data, in seconds
Returns:
boolean True if the data was succesfully cached, false on failure public

Reimplemented from CacheEngine.

Definition at line 102 of file memcache.php.

References CacheEngine::settings().

Member Data Documentation

MemcacheEngine::$settings = array()

Reimplemented from CacheEngine.

Definition at line 50 of file memcache.php.

Referenced by init().

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