Docs For Class FileCache

Description

Stores cache data in local files

Located in /system/classes/filecache.php (line 12)

Cache
   |
   --FileCache

Variable Summary

mixed $cache_data

mixed $cache_files

mixed $cache_location

mixed $enabled

mixed $index_file

Method Summary

FileCache __construct ()

void _expire (string $name, $group)

void _extend (string $name, integer $expiry, $group)

mixed _get (string $name, $group)

mixed _get_group ( $group, string $name)

boolean _has (string $name, $group)

boolean _has_group ( $group, string $name)

void _set ( $name, $value, $expiry, $group)

Variables

mixed $cache_data = array() (line 17)

access: protected

mixed $cache_files = array() (line 16)

access: protected

mixed $cache_location (line 14)

access: protected

mixed $enabled = false (line 15)

access: protected

mixed $index_file (line 18)

access: protected

Inherited Variables

Inherited from Cache

Cache::$default_group
Cache::$instance

Methods

Constructor __construct (line 25)

Constructor for FileCache

Sets up paths etc. and reads cache index, if it exists.

access: public

FileCache __construct ()

_expire (line 151)

Expires the named value from the cache.

access: protected

void _expire (string $name, $group)

string $name: The name of the cached item
$group

Redefinition of:

Cache::_expire(): A cache instance implements this to expire the named value from the cache.

_extend (line 173)

Extend the expiration of the named cached value.

access: protected

void _extend (string $name, integer $expiry, $group)

string $name: The name of the cached item
integer $expiry: The duration in seconds to extend the cache expiration by
$group

Redefinition of:

Cache::_extend(): A cache instance implements this to extend the expiration of the named cached value.

_get (line 111)

Returns the named value from the cache.

return: The item value or NULL if it doesn't exist in cache
access: protected

mixed _get (string $name, $group)

string $name: The name of the cached item
$group

Redefinition of:

Cache::_get(): A cache instance implements this to return the named value from the cache.

_get_group (line 83)

Returns the group from the cache.

return: The group or array() if it doesn't exist in cache
access: protected

mixed _get_group ( $group, string $name)

string $name: The name of the cached item
$group

Redefinition of:

Cache::_get_group(): A cache instance implements this to return the group from the cache.

_has (line 50)

Is record with $name in the cache?

return: TRUE if item is cached, FALSE if not
access: protected

boolean _has (string $name, $group)

string $name: name of the cached item
$group

Redefinition of:

Cache::_has(): A cache instance implements this function to return whether a named cache exists.

_has_group (line 67)

Is group in the cache?

return: TRUE if item is cached, FALSE if not
access: protected

boolean _has_group ( $group, string $name)

string $name: name of the cached item
$group

Redefinition of:

Cache::_has_group(): A cache instance implements this function to return whether a group exists.

_set (line 130)

access: protected

void _set ( $name, $value, $expiry, $group)

$name
$value
$expiry
$group

Redefinition of:

Cache::_set(): A cache instance implements this to set the named value in the cache with an expiration.

Inherited Methods

Inherited From Cache

Cache::expire()
Cache::extend()
Cache::get()
Cache::get_group()
Cache::has()
Cache::has_group()
Cache::set()
Cache::_expire()
Cache::_extend()
Cache::_get()
Cache::_get_group()
Cache::_has()
Cache::_has_group()
Cache::_set()
Cache::__static()