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   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. {
  48.     /**
  49.      * Constructor
  50.      *
  51.      * @param ForwardFW_Interface_Application $application The running application
  52.      *
  53.      * @return void 
  54.      */
  55.     public function __construct(
  56.         ForwardFW_Interface_Application $application
  57.     );
  58.  
  59.     /**
  60.      * Calls the loading if it isn't in cache or cache timed out.
  61.      *
  62.      * @param string  $strConnection Name of connection defined in conf.
  63.      * @param array   $arOptions     Operations for this load.
  64.      * @param integer $nCacheTimeout Cache lifetime, -1 to use default.
  65.      *
  66.      * @return mixed The response Data
  67.      */
  68.     public function loadFromCached(
  69.         $strConnectionarray $arOptions$nCacheTimeout = -1
  70.     );
  71.  
  72.     /**
  73. /**
  74.      * Load method.
  75.      *
  76.      * @param string $strConnection Name of connection defined in conf.
  77.      * @param array  $arOptions     Operations for this load.
  78.      *
  79.      * @return mixed The response Data
  80.      */
  81.     public function loadFrom($strConnectionarray $arOptions);
  82.  
  83.     /**
  84. /**
  85.      * Save method.
  86.      *
  87.      * @param string $strConnection Name of connection defined in conf.
  88.      * @param array  $options       Operations for the saving.
  89.      *
  90.      * @return boolean 
  91.      */
  92.     public function saveTo($strConnectionarray $options);
  93.  
  94.     /**
  95. /**
  96.      * Initialize the given connection.
  97.      *
  98.      * @param string $strConnection Name of connection defined in conf.
  99.      *
  100.      * @return void 
  101.      */
  102.     public function initConnection($strConnection);
  103. }
  104. ?>

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