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

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   DataLoader
  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.7
  31.  */
  32.  
  33. /**
  34.  *
  35.  */
  36.  
  37. /**
  38.  * Interface for a DataLoader.
  39.  *
  40.  * @category   DataLoader
  41.  * @package    ForwardFW
  42.  * @subpackage Interface
  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. interface ForwardFW_Interface_DataHandler
  48. {
  49.     /**
  50.      * Constructor
  51.      *
  52.      * @param ForwardFW_Interface_Application $application The running application
  53.      *
  54.      * @return void 
  55.      */
  56.     public function __construct(
  57.         ForwardFW_Interface_Application $application
  58.     );
  59.  
  60.     /**
  61.      * Calls the loading if it isn't in cache or cache timed out.
  62.      *
  63.      * @param string  $strConnection Name of connection defined in conf.
  64.      * @param array   $arOptions     Operations for this load.
  65.      * @param integer $nCacheTimeout Cache lifetime, -1 to use default.
  66.      *
  67.      * @return mixed The response Data
  68.      */
  69.     public function loadFromCached(
  70.         $strConnection, array $arOptions, $nCacheTimeout = -1
  71.     );
  72.  
  73.     /**
  74. /**
  75.      * Load method.
  76.      *
  77.      * @param string $strConnection Name of connection defined in conf.
  78.      * @param array  $arOptions     Operations for this load.
  79.      *
  80.      * @return mixed The response Data
  81.      */
  82.     public function loadFrom($strConnection, array $arOptions);
  83.  
  84.     /**
  85. /**
  86.      * Save method.
  87.      *
  88.      * @param string $strConnection Name of connection defined in conf.
  89.      * @param array  $options       Operations for the saving.
  90.      *
  91.      * @return boolean 
  92.      */
  93.     public function saveTo($strConnection, array $options);
  94.  
  95.     /**
  96. /**
  97.      * Initialize the given connection.
  98.      *
  99.      * @param string $strConnection Name of connection defined in conf.
  100.      *
  101.      * @return void 
  102.      */
  103.     public function initConnection($strConnection);
  104. }
  105. ?>
Documentation generated on Sun, 30 Jan 2011 20:46:39 +0100 by phpDocumentor 1.4.3