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

Source for file File.php

Documentation is available at File.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 Cache/Backend
  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.9
  31.  */
  32.  
  33. require_once 'ForwardFW/Config/Cache/Backend.php';
  34. require_once 'ForwardFW/Interface/Application.php';
  35. require_once 'ForwardFW/Cache/Backend.php';
  36.  
  37. /**
  38.  * Implementation of a File Cache Backend.
  39.  *
  40.  * @category   Cache
  41.  * @package    ForwardFW
  42.  * @subpackage Cache/Backend
  43.  * @author     Alexander Opitz <opitz.alexander@primacom.net>
  44.  * @license    http://www.gnu.org/copyleft/gpl.html GNU General Public License
  45.  * @link       http://forwardfw.sourceforge.net
  46.  */
  47. class ForwardFW_Cache_Backend_File extends ForwardFW_Cache_Backend
  48. {
  49.     /**
  50.      * Constructor
  51.      *
  52.      * @param ForwardFW_Interface_Application $application The running application.
  53.      * @param ForwardFW_Config_Cache_Backend  $config      Backend config.
  54.      */
  55.     public function __construct(
  56.         ForwardFW_Interface_Application $application,
  57.         ForwardFW_Config_Cache_Backend $config
  58.     ) {
  59.         parent::__construct($application, $config);
  60.     }
  61.  
  62.     /**
  63.      * Writes data into the cache
  64.      *
  65.      *
  66.      * @param string $strHash Hash for data.
  67.      * @param array  $arData  Data to save into cache.
  68.      *
  69.      * @return void 
  70.      */
  71.     protected function writeData($strHash, array $arData)
  72.     {
  73.         $strPath = $this->config->strPath;
  74.         if (is_writeable($strPath)) {
  75.             return file_put_contents($strPath . $strHash, serialize($arData));
  76.         } else {
  77.             throw new ForwardFW_Cache_Exception('Not writeable');
  78.         }
  79.     }
  80.  
  81.     /**
  82.      * Reads data from the cache
  83.      *
  84.      * @param string $strHash Hash for data.
  85.      *
  86.      * @return array Data from the storage
  87.      */
  88.     protected function readData($strHash)
  89.     {
  90.         $strPath = $this->config->strPath;
  91.         if (is_readable($strPath . $strHash)) {
  92.             return unserialize(file_get_contents($strPath . $strHash));
  93.         }
  94.         return null;
  95.     }
  96.  
  97.     /**
  98.      * Removes data from the cache
  99.      *
  100.      * @param string $strHash Hash for data.
  101.      *
  102.      * @return boolean Returns true if data removed otherwise false.
  103.      */
  104.     protected function removeData($strHash)
  105.     {
  106.         $strPath = $this->config->strPath;
  107.         if (is_writeable($strPath . $strHash)) {
  108.             return unlink($strPath . $strHash);
  109.         }
  110.         return false;
  111.     }
  112.  
  113.     /**
  114.      * Clear complete cache
  115.      *
  116.      * @return void 
  117.      */
  118.     protected function clear()
  119.     {
  120.         $arFiles = glob($this->config->strPath);
  121.         foreach ($arFiles as $strFile) {
  122.             unlink($strFile);
  123.         }
  124.     }
  125. }
  126. ?>
Documentation generated on Sun, 30 Jan 2011 20:46:41 +0100 by phpDocumentor 1.4.3