PRADO Component Framework for PHP 5
  • Home
  • About
  • Testimonials
  • Demos
  • Download
  • Documentation
  • Forum
  • Development
  • Tutorials
  • Class Docs
  • API Manual
  • Wiki

Packages

  • None
  • System
    • Caching
    • Collections
    • Data
      • ActiveRecord
        • Relations
        • Scaffold
          • InputBuilder
      • Commom
        • Sqlite
      • Common
        • Mssql
        • Mysql
        • Oracle
        • Pgsql
        • Sqlite
      • DataGateway
      • SqlMap
        • Configuration
        • Statements
    • Exceptions
    • I18N
    • IO
    • Security
    • Util
    • Web
      • Javascripts
      • Services
      • UI
        • ActiveControls
        • WebControls
    • Xml
  • Wsat
    • pages
  • Overview
  • Package
  • Class
  • Tree
  • Deprecated
  • Todo

Class TAPCCache

TAPCCache class

TAPCCache implements a cache application module based on 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:

apc.cache_by_default=0

Some usage examples of TAPCCache are as follows,

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

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

TAPCCache may be configured in application configuration file as follows

<module id="cache" class="System.Caching.TAPCCache" />
TComponent
Extended by TApplicationComponent
Extended by TModule implements IModule
Extended by TCache implements ICache, ArrayAccess
Extended by TAPCCache
Package: System\Caching
Copyright: Copyright © 2005-2014 PradoSoft
License: http://www.pradosoft.com/license/
Author: Alban Hanry <compte_messagerie@hotmail.com>
Author: Knut Urdalen <knut.urdalen@gmail.com>
Since: 3.0b
Located at Caching/TAPCCache.php
Methods summary
public
# init( TXmlElement $config )

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

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

Parameters

$config
TXmlElement
configuration for this module, can be null

Throws

TConfigurationException
if apc extension is not installed or not started, check your php.ini

Overrides

TCache::init()
protected string
# getValue( string $key )

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

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

Parameters

$key
string
a unique key identifying the cached value

Returns

string
the value stored in cache, false if the value is not in the cache or expired.
protected boolean
# setValue( string $key, string $value, integer $expire )

Stores a value identified by a key in cache. This is the implementation of the method declared in the parent class.

Stores a value identified by a key in cache. This is the implementation of the method declared in the parent class.

Parameters

$key
string
the key identifying the value to be cached
$value
string
the value to be cached
$expire
integer
the number of seconds in which the cached value will expire. 0 means never expire.

Returns

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

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.

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.

Parameters

$key
string
the key identifying the value to be cached
$value
string
the value to be cached
$expire
integer
the number of seconds in which the cached value will expire. 0 means never expire.

Returns

boolean
true if the value is successfully stored into cache, false otherwise
protected boolean
# deleteValue( string $key )

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

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

Parameters

$key
string
the key of the value to be deleted

Returns

boolean
if no error happens during deletion
public
# flush( )

Deletes all values from cache. Be careful of performing this operation if the cache is shared by multiple applications.

Deletes all values from cache. Be careful of performing this operation if the cache is shared by multiple applications.

Throws

TNotSupportedException
if this method is not overridden by child classes

Overrides

TCache::flush()
Methods inherited from TCache
add(), delete(), generateUniqueKey(), get(), getKeyPrefix(), getPrimaryCache(), offsetExists(), offsetGet(), offsetSet(), offsetUnset(), set(), setKeyPrefix(), setPrimaryCache()
Methods inherited from TModule
getID(), setID()
Methods inherited from TApplicationComponent
getApplication(), getRequest(), getResponse(), getService(), getSession(), getUser(), publishAsset(), publishFilePath()
Methods inherited from TComponent
__call(), __construct(), __destruct(), __get(), __isset(), __set(), __sleep(), __unset(), __wakeup(), addParsedObject(), asa(), attachBehavior(), attachBehaviors(), attachClassBehavior(), attachEventHandler(), canGetProperty(), canSetProperty(), clearBehaviors(), createdOnTemplate(), detachBehavior(), detachBehaviors(), detachClassBehavior(), detachEventHandler(), disableBehavior(), disableBehaviors(), enableBehavior(), enableBehaviors(), evaluateExpression(), evaluateStatements(), fxAttachClassBehavior(), fxDetachClassBehavior(), getAutoGlobalListen(), getBehaviorsEnabled(), getClassHierarchy(), getEventHandlers(), getListeningToGlobalEvents(), getSubProperty(), hasEvent(), hasEventHandler(), hasProperty(), isa(), listen(), raiseEvent(), setSubProperty(), unlisten()
Constants inherited from TComponent
GLOBAL_RAISE_EVENT_LISTENER
Terms of Service | Contact Us
PRADO v3.2.4 API Manual API documentation generated by ApiGen 2.8.0
Copyright © 2006-2014 by the PRADO Group.
Powered by PRADO