[ Index ]

PHP Cross Reference of Joomla 1.5.26 DE

title

Body

[close]

/libraries/joomla/cache/ -> cache.php (summary)

(no description)

Copyright: Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
License: GNU/GPL, see LICENSE.php
Version: $Id: cache.php 14401 2010-01-26 14:10:00Z louis $
File Size: 316 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

JCache:: (12 methods):
  __construct()
  getInstance()
  getStores()
  setCaching()
  setLifeTime()
  setCacheValidation()
  get()
  store()
  remove()
  clean()
  gc()
  _getStorage()


Class: JCache  - X-Ref

Joomla! Cache base object

__construct($options)   X-Ref
Constructor

param: array    $options    options

getInstance($type = 'output', $options = array()   X-Ref
Returns a reference to a cache adapter object, always creating it

param: string    $type    The cache object type to instantiate
return: object    A JCache object

getStores()   X-Ref
Get the storage handlers

return: array An array of available storage handlers

setCaching($enabled)   X-Ref
Set caching enabled state

param: boolean    $enabled    True to enable caching
return: void

setLifeTime($lt)   X-Ref
Set cache lifetime

param: int    $lt    Cache lifetime
return: void

setCacheValidation()   X-Ref
Set cache validation

return: void

get($id, $group=null)   X-Ref
Get cached data by id and group

param: string    $id        The cache data id
param: string    $group    The cache data group
return: mixed    Boolean false on failure or a cached data string

store($data, $id, $group=null)   X-Ref
Store the cached data by id and group

param: string    $id        The cache data id
param: string    $group    The cache data group
param: mixed    $data    The data to store
return: boolean    True if cache stored

remove($id, $group=null)   X-Ref
Remove a cached data entry by id and group

param: string    $id        The cache data id
param: string    $group    The cache data group
return: boolean    True on success, false otherwise

clean($group=null, $mode='group')   X-Ref
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

param: string    $group    The cache data group
param: string    $mode    The mode for cleaning cache [group|notgroup]
return: boolean    True on success, false otherwise

gc()   X-Ref
Garbage collect expired cache data

return: boolean  True on success, false otherwise.

_getStorage()   X-Ref
Get the cache storage handler

return: object A JCacheStorage object



Generated: Wed Mar 28 15:54:07 2012 Cross-referenced by PHPXref 0.7.1