PHP Class Habari\FileCache

Stores cache data in local files

Inheritance: extends Cache

Protected Properties

Property	Type	Description
$cache_data
$cache_files
$cache_location
$enabled
$index_file

Public Methods

Method	Description
__construct ( )	Constructor for FileCache

Protected Methods

Method	Description
_expire ( string $name, string $group, string $match_mode = 'strict' )	Expires the named value from the cache.
_expired ( string $name, string $group ) : boolean	Return whether a named cache value has expired
_extend ( string $name, integer $expiry, $group )	Extend the expiration of the named cached value.
_get ( string $name, $group ) : mixed	Returns the named value from the cache.
_get_group ( $group ) : mixed	Returns the group from the cache.
_has ( string $name, $group ) : boolean	Is record with $name in the cache?
_has_group ( $group ) : boolean	Is group in the cache?
_purge ( )	Remove all cache files
_set ( $name, $value, $expiry, $group, $keep )

Private Methods

Method	Description
clear_expired ( )	Purge expired items from the cache.
get_group_hash ( $group )	Get the unique hash for a given key.
get_name_hash ( string $name )	Get the unique hash for a given key.
record_fresh ( $record )	Check whether a given record is still fresh (e.g. has not expired).

Method Details

__construct() public method

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

public __construct ( )

_expire() protected method

Expires the named value from the cache.

protected _expire ( string $name, string $group, string $match_mode = 'strict' )
$name	string	The name of the cached item
$group	string	The name of the cache group
$match_mode	string	(optional) how to match bucket names ('strict', 'regex', 'glob') (default 'strict')

_expired() protected method

Return whether a named cache value has expired

protected _expired ( string $name, string $group ) : boolean
$name	string	The name of the cached item
$group	string	The group of the cached item
return	boolean	true if the stored value has expired

_extend() protected method

Extend the expiration of the named cached value.

protected _extend ( string $name, integer $expiry, $group )
$name	string	The name of the cached item
$expiry	integer	The duration in seconds to extend the cache expiration by

_get() protected method

Returns the named value from the cache.

protected _get ( string $name, $group ) : mixed
$name	string	The name of the cached item
return	mixed	The item value or null if it doesn't exist in cache

_get_group() protected method

Returns the group from the cache.

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

_has() protected method

Is record with $name in the cache?

protected _has ( string $name, $group ) : boolean
$name	string	name of the cached item
return	boolean	true if item is cached, false if not

_has_group() protected method

Is group in the cache?

protected _has_group ( $group ) : boolean
return	boolean	true if item is cached, false if not

_purge() protected method

Remove all cache files

protected _purge ( )

_set() protected method

protected _set ( $name, $value, $expiry, $group, $keep )

Property Details

$cache_data protected_oe property

protected $cache_data

$cache_files protected_oe property

protected $cache_files

$cache_location protected_oe property

protected $cache_location

$enabled protected_oe property

protected $enabled

$index_file protected_oe property

protected $index_file