[ Index ]
 

Code source de PRADO 3.0.6

Accédez au Source d'autres logiciels libresSoutenez Angelica Josefina !

title

Body

[fermer]

/framework/Caching/ -> TMemCache.php (sommaire)

TMemCache class file

Author: Qiang Xue <qiang.xue@gmail.com>
Copyright: Copyright © 2005 PradoSoft
License: http://www.pradosoft.com/license/
Version: $Id: TMemCache.php 1397 2006-09-07 07:55:53Z wei $
Poids: 219 lignes (7 kb)
Inclus ou requis:0 fois
Référencé: 0 fois
Nécessite: 0 fichiers

Définit 1 class

TMemCache:: (11 méthodes):
  __destruct()
  init()
  getHost()
  setHost()
  getPort()
  setPort()
  getValue()
  setValue()
  addValue()
  deleteValue()
  flush()


Classe: TMemCache  - X-Ref

TMemCache class

TMemCache implements a cache application module based on {@link http://www.danga.com/memcached/ memcached}.

TMemCache can be configured with the Host and Port properties, which
specify the host and port of the memcache server to be used.
By default, they take the value 'localhost' and 11211, respectively.
These properties must be set before {@link init} is invoked.

The following basic cache operations are implemented:
- {@link get} : retrieve the value with a key (if any) from cache
- {@link set} : store the value with a key into cache
- {@link add} : store the value only if cache does not have this key
- {@link delete} : delete the value with the specified key from cache
- {@link flush} : delete all values from cache

Each value is associated with an expiration time. The {@link get} operation
ensures that any expired value will not be returned. The expiration time can
be specified by the number of seconds (maximum 60*60*24*30)
or a UNIX timestamp. A expiration time 0 represents never expire.

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.

Also note, there is no security measure to protected data in memcache.
All data in memcache can be accessed by any process running in the system.

To use this module, the memcache PHP extension must be loaded.

Some usage examples of TMemCache are as follows,
<code>
$cache=new TMemCache;  // TMemCache may also be loaded as a Prado application module
$cache->init(null);
$cache->add('object',$object);
$object2=$cache->get('object');
</code>

If loaded, TMemCache will register itself with {@link TApplication} as the
cache module. It can be accessed via {@link TApplication::getCache()}.

TMemCache may be configured in application configuration file as follows
<code>
<module id="cache" class="System.Caching.TMemCache" Host="localhost" Port="11211" />
</code>
where {@link getHost Host} and {@link getPort Port} are configurable properties
of TMemCache.

__destruct()   X-Ref
Destructor.
Disconnect the memcache server.


init($config)   X-Ref
Initializes this module.
This method is required by the IModule interface. It makes sure that
UniquePrefix has been set, creates a Memcache instance and connects
to the memcache server.

param: TApplication Prado application, can be null
param: TXmlElement configuration for this module, can be null

getHost()   X-Ref

return: string host name of the memcache server

setHost($value)   X-Ref

param: string host name of the memcache server

getPort()   X-Ref

return: integer port number of the memcache server

setPort($value)   X-Ref

param: integer port number of the memcache server

getValue($key)   X-Ref
Retrieves a value from cache with a specified key.
This is the implementation of the method declared in the parent class.

param: string a unique key identifying the cached value
return: string the value stored in cache, false if the value is not in the cache or expired.

setValue($key,$value,$expire)   X-Ref
Stores a value identified by a key in cache.
This is the implementation of the method declared in the parent class.

param: string the key identifying the value to be cached
param: string the value to be cached
param: integer the number of seconds in which the cached value will expire. 0 means never expire.
return: boolean true if the value is successfully stored into cache, false otherwise

addValue($key,$value,$expire)   X-Ref
Stores a value identified by a key into cache if the cache does not contain this key.
This is the implementation of the method declared in the parent class.

param: string the key identifying the value to be cached
param: string the value to be cached
param: integer the number of seconds in which the cached value will expire. 0 means never expire.
return: boolean true if the value is successfully stored into cache, false otherwise

deleteValue($key)   X-Ref
Deletes a value with the specified key from cache
This is the implementation of the method declared in the parent class.

param: string the key of the value to be deleted
return: boolean if no error happens during deletion

flush()   X-Ref
Deletes all values from cache.
Be careful of performing this operation if the cache is shared by multiple applications.




Généré le : Sun Feb 25 21:07:04 2007 par Balluche grâce à PHPXref 0.7