[ Index ]

PHP Cross Reference of Joomla 1.5.26 DE

title

Body

[close]

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

(no description)

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

Defines 1 class

JCacheStorageFile:: (9 methods):
  __construct()
  get()
  store()
  remove()
  clean()
  gc()
  test()
  _setExpire()
  _getFilePath()


Class: JCacheStorageFile  - X-Ref

File cache storage handler

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

param: array $options optional parameters

get($id, $group, $checkTime)   X-Ref
Get cached data from a file 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 a file 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 file 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 cache storage is available.

return: boolean  True on success, false otherwise.

_setExpire($id, $group)   X-Ref
Check to make sure cache is still valid, if not, delete it.

param: string  $id   Cache key to expire.
param: string  $group The cache data group.

_getFilePath($id, $group)   X-Ref
Get a cache file path from an id/group pair

param: string    $id        The cache data id
param: string    $group    The cache data group
return: string    The cache file path



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