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