inc/classes/interfaces/database/class_FrameworkDatabaseInterface.php

   1 <?php
   2 /**
   3  * The general interface for all other database interfaces
   4  *
   5  * @author              Roland Haeder <webmaster@mxchange.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 interface FrameworkDatabaseInterface extends FrameworkInterface {
  25         /**
  26          * Saves a whole object by serializing it entirely or some specifyable
  27          * parts. Specifying parts must be done before this method is called. If
  28          * it is not done this method will serialize the whole object.
  29          *
  30          * @param               $object An instance to the object we want to save
  31          * @return      void
  32          * @see         limitObject(ObjectLimits)       limitObject
  33          */
  34         function saveObject ($object);
  35
  36         /**
  37          * Analyses if a unique ID has already been used or not. This method does
  38          * only pass the given ID through to the "real" database layer.
  39          *
  40          * @param               $uniqueID               A unique ID number which shall be checked
  41          *                                              before it will be used
  42          * @param               $inConstructor  If called from a constructor or from
  43          *                                              somewhere else
  44          * @return      $isUnused               true    = The unique ID was not found in the database,
  45          *                                              false = It is already in use by an other object
  46          * @throws      NullPointerException    If $dbInstance is null
  47          * @throws      NoObjectException               If $dbInstance is not an object
  48          * @throws      MissingMethodException  If the required method
  49          *                                                              isUniqueIdUsed() was not found
  50          */
  51         function isUniqueIdUsed ($uniqueID, $inConstructor = false);
  52
  53         /**
  54          * Gets cached data from the database layer and if not found fetch it from
  55          * the database again. This method does not return the header stuff because
  56          * The underlaying database class will return only the requested content.
  57          *
  58          * @param               $idNumber               The ID number which we need for looking up
  59          *                                              the requested data
  60          * @return      $cachedArray    The maybe cached data from the database
  61          * @throws      NullPointerException    If $dbInstance is null
  62          * @throws      NoObjectException               If $dbInstance is not an object
  63          * @throws      MissingMethodException  If the required method
  64          *                                                              isUniqueIdUsed() was not found
  65          */
  66         function getObjectFromCachedData ($idNumber);
  67 }
  68
  69 // [EOF]
  70 ?>