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

Source for file Backend.php

Documentation is available at Backend.php

  1. <?php
  2. declare(encoding = "utf-8");
  3. /**
  4.  * This file is part of ForwardFW a web application framework.
  5.  *
  6.  * This library is free software; you can redistribute it and/or
  7.  * modify it under the terms of the GNU General Public
  8.  * License as published by the Free Software Foundation; either
  9.  * version 2.1 of the License, or (at your option) any later version.
  10.  *
  11.  * This library is distributed in the hope that it will be useful,
  12.  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14.  * General Public License for more details.
  15.  *
  16.  * You should have received a copy of the GNU General Public
  17.  * License along with this library; if not, write to the Free Software
  18.  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
  19.  *
  20.  * PHP version 5
  21.  *
  22.  * @category   Cache
  23.  * @package    ForwardFW
  24.  * @subpackage Interface
  25.  * @author     Alexander Opitz <opitz.alexander@primacom.net>
  26.  * @copyright  2009-2010 The Authors
  27.  * @license    http://www.gnu.org/copyleft/gpl.html GNU General Public License
  28.  * @version    SVN: $Id: $
  29.  * @link       http://forwardfw.sourceforge.net
  30.  * @since      File available since Release 0.0.8
  31.  */
  32.  
  33. require_once 'ForwardFW/Config/Cache/Backend.php';
  34. require_once 'ForwardFW/Interface/Application.php';
  35.  
  36. /**
  37.  * Interface for a Cache.
  38.  *
  39.  * @category   Cache
  40.  * @package    ForwardFW
  41.  * @subpackage Interface
  42.  * @author     Alexander Opitz <opitz.alexander@primacom.net>
  43.  * @license    http://www.gnu.org/copyleft/gpl.html GNU General Public License
  44.  * @link       http://forwardfw.sourceforge.net
  45.  */
  46. interface ForwardFW_Interface_Cache_Backend
  47. {
  48.     /**
  49.      * Constructor
  50.      *
  51.      * @param ForwardFW_Interface_Application $application The running application.
  52.      * @param ForwardFW_Config_Cache_Backend  $config      Configuration of Backend.
  53.      *
  54.      * @return void 
  55.      */
  56.     public function __construct(
  57.         ForwardFW_Interface_Application $application,
  58.         ForwardFW_Config_Cache_Backend $config
  59.     );
  60.  
  61.     /**
  62.      * Gets data from Cache.
  63.      *
  64.      * @param string  $strHash Hash for data.
  65.      * @param integer $nTime   Oldest Time of data in cache.
  66.      *
  67.      * @return mixed Data from cache
  68.      */
  69.     public function getData($strHash, $nTime);
  70.  
  71.     /**
  72.      * Sets data from Cache.
  73.      *
  74.      * @param string $strHash Hash for data.
  75.      * @param mixed  $mData   Data to save into cache.
  76.      *
  77.      * @return void 
  78.      */
  79.     public function setData($strHash, $mData);
  80.  
  81.     /**
  82.      * Clears data from Cache.
  83.      *
  84.      * @param string $strHash Hash for data.
  85.      *
  86.      * @return void 
  87.      */
  88.     public function unsetData($strHash);
  89.  
  90.     /**
  91.      * Sets marker that cache will be generated yet.
  92.      *
  93.      * @param string $strHash Hash of cache which is generated.
  94.      *
  95.      * @return void 
  96.      */
  97.     public function setGenerating($strHash);
  98. }
  99. ?>
Documentation generated on Sun, 30 Jan 2011 20:46:38 +0100 by phpDocumentor 1.4.3