BxDolCacheFile Class Reference

Inheritance diagram for BxDolCacheFile:

Public Member Functions
	__construct ()
	getData ($sKey, $iTTL=false)
	setData ($sKey, $mixedData, $iTTL=false)
	delData ($sKey)
	removeAllByPrefix ($s)
	getSizeByPrefix ($s)
	_removeFileIfTtlExpired ($sFile, $iTTL)
Public Member Functions inherited from BxDolCache
	isAvailable ()
	isInstalled ()

Constructor & Destructor Documentation

__construct()

BxDolCacheFile::__construct

(

)

constructor

Member Function Documentation

_removeFileIfTtlExpired()

BxDolCacheFile::_removeFileIfTtlExpired	(		$sFile,
			$iTTL
	)

remove file from dist if TTL expored

Parameters

string	$sFile	- full path to filename
int	$iTTL	- time to live in seconds

Returns

true if TTL is expired and file is deleted or false otherwise

delData()

BxDolCacheFile::delData

(

$sKey

)

Delete cache file.

Parameters

string

$sKey

- file name

Returns

result of the operation

getData()

BxDolCacheFile::getData	(		$sKey,
			$iTTL = false
	)

Get all data from the cache file.

Parameters

string	$sKey	- file name
int	$iTTL	- time to live

Returns

the data is got from cache.

getSizeByPrefix()

BxDolCacheFile::getSizeByPrefix

(

$s

)

get size of cached data by name prefix

removeAllByPrefix()

BxDolCacheFile::removeAllByPrefix

(

$s

)

remove all data from cache by key prefix

Returns

true on success

setData()

BxDolCacheFile::setData	(		$sKey,
			$mixedData,
			$iTTL = false
	)

Save all data in cache file.

Parameters

string	$sKey	- file name
mixed	$mixedData	- the data to be cached in the file
int	$iTTL	- time to live

Returns

boolean result of operation.

---

The documentation for this class was generated from the following file:

• inc/classes/BxDolCacheFile.php