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

Source for file DataHandler.php

Documentation is available at DataHandler.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   Application
  23.  * @package    ForwardFW
  24.  * @subpackage Controller
  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.7
  31.  */
  32.  
  33. require_once 'ForwardFW/Interface/DataHandler.php';
  34. require_once 'ForwardFW/Interface/Application.php';
  35.  
  36. require_once 'ForwardFW/Callback.php';
  37. require_once 'ForwardFW/Cache/Frontend/Function.php';
  38. require_once 'ForwardFW/Config/Cache/Backend/File.php';
  39. require_once 'ForwardFW/Config/Cache/Data/Function.php';
  40.  
  41.  
  42. /**
  43.  * Managing DataLoading via PEAR::MDB
  44.  *
  45.  * @category   Application
  46.  * @package    ForwardFW
  47.  * @subpackage Controller
  48.  * @author     Alexander Opitz <opitz.alexander@primacom.net>
  49.  * @license    http://www.gnu.org/copyleft/gpl.html GNU General Public License
  50.  * @link       http://forwardfw.sourceforge.net
  51.  */
  52. {
  53.     /**
  54.      * @var array Cache of connections
  55.      */
  56.     protected $arConnectionCache = array();
  57.  
  58.     /**
  59.      * Constructor
  60.      *
  61.      * @param ForwardFW_Interface_Application $application The running application.
  62.      *
  63.      * @return void 
  64.      */
  65.     public function __construct(ForwardFW_Interface_Application $application)
  66.     {
  67.         parent::__construct($application);
  68.     }
  69.  
  70.     /**
  71.      * Returns an instance of configured DataHandler.
  72.      *
  73.      * @param ForwardFW_Interface_Application $application The running application.
  74.      *
  75.      * @return void 
  76.      */
  77.     public static function getInstance(ForwardFW_Interface_Application $application)
  78.     {
  79.         if (isset($GLOBALS['DataLoader']['instance'][$application])) {
  80.             $return $GLOBALS['DataLoader']['instance'][$application->getName()];
  81.         else {
  82.             $return new ForwardFW_Controller_DataHandler($application);
  83.             $GLOBALS['DataLoader']['instance'][$application->getName()$return;
  84.         }
  85.         return $return;
  86.     }
  87.  
  88.     /**
  89.      * Loads Data from cache or from a connection (DB, SOAP, File) if cache failed.
  90.      *
  91.      * @param string $strConnection Name of connection
  92.      * @param array  $arOptions     Options to load the data
  93.      *
  94.      * @return mixed Data from the connection.
  95.      */
  96.     public function loadFromCached($strConnectionarray $arOptions$nCacheTimeout = -1)
  97.     {
  98.         $handler $this->getConnection($strConnection);
  99.  
  100.         $cache $this->getCacheSystem($strConnection);
  101.  
  102.         $cacheCallback new ForwardFW_Callback(
  103.             array($handler'loadFrom'),
  104.             array($strConnection$arOptions)
  105.         );
  106.  
  107.         $configCacheData new ForwardFW_Config_Cache_Data_Function();
  108.         $configCacheData
  109.             ->setCallback($cacheCallback)
  110.             ->setTimeout($nCacheTimeout);
  111.  
  112.         return $cache->getCache($configCacheData);
  113.     }
  114.  
  115.  
  116.     /**
  117.      * Initializes and returns the caching system depending on connection
  118.      * configuration.
  119.      *
  120.      * @param string $strConnection Name of connection
  121.      *
  122.      * @return ForwardFW_Cache_Frontend The Cache Frontend.
  123.      */
  124.     protected function getCacheSystem($strConnection)
  125.     {
  126.         $backendConfig new ForwardFW_Config_Cache_Backend_File();
  127.         $backendConfig->strPath getcwd('/cache/';
  128.  
  129.         $configCacheFrontend new ForwardFW_Config_Cache_Frontend();
  130.         $configCacheFrontend
  131.             ->setCacheBackend('ForwardFW_Cache_Backend_File')
  132.             ->setBackendConfig($backendConfig)
  133.             ->setCacheFrontend('ForwardFW_Cache_Frontend_Function');
  134.  
  135.         $cache ForwardFW_Cache_Frontend::getInstance(
  136.             $this->application,
  137.             $configCacheFrontend
  138.         );
  139.  
  140.         return $cache;
  141.     }
  142.  
  143.     /**
  144.      * Loads Data from a connection (DB, SOAP, File)
  145.      *
  146.      * @param string $strConnection Name of connection
  147.      * @param array  $arOptions     Options to load the data
  148.      *
  149.      * @return mixed Data from the connection.
  150.      */
  151.     public function loadFrom($strConnectionarray $arOptions)
  152.     {
  153.         $handler $this->getConnection($strConnection);
  154.         return $handler->loadFrom($strConnection$arOptions);
  155.     
  156.  
  157.     /**
  158.      * Saves Data to a connection (DB, SOAP, File)
  159.      *
  160.      * @param string $strConnection Name of connection
  161.      * @param array  $arOptions     Options to load the data
  162.      *
  163.      * @return mixed Data from the connection.
  164.      */
  165.     public function saveTo($strConnectionarray $options)
  166.     {
  167.         $handler $this->getConnection($strConnection);
  168.         return $handler->saveTo($strConnection$arOptions);
  169.     
  170.  
  171.  
  172.     /**
  173.      * Gets the connection handler.
  174.      *
  175.      * @param string $strConnection Name of connection
  176.      *
  177.      * @return mixed ConnectionHandler
  178.      */
  179.     protected function getConnection($strConnection)
  180.     {
  181.         if (!isset($this->arConnectionCache[$strConnection])) {
  182.             $this->initConnection($strConnection);
  183.         }
  184.         // Return existing connection
  185.         return $this->arConnectionCache[$strConnection];
  186.     }
  187.  
  188.     /**
  189.      * Loads and initialize the connection handler.
  190.      *
  191.      * @param string $strConnection Name of connection
  192.      *
  193.      * @return void 
  194.      */
  195.     public function initConnection($strConnection)
  196.     {
  197.         $arConfig $this->getConfigParameter($strConnection);
  198.         $strHandler $arConfig['handler'];
  199.  
  200.         $strFile str_replace('_''/'$strHandler'.php';
  201.  
  202.         $rIncludeFile @fopen($strFile'r'true);
  203.         if ($rIncludeFile{
  204.             fclose($rIncludeFile);
  205.             $ret include_once $strFile;
  206.             if (!$ret{
  207.                 $this->application->getResponse()->addError('DataHandler not includeable.');
  208.             else {
  209.                 $handlernew $strHandler($this->application);
  210.             }
  211.         else {
  212.             $this->application->getResponse()->addError(
  213.                 'DataHandler Controller File "'.htmlspecialchars($strFile).'" not found'
  214.             );
  215.         }
  216.  
  217.         $this->arConnectionCache[$strConnection$handler;
  218.     }
  219. }
  220.  
  221. ?>

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