X-Git-Url: https://git.mxchange.org/?p=core.git;a=blobdiff_plain;f=inc%2Fclasses%2Finterfaces%2Fdatabase%2Fclass_DatabaseWrapper.php;h=039622568499e34a25059e318a520899127889ac;hp=c63b4bb01f7c92708ad2c16b5c656bb8a3de53b0;hb=70a00fd84fd8d07e075a3479d3475e1a8f36a772;hpb=934bf68d55d63c6f5f7d121b0c1492badc277ace diff --git a/inc/classes/interfaces/database/class_DatabaseWrapper.php b/inc/classes/interfaces/database/class_DatabaseWrapper.php index c63b4bb0..03962256 100644 --- a/inc/classes/interfaces/database/class_DatabaseWrapper.php +++ b/inc/classes/interfaces/database/class_DatabaseWrapper.php @@ -2,11 +2,11 @@ /** * The general interface for all other database wrappers * - * @author Roland Haeder + * @author Roland Haeder * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2012 Core Developer Team + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team * @license GNU GPL 3.0 or any newer version - * @link http://www.ship-simu.org + * @link http://www.shipsimu.org * * This program is free software: you can redistribute it and/or modify * it under the terms of the GNU General Public License as published by @@ -22,6 +22,52 @@ * along with this program. If not, see . */ interface DatabaseWrapper extends FrameworkInterface { + /** + * Getter for index key + * + * @return $indexKey Index key + */ + function getIndexKey(); + + /** + * Getter for last exception + * + * @return $lastException Last exception or NULL if none occured + */ + function getLastException(); + + /** + * Do a "select" query on the current table with the given search criteria and + * store it in cache for later usage + * + * @param $criteriaInstance An instance of a Criteria class + * @param $onlyKeys Only use these keys for a cache key + * @return $resultInstance An instance of a database result class + */ + function doSelectByCriteria(Criteria $criteriaInstance, array $onlyKeys = array()); + + /** + * Count the numbers of rows we shall receive + * + * @param $criteriaInstance An instance of a Criteria class + * @param $onlyKeys Only use these keys for a cache key + * @return $numRows Numbers of rows of database entries + */ + function doSelectCountByCriteria(Criteria $criteriaInstance, $onlyKeys = array()); + + /** + * Getter for primary key used in wrapped table + * + * @return $primaryKey Primary key used in wrapped table + */ + function getPrimaryKeyValue(); + + /** + * Counts total rows of this table + * + * @return $count Total rows of this table + */ + function countTotalRows(); } // [EOF]