PRADO 3.0.6 : Vue détaillée de TAPCCache.php

TAPCCache class file

Author:	Alban Hanry <compte_messagerie@hotmail.com>
Copyright:	Copyright © 2005 PradoSoft
License:	http://www.pradosoft.com/license/
Version:	$Id: TAPCCache.php 1397 2006-09-07 07:55:53Z wei $
Poids:	122 lignes (4 kb)
Inclus ou requis:	0 fois
Référencé:	0 fois
Nécessite:	0 fichiers

Définit 1 class

TAPCCache:: (6 méthodes):
  init()
  getValue()
  setValue()
  addValue()
  deleteValue()
  flush()

Classe: TAPCCache - X-Ref

TAPCCache class

TAPCCache implements a cache application module based on {@link http://www.php.net/apc APC}.

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 APC PHP extension must be loaded and set in the php.ini file the following:
<code>
apc.cache_by_default=0
</code>

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

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

TAPCCache may be configured in application configuration file as follows
<code>
<module id="cache" class="System.Caching.TAPCCache" />
</code>

init($config) X-Ref

Initializes this module.
This method is required by the IModule interface.

param: TXmlElement configuration for this module, can be null

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.

Code source de PRADO 3.0.6

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

Définit 1 class