Docs For Class ForwardFW_Cache

ForwardFW_Cache_Backend __construct(
ForwardFW_Interface_Application
$application, ForwardFW_Config_Cache_Backend
$config)

Constructor

Tags:

access:

public

Overridden in child classes as:

ForwardFW_Cache_Backend_File::__construct(): Constructor

ForwardFW_Cache_Backend_Session::__construct(): Constructor

Implementation of:

ForwardFW_Interface_Cache_Backend::__construct(): Constructor

Parameters:

ForwardFW_Interface_Application	$application	The running application.
ForwardFW_Config_Cache_Backend	$config	Backend config.

[ Top ]

void clear(
)

Clear complete cache

Tags:

abstract:
access:	protected

Overridden in child classes as:

ForwardFW_Cache_Backend_File::clear(): Clear complete cache

ForwardFW_Cache_Backend_Session::clear(): Clear complete cache

[ Top ]

mixed getData(
string
$strHash, integer
$nTime)

Gets data from Cache.

Tags:

return:	Data from cache
throws:	ForwardFW_Cache_Exception_IsGenerating
throws:	ForwardFW_Cache_Exception_TimeOut
throws:	ForwardFW_Cache_Exception_NoData
access:	public

Implementation of:

ForwardFW_Interface_Cache_Backend::getData(): Gets data from Cache.

Parameters:

string	$strHash	Hash for data.
integer	$nTime	Oldest Time of data in cache.

[ Top ]

array readData(
string
$strHash)

Reads data from the cache

Tags:

return:	Data from the storage
abstract:
access:	protected

Overridden in child classes as:

ForwardFW_Cache_Backend_File::readData(): Reads data from the cache

ForwardFW_Cache_Backend_Session::readData(): Reads data from the cache

Parameters:

string

$strHash

Hash for data.

[ Top ]

boolean removeData(
string
$strHash)

Removes data from the cache

Tags:

return:	Returns true if data removed otherwise false.
abstract:
access:	protected

Overridden in child classes as:

ForwardFW_Cache_Backend_File::removeData(): Removes data from the cache

ForwardFW_Cache_Backend_Session::removeData(): Removes data from the cache

Parameters:

string

$strHash

Hash for data.

[ Top ]

void setData(
string
$strHash, mixed
$mData)

Sets data into Cache.

Tags:

access:

public

Implementation of:

ForwardFW_Interface_Cache_Backend::setData(): Sets data from Cache.

Parameters:

string	$strHash	Hash for data.
mixed	$mData	Data to save into cache.

[ Top ]

void setGenerating(
string
$strHash)

Sets marker that cache will be generated yet.

Tags:

access:

public

Implementation of:

ForwardFW_Interface_Cache_Backend::setGenerating(): Sets marker that cache will be generated yet.

Parameters:

string

$strHash

Hash of cache which is generated.

[ Top ]

void unsetData(
string
$strHash)

Clears data from Cache.

Tags:

access:

public

Implementation of:

ForwardFW_Interface_Cache_Backend::unsetData(): Clears data from Cache.

Parameters:

string

$strHash

Hash for data.

[ Top ]

void writeData(
string
$strHash, 
$arData)

Writes data into the cache

Tags:

abstract:
access:	protected

Overridden in child classes as:

ForwardFW_Cache_Backend_File::writeData(): Writes data into the cache

ForwardFW_Cache_Backend_Session::writeData(): Writes data into the cache

Parameters:

string	$strHash	Hash for data.
array	$arData	Data to save into cache.

[ Top ]

Class: ForwardFW_Cache_Backend

Class Overview

Author(s):

Methods

Child classes:

Class Details

Tags:

Class Methods

constructor __construct [line 59]

Tags:

Parameters:

method clear [line 199]

Tags:

method getData [line 78]

Tags:

Parameters:

method readData [line 183]

Tags:

Parameters:

method removeData [line 192]

Tags:

Parameters:

method setData [line 120]

Tags:

Parameters:

method setGenerating [line 153]

Tags:

Parameters:

method unsetData [line 139]

Tags:

Parameters:

method writeData [line 174]

Tags:

Parameters: