inc/main/interfaces/database/class_DatabaseWrapper.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\Wrapper\Database;
   4
   5 // Import framework stuff
   6 use CoreFramework\Generic\FrameworkInterface;
   7
   8 /**
   9  * The general interface for all other database wrappers
  10  *
  11  * @author              Roland Haeder <webmaster@shipsimu.org>
  12  * @version             0.0.0
  13  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  14  * @license             GNU GPL 3.0 or any newer version
  15  * @link                http://www.shipsimu.org
  16  *
  17  * This program is free software: you can redistribute it and/or modify
  18  * it under the terms of the GNU General Public License as published by
  19  * the Free Software Foundation, either version 3 of the License, or
  20  * (at your option) any later version.
  21  *
  22  * This program is distributed in the hope that it will be useful,
  23  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  24  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  25  * GNU General Public License for more details.
  26  *
  27  * You should have received a copy of the GNU General Public License
  28  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  29  */
  30 interface DatabaseWrapper extends FrameworkInterface {
  31         /**
  32          * Getter for index key
  33          *
  34          * @return      $indexKey       Index key
  35          */
  36         function getIndexKey();
  37
  38         /**
  39          * Getter for last exception
  40          *
  41          * @return      $lastException  Last exception or NULL if none occured
  42          */
  43         function getLastException();
  44
  45         /**
  46          * Do a "select" query on the current table with the given search criteria and
  47          * store it in cache for later usage
  48          *
  49          * @param       $criteriaInstance       An instance of a Criteria class
  50          * @param       $onlyKeys                       Only use these keys for a cache key
  51          * @return      $resultInstance         An instance of a database result class
  52          */
  53         function doSelectByCriteria(Criteria $criteriaInstance, array $onlyKeys = array());
  54
  55         /**
  56          * Count the numbers of rows we shall receive
  57          *
  58          * @param       $criteriaInstance       An instance of a Criteria class
  59          * @param       $onlyKeys                       Only use these keys for a cache key
  60          * @return      $numRows                        Numbers of rows of database entries
  61          */
  62         function doSelectCountByCriteria(Criteria $criteriaInstance, $onlyKeys = array());
  63
  64         /**
  65          * Getter for primary key used in wrapped table
  66          *
  67          * @return      $primaryKey             Primary key used in wrapped table
  68          */
  69         function getPrimaryKeyValue();
  70
  71         /**
  72          * Counts total rows of this table
  73          *
  74          * @return      $count  Total rows of this table
  75          */
  76         function countTotalRows();
  77
  78 }