Docs for class JCache

Joomla! 1.5 Documentation

Packages

Package: Joomla-Framework

Developer Network License

JCache

Description

Joomla! Cache base object

since: 1.5
author: Louis Landry <[email protected]>
abstract:

Located in /joomla/cache/cache.php (line 27)

 JObject   (Subpackage Base)

 JCache   (Subpackage Cache)

Direct descendents

Class	Description
JCacheCallback	Joomla! Cache callback type object
JCachePage	Joomla! Cache page type object
JCacheOutput	Joomla! Cache output type object
JCacheView	Joomla! Cache view type object

Method Summary

static object A &getInstance ([string $type = 'output'], [ $options = array()])

JCache __construct (array $options)

boolean clean ([string $group = null], [string $mode = 'group'])

boolean gc ()

mixed get (string $id, [string $group = null])

boolean remove (string $id, [string $group = null])

void setCacheValidation ()

void setCaching (boolean $enabled)

void setLifeTime (int $lt)

boolean store (mixed $data, string $id, [string $group = null])

void &_getStorageHandler ()

Methods

Constructor __construct (line 49)

Constructor

access: protected

JCache __construct (array $options)

array $options: options

Redefinition of:

JObject::__construct(): Class constructor, overridden in descendant classes.

clean (line 198)

Clean cache for a group given a mode.

group mode : cleans all cache in the group notgroup mode : cleans all cache not in the group

return: True on success, false otherwise
since: 1.5
access: public

boolean clean ([string $group = null], [string $mode = 'group'])

string $group: The cache data group
string $mode: The mode for cleaning cache [group|notgroup]

gc (line 217)

Garbage collect expired cache data

return: True on success, false otherwise.
access: public

boolean gc ()

get (line 127)

Get cached data by id and group

return: Boolean false on failure or a cached data string
since: 1.5
access: public
abstract:

mixed get (string $id, [string $group = null])

string $id: The cache data id
string $group: The cache data group

Redefinition of:

JObject::get(): Returns a property of the object or the default value if the property is not set.

Redefined in descendants as:

JCacheCallback::get() : Executes a cacheable callback if not found in cache else returns cached output and result
JCachePage::get() : Get the cached page data
JCacheView::get() : Get the cached view data

getInstance (line 68)

Returns a reference to a cache adapter object, only creating it if it doesn't already exist.

return: JCache object
since: 1.5

object A &getInstance ([string $type = 'output'], [ $options = array()])

string $type: The cache object type to instantiate
$options

remove (line 173)

Remove a cached data entry by id and group

return: True on success, false otherwise
since: 1.5
access: public
abstract:

boolean remove (string $id, [string $group = null])

string $id: The cache data id
string $group: The cache data group

setCacheValidation (line 112)

Set cache validation

since: 1.5
access: public

void setCacheValidation ()

setCaching (line 87)

Set caching enabled state

since: 1.5
access: public

void setCaching (boolean $enabled)

boolean $enabled: True to enable caching

setLifeTime (line 100)

Set cache lifetime

since: 1.5
access: public

void setLifeTime (int $lt)

int $lt: Cache lifetime

store (line 150)

Store the cached data by id and group

return: True if cache stored
since: 1.5
access: public

boolean store (mixed $data, string $id, [string $group = null])

string $id: The cache data id
string $group: The cache data group
mixed $data: The data to store

Redefined in descendants as:

JCachePage::store() : Stop the cache buffer and store the cached data

_getStorageHandler (line 227)

void &_getStorageHandler ()

Inherited Methods

Inherited From JObject

JObject::JObject()
JObject::__construct()
JObject::get()
JObject::getPublicProperties()
JObject::set()
JObject::toString()

Documentation generated on Mon, 05 Mar 2007 20:53:41 +0000 by phpDocumentor 1.3.1