TSqliteCache class
TSqliteCache implements a cache application module based on SQLite database.
To use this module, the sqlite PHP extension must be loaded. Note, Sqlite extension is no longer loaded by default since PHP 5.1.
Sine PRADO v3.1.0, a new DB-based cache module called TDbCache is provided. If you have PDO extension installed, you may consider using the new cache module instead as it allows you to use different database to store the cached data.
The database file is specified by the DbFile property. If not set, the database file will be created under the system state path. If the specified database file does not exist, it will be created automatically. Make sure the directory containing the specified DB file and the file itself is writable by the Web server process.
The following basic cache operations are implemented:
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.
Do not use the same database file for multiple applications using TSqliteCache. Also note, cache is shared by all user sessions of an application.
Some usage examples of TSqliteCache are as follows,
- $cache=new TSqliteCache; // TSqliteCache may also be loaded as a Prado application module
- $cache->setDbFile($dbFilePath);
- $cache->init(null);
- $cache->add('object',$object);
- $object2=$cache->get('object');
If loaded, TSqliteCache will register itself with TApplication as the cache module. It can be accessed via TApplication::getCache().
TSqliteCache may be configured in application configuration file as follows
where DbFile is a property specifying the location of the SQLite DB file (in the namespace format).
- <module id="cache" class="System.Caching.TSqliteCache" DbFile="Application.Data.site" />
Located in /Caching/TSqliteCache.php (line 73)
TComponent | --TApplicationComponent | --TModule | --TCache | --TSqliteCache
Destructor.
Disconnect the db connection.
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.
Deletes a value with the specified key from cache This is the implementation of the method declared in the parent class.
Deletes all values from cache.
Be careful of performing this operation if the cache is shared by multiple applications.
Retrieves a value from cache with a specified key.
This is the implementation of the method declared in the parent class.
Initializes this module.
This method is required by the IModule interface. It checks if the DbFile property is set, and creates a SQLiteDatabase instance for it. The database or the cache table does not exist, they will be created. Expired values are also deleted.
Stores a value identified by a key in cache.
This is the implementation of the method declared in the parent class.
Inherited From TCache
TCache::add()
TCache::addValue()
TCache::delete()
TCache::deleteValue()
TCache::flush()
TCache::generateUniqueKey()
TCache::get()
TCache::getKeyPrefix()
TCache::getPrimaryCache()
TCache::getValue()
TCache::init()
TCache::offsetExists()
TCache::offsetGet()
TCache::offsetSet()
TCache::offsetUnset()
TCache::set()
TCache::setKeyPrefix()
TCache::setPrimaryCache()
TCache::setValue()
Inherited From TModule
TModule::getID()
TModule::init()
TModule::setID()
Inherited From TApplicationComponent
TApplicationComponent::getApplication()
TApplicationComponent::getRequest()
TApplicationComponent::getResponse()
TApplicationComponent::getService()
TApplicationComponent::getSession()
TApplicationComponent::getUser()
TApplicationComponent::publishAsset()
TApplicationComponent::publishFilePath()
Inherited From TComponent
TComponent::addParsedObject()
TComponent::attachEventHandler()
TComponent::canGetProperty()
TComponent::canSetProperty()
TComponent::createdOnTemplate()
TComponent::detachEventHandler()
TComponent::evaluateExpression()
TComponent::evaluateStatements()
TComponent::getEventHandlers()
TComponent::getSubProperty()
TComponent::hasEvent()
TComponent::hasEventHandler()
TComponent::hasProperty()
TComponent::raiseEvent()
TComponent::setSubProperty()
TComponent::__get()
TComponent::__set()
Documentation generated on Mon, 21 Apr 2008 11:36:14 -0400 by phpDocumentor 1.3.0RC4