inc/classes/interfaces/database/class_DatabaseWrapper.php

   1 <?php
   2 /**
   3  * The general interface for all other database wrappers
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.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 DatabaseWrapper extends FrameworkInterface {
  25         /**
  26          * Getter for index key
  27          *
  28          * @return      $indexKey       Index key
  29          */
  30         function getIndexKey();
  31
  32         /**
  33          * Getter for last exception
  34          *
  35          * @return      $lastException  Last exception or NULL if none occured
  36          */
  37         function getLastException();
  38
  39         /**
  40          * Do a "select" query on the current table with the given search criteria and
  41          * store it in cache for later usage
  42          *
  43          * @param       $criteriaInstance       An instance of a Criteria class
  44          * @param       $onlyKeys                       Only use these keys for a cache key
  45          * @return      $resultInstance         An instance of a database result class
  46          */
  47         function doSelectByCriteria(Criteria $criteriaInstance, array $onlyKeys = array());
  48
  49         /**
  50          * Count the numbers of rows we shall receive
  51          *
  52          * @param       $criteriaInstance       An instance of a Criteria class
  53          * @param       $onlyKeys                       Only use these keys for a cache key
  54          * @return      $numRows                        Numbers of rows of database entries
  55          */
  56         function doSelectCountByCriteria(Criteria $criteriaInstance, $onlyKeys =  array());
  57
  58         /**
  59          * Getter for primary key used in wrapped table
  60          *
  61          * @return      $primaryKey             Primary key used in wrapped table
  62          */
  63         function getPrimaryKeyValue();
  64 }
  65
  66 // [EOF]
  67 ?>