ForwardFW
[ class tree: ForwardFW ] [ index: ForwardFW ] [ all elements ]

Class: ForwardFW_Cache_Backend

Source Location: /Cache/Backend.php

Class Overview


Implementation of a Cache Backend.


Author(s):

Implements interfaces:

Methods


Child classes:

ForwardFW_Cache_Backend_File
Implementation of a File Cache Backend.
ForwardFW_Cache_Backend_Session
Implementation of a Cache Backend.

Class Details

[line 51]
Implementation of a Cache Backend.



Tags:

author:  Alexander Opitz <opitz.alexander@primacom.net>
link:  http://forwardfw.sourceforge.net
abstract:  
license:  GNU General Public License


[ Top ]


Class Methods


constructor __construct [line 59]

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 ]

method clear [line 199]

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 ]

method getData [line 78]

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 ]

method readData [line 183]

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 ]

method removeData [line 192]

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 ]

method setData [line 120]

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 ]

method setGenerating [line 153]

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 ]

method unsetData [line 139]

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 ]

method writeData [line 174]

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 ]


Documentation generated on Sun, 30 Jan 2011 20:46:38 +0100 by phpDocumentor 1.4.3