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

Source for file Data.php

Documentation is available at Data.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 Config
  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.php';
  34.  
  35. /**
  36.  * Config for a Cache.
  37.  *
  38.  * @category   Cache
  39.  * @package    ForwardFW
  40.  * @subpackage Config
  41.  * @author     Alexander Opitz <opitz.alexander@primacom.net>
  42.  * @license    http://www.gnu.org/copyleft/gpl.html GNU General Public License
  43.  * @link       http://forwardfw.sourceforge.net
  44.  */
  45. class ForwardFW_Config_Cache_Data extends ForwardFW_Config
  46. {
  47.     /**
  48.      * @var integer Timeout of the cache in seconds.
  49.      */
  50.     protected $nTimeout = 0;
  51.  
  52.     /**
  53.      * @var boolean Should old data be returned if an error occours on fetching data.
  54.      */
  55.     protected $bReserveOld = false;
  56.  
  57.     /**
  58.      * Sets the timeout
  59.      *
  60.      * @param integer Timeout in seconds.
  61.      *
  62.      * @return ForwardFW_Config_CacheData 
  63.      */
  64.     public function setTimeout($nTimeout)
  65.     {
  66.         $this->nTimeout = $nTimeout;
  67.         return $this;
  68.     }
  69.  
  70.     /**
  71.      * Sets the flag if Old data should be used on error while fetching data.
  72.      *
  73.      * @param boolean $bReserveOld If old data should be reserved.
  74.      *
  75.      * @return ForwardFW_Config 
  76.      */
  77.     public function setReserveOld($bReserveOld)
  78.     {
  79.         $this->bReserveOld = $bReserveOld;
  80.         return $this;
  81.     }
  82.  
  83.     /**
  84.      * Gets the timeout
  85.      *
  86.      * @return integer The timeout in seconds.
  87.      */
  88.     public function getTimeout()
  89.     {
  90.         return $this->nTimeout;
  91.     }
  92.  
  93.     /**
  94.      * Gets the flag for old data handling.
  95.      *
  96.      * @return boolean State of the flag.
  97.      */
  98.     public function getReserveOld()
  99.     {
  100.         return $this->bReserveOld;
  101.     }
  102. }
  103. ?>
Documentation generated on Sun, 30 Jan 2011 20:46:39 +0100 by phpDocumentor 1.4.3