inc/classes/interfaces/database/frontend/class_DatabaseFrontendInterface.php

   1 <?php
   2 /**
   3  * An interface for front-end database classes. The classes should prepare the
   4  * objects for saving in the database. So for server-bases database classes SQL
   5  * queries shall be generated and send to the backend classes. In case of local
   6  * file databases the object shall be serialized and (maybe) transparently
   7  * compressed before they got saved to a local file.
   8  *
   9  * @author              Roland Haeder <webmaster@ship-simu.org>
  10  * @version             0.0.0
  11  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
  12  * @license             GNU GPL 3.0 or any newer version
  13  * @link                http://www.ship-simu.org
  14  *
  15  * This program is free software: you can redistribute it and/or modify
  16  * it under the terms of the GNU General Public License as published by
  17  * the Free Software Foundation, either version 3 of the License, or
  18  * (at your option) any later version.
  19  *
  20  * This program is distributed in the hope that it will be useful,
  21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  23  * GNU General Public License for more details.
  24  *
  25  * You should have received a copy of the GNU General Public License
  26  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  27  */
  28 interface DatabaseFrontendInterface extends FrameworkDatabaseInterface {
  29         /**
  30          * Loads data saved with saveObject from the database and re-creates a
  31          * full object from it.
  32          * If limitObject() was called before a new object ObjectContainer with
  33          * all requested attributes will be returned instead.
  34          *
  35          * @return      Object  The fully re-created object or instance to
  36          *                                      ObjectContainer
  37          */
  38         function loadObject ();
  39 }
  40
  41 // [EOF]
  42 ?>