Class XoopsCacheEngine

Abstract class for storage engine for caching

Direct known subclasses

XoopsCacheApc, XoopsCacheFile, XoopsCacheMemcache, XoopsCacheModel, XoopsCacheXcache

Package: core\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/xoopscache.php

Methods summary
`public boolean`	# `init( array $settings = array() )` Iitialize the cache engine Iitialize the cache engine Called automatically by the cache frontend Parameters `$settings` Associative array of parameters for the engine Returns boolean True if the engine has been successfully initialized, false if not
`public`	# `gc( )` Garbage collection Garbage collection Permanently remove all expired and deleted data
`public boolean`	# `write( string $key, mixed $value, mixed $duration = null )` Write value for a key into cache Write value for a 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
`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
`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
`public boolean`	# `clear( boolean $check )` 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
`public array`	# `settings( )` Cache Engine settings Cache Engine settings Returns array settings

Properties summary
`public integer`	`$settings` settings of current engine instance settings of current engine instance	#

Namespaces

Classes

Interfaces

Exceptions

Functions

Class XoopsCacheEngine

Direct known subclasses

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns