3 namespace CoreFramework\Wrapper\Database;
5 // Import framework stuff
6 use CoreFramework\Criteria\Criteria;
7 use CoreFramework\Generic\FrameworkInterface;
10 * The general interface for all other database wrappers
12 * @author Roland Haeder <webmaster@shipsimu.org>
14 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
15 * @license GNU GPL 3.0 or any newer version
16 * @link http://www.shipsimu.org
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.
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.
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/>.
31 interface DatabaseWrapper extends FrameworkInterface {
33 * Getter for index key
35 * @return $indexKey Index key
37 function getIndexKey();
40 * Getter for last exception
42 * @return $lastException Last exception or NULL if none occured
44 function getLastException();
47 * Do a "select" query on the current table with the given search criteria and
48 * store it in cache for later usage
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
54 function doSelectByCriteria(Criteria $criteriaInstance, array $onlyKeys = array());
57 * Count the numbers of rows we shall receive
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
63 function doSelectCountByCriteria(Criteria $criteriaInstance, $onlyKeys = array());
66 * Getter for primary key used in wrapped table
68 * @return $primaryKey Primary key used in wrapped table
70 function getPrimaryKeyValue();
73 * Counts total rows of this table
75 * @return $count Total rows of this table
77 function countTotalRows();