3 * The general interface for all other database wrappers
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
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.
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.
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/>.
24 interface DatabaseWrapper extends FrameworkInterface {
26 * Getter for index key
28 * @return $indexKey Index key
30 function getIndexKey();
33 * Getter for last exception
35 * @return $lastException Last exception or NULL if none occured
37 function getLastException();
40 * Do a "select" query on the current table with the given search criteria and
41 * store it in cache for later usage
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
47 function doSelectByCriteria(Criteria $criteriaInstance, array $onlyKeys = array());
50 * Count the numbers of rows we shall receive
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
56 function doSelectCountByCriteria(Criteria $criteriaInstance, $onlyKeys = array());
59 * Getter for primary key used in wrapped table
61 * @return $primaryKey Primary key used in wrapped table
63 function getPrimaryKeyValue();
66 * Counts total rows of this table
68 * @return $count Total rows of this table
70 function countTotalRows();