Class XoopsCacheModel

Database Storage engine for cache

XoopsCacheModel

Package: cake\cake\libs\cache
Copyright: (c) 2000-2016 XOOPS Project (www.xoops.org)
License: GPL 2 (http://www.gnu.org/licenses/gpl-2.0.html)
Author: Taiwen Jiang phppp@users.sourceforge.net
Located at lass/cache/model.php

Methods summary
`public boolean`	# `init( array $settings = array() )` Initialize the Cache Engine Initialize the Cache Engine Called automatically by the cache frontend To reinitialize the settings call Cache::engine('EngineName', [optional] settings = array()); Parameters `$settings` array of setting for the engine Returns boolean True if the engine has been successfully initialized, false if not Overrides `XoopsCacheEngine::init()`
`public`	# `gc( )` Garbage collection. Permanently remove all expired and deleted data Garbage collection. Permanently remove all expired and deleted data Overrides `XoopsCacheEngine::gc()`
`public boolean`	# `write( string $key, mixed $value, integer $duration = null )` Write data for key into cache Write data for key into cache Parameters `$key` Identifier for the data `$value` Data to be cached `$duration` How long to cache the data, in seconds Returns boolean True if the data was successfully cached, false on failure Overrides `XoopsCacheEngine::write()`
`public mixed`	# `read( string $key )` Read a key from the cache Read a key from the cache Parameters `$key` Identifier for the data Returns mixed The cached data, or false if the data doesn't exist, has expired, or if there was an error fetching it Overrides `XoopsCacheEngine::read()`
`public boolean`	# `delete( string $key )` Delete a key from the cache Delete a key from the cache Parameters `$key` Identifier for the data Returns boolean True if the value was successfully deleted, false if it didn't exist or couldn't be removed Overrides `XoopsCacheEngine::delete()`
`public boolean`	# `clear( boolean $check = null )` Delete all keys from the cache Delete all keys from the cache Parameters `$check` if true will check expiration, otherwise delete all Returns boolean True if the cache was successfully cleared, false otherwise Overrides `XoopsCacheEngine::clear()`

Methods inherited from XoopsCacheEngine
`settings()`

Properties summary
`public array`	`$settings` settings className = name of the model to use, default => Cache fields = database fields that hold data and ttl, default => data, expires settings className = name of the model to use, default => Cache fields = database fields that hold data and ttl, default => data, expires	# `array()`
`public object`	`$model` Model instance. Model instance.	#
`public object`	`$fields` Model instance. Model instance.	# `array()`

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsCacheModel

Parameters

Returns

Overrides

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides

Parameters

Returns

Overrides