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

Source for file Frontend.php

Documentation is available at Frontend.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. /**
  34.  *
  35.  */
  36. require_once 'ForwardFW/Config/Cache/Data.php';
  37. require_once 'ForwardFW/Config/Cache/Frontend.php';
  38. require_once 'ForwardFW/Interface/Application.php';
  39. require_once 'ForwardFW/Interface/Cache/Backend.php';
  40.  
  41. /**
  42.  * Interface for a Cache.
  43.  *
  44.  * @category   Cache
  45.  * @package    ForwardFW
  46.  * @subpackage Interface
  47.  * @author     Alexander Opitz <opitz.alexander@primacom.net>
  48.  * @license    http://www.gnu.org/copyleft/gpl.html GNU General Public License
  49.  * @link       http://forwardfw.sourceforge.net
  50.  */
  51. interface ForwardFW_Interface_Cache_Frontend
  52. {
  53.     /**
  54.      * Constructor
  55.      *
  56.      * @param ForwardFW_Interface_Application   $application The running application.
  57.      * @param ForwardFW_Interface_Cache_Backend $backend     Backend for storing
  58.      *                                                        cache data.
  59.      */
  60.     public function __construct(
  61.         ForwardFW_Interface_Application $application,
  62.         ForwardFW_Interface_Cache_Backend $backend
  63.     );
  64.  
  65.     /**
  66.      * Builds an instance of cache
  67.      *
  68.      * @param ForwardFW_Interface_Application $application The running application
  69.      * @param ForwardFW_Config_Cache_Frontend $config      Configuration of caching
  70.      *
  71.      * @return ForwardFW_Interface_Cache_Frontend The cache Frontend
  72.      */
  73.     static public function getInstance(
  74.         ForwardFW_Interface_Application $application,
  75.         ForwardFW_Config_Cache_Frontend $config
  76.     );
  77.  
  78.     /**
  79.      * Returns content from cache or gathers the data
  80.      *
  81.      * @param ForwardFW_Config_Cache_Data $config What data should be get from cache
  82.      *
  83.      * @return mixed The data you requested.
  84.      */
  85.     public function getCache(
  86.         ForwardFW_Config_Cache_Data $config
  87.     );
  88. }
  89. ?>
Documentation generated on Sun, 30 Jan 2011 20:46:41 +0100 by phpDocumentor 1.4.3