framework/main/interfaces/database/class_DatabaseWrapper.php

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