[ Index ]

PHP Cross Reference of Joomla 1.5.26 DE

title

Body

[close]

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

(no description)

Copyright: Copyright (C) 2005 - 2010 Open Source Matters. All rights reserved.
License: GNU/GPL, see LICENSE.php
Version: $Id:storage.php 6961 2007-03-15 16:06:53Z tcp $
File Size: 173 lines (4 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

JCacheStorage:: (8 methods):
  __construct()
  getInstance()
  get()
  store()
  remove()
  clean()
  gc()
  test()


Class: JCacheStorage  - X-Ref

Abstract cache storage handler

__construct( $options = array()   X-Ref
Constructor

param: array $options optional parameters

getInstance($handler = 'file', $options = array()   X-Ref
Returns a reference to a cache storage hanlder object, only creating it
if it doesn't already exist.

param: string    $handler    The cache storage handler to instantiate
return: object    A JCacheStorageHandler object

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

param: string    $id            The cache data id
param: string    $group        The cache data group
param: boolean    $checkTime    True to verify cache time expiration threshold
return: mixed    Boolean false on failure or a cached data string

store($id, $group, $data)   X-Ref
Store the data to cache by id and group

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

remove($id, $group)   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, $mode)   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.

test()   X-Ref
Test to see if the storage handler is available.

return: boolean  True on success, false otherwise.



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