PHP Class Prado\Caching\TXCache

TXCache implements a cache application module based on {@link http://xcache.lighttpd.net/ xcache}. By definition, cache does not ensure the existence of a value even if it never expires. Cache is not meant to be an persistent storage. To use this module, the xcache PHP extension must be loaded and configured in the php.ini. Some usage examples of TXCache are as follows,


$cache=new TXCache;  // TXCache may also be loaded as a Prado application module
$cache->init(null);
$cache->add('object',$object);
$object2=$cache->get('object');

If loaded, TXCache will register itself with {@link TApplication} as the cache module. It can be accessed via {@link TApplication::getCache()}. TXCache may be configured in application configuration file as follows

Since: 3.1.1

Inheritance: extends TCache

Mostrar archivo Open project: pradosoft/prado

Public Methods

Method	Description
flush ( )	Deletes all values from cache.
init ( $config )	Initializes this module.

Protected Methods

Method	Description
addValue ( $key, $value, $expire ) : boolean	Stores a value identified by a key into cache if the cache does not contain this key.
deleteValue ( $key ) : boolean	Deletes a value with the specified key from cache This is the implementation of the method declared in the parent class.
getValue ( $key ) : string	Retrieves a value from cache with a specified key.
setValue ( $key, $value, $expire ) : boolean	Stores a value identified by a key in cache.

Method Details

addValue() protected method

This is the implementation of the method declared in the parent class.

protected addValue ( $key, $value, $expire ) : boolean
return	boolean	true if the value is successfully stored into cache, false otherwise

deleteValue() protected method

Deletes a value with the specified key from cache This is the implementation of the method declared in the parent class.

protected deleteValue ( $key ) : boolean
return	boolean	if no error happens during deletion

flush() public method

Be careful of performing this operation if the cache is shared by multiple applications.

public flush ( )

getValue() protected method

This is the implementation of the method declared in the parent class.

protected getValue ( $key ) : string
return	string	the value stored in cache, false if the value is not in the cache or expired.

init() public method

This method is required by the IModule interface.

public init ( $config )

setValue() protected method

This is the implementation of the method declared in the parent class.

protected setValue ( $key, $value, $expire ) : boolean
return	boolean	true if the value is successfully stored into cache, false otherwise