From: Roland Haeder Date: Tue, 4 Feb 2014 19:41:53 +0000 (+0100) Subject: Renamed to DatabaseBackend to get rid of word 'Interface' in an interface name as... X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=54dce2f61472927289ae152afedf1aeaf076e8b1;p=core.git Renamed to DatabaseBackend to get rid of word 'Interface' in an interface name as this is twice over. Signed-off-by: Roland Häder --- diff --git a/inc/classes/interfaces/database/backend/class_DatabaseBackend.php b/inc/classes/interfaces/database/backend/class_DatabaseBackend.php new file mode 100644 index 00000000..30a2182b --- /dev/null +++ b/inc/classes/interfaces/database/backend/class_DatabaseBackend.php @@ -0,0 +1,68 @@ + + * @version 0.0.0 + * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team + * @license GNU GPL 3.0 or any newer version + * @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 + * the Free Software Foundation, either version 3 of the License, or + * (at your option) any later version. + * + * This program is distributed in the hope that it will be useful, + * but WITHOUT ANY WARRANTY; without even the implied warranty of + * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + * GNU General Public License for more details. + * + * You should have received a copy of the GNU General Public License + * along with this program. If not, see . + */ +interface DatabaseBackend extends FrameworkDatabaseInterface { + /** + * Makes sure that the database connection is up and alive + * + * @return void + */ + function connectToDatabase (); + + /** + * Starts a SELECT query on the database by given return type, table name + * and search criteria + * + * @param $tableName Name of the database table + * @param $criteria Search criteria class + * @return $resultData Result data of the query + * @throws UnsupportedCriteriaException If the criteria is unsupported + * @throws SqlException If an SQL error occurs + */ + function querySelect ($tableName, LocalSearchCriteria $criteriaInstance); + + /** + * 'Inserts' a data set instance into a local file database folder + * + * @param $dataSetInstance A storeable data set + * @return void + * @throws SqlException If an SQL error occurs + */ + function queryInsertDataSet (StoreableCriteria $dataSetInstance); + + /** + * 'Updates' a data set instance with a database layer + * + * @param $dataSetInstance A storeable data set + * @return void + * @throws SqlException If an SQL error occurs + */ + function queryUpdateDataSet (StoreableCriteria $dataSetInstance); +} + +// [EOF] +?> diff --git a/inc/classes/interfaces/database/backend/class_DatabaseBackendInterface.php b/inc/classes/interfaces/database/backend/class_DatabaseBackendInterface.php deleted file mode 100644 index ea7710dd..00000000 --- a/inc/classes/interfaces/database/backend/class_DatabaseBackendInterface.php +++ /dev/null @@ -1,68 +0,0 @@ - - * @version 0.0.0 - * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team - * @license GNU GPL 3.0 or any newer version - * @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 - * the Free Software Foundation, either version 3 of the License, or - * (at your option) any later version. - * - * This program is distributed in the hope that it will be useful, - * but WITHOUT ANY WARRANTY; without even the implied warranty of - * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the - * GNU General Public License for more details. - * - * You should have received a copy of the GNU General Public License - * along with this program. If not, see . - */ -interface DatabaseBackendInterface extends FrameworkDatabaseInterface { - /** - * Makes sure that the database connection is up and alive - * - * @return void - */ - function connectToDatabase (); - - /** - * Starts a SELECT query on the database by given return type, table name - * and search criteria - * - * @param $tableName Name of the database table - * @param $criteria Search criteria class - * @return $resultData Result data of the query - * @throws UnsupportedCriteriaException If the criteria is unsupported - * @throws SqlException If an SQL error occurs - */ - function querySelect ($tableName, LocalSearchCriteria $criteriaInstance); - - /** - * 'Inserts' a data set instance into a local file database folder - * - * @param $dataSetInstance A storeable data set - * @return void - * @throws SqlException If an SQL error occurs - */ - function queryInsertDataSet (StoreableCriteria $dataSetInstance); - - /** - * 'Updates' a data set instance with a database layer - * - * @param $dataSetInstance A storeable data set - * @return void - * @throws SqlException If an SQL error occurs - */ - function queryUpdateDataSet (StoreableCriteria $dataSetInstance); -} - -// [EOF] -?> diff --git a/inc/classes/main/database/class_BaseDatabaseBackend.php b/inc/classes/main/database/class_BaseDatabaseBackend.php index 9dd41a9c..5c0d29be 100644 --- a/inc/classes/main/database/class_BaseDatabaseBackend.php +++ b/inc/classes/main/database/class_BaseDatabaseBackend.php @@ -2,7 +2,7 @@ /** * An abstract database access class for handling database I/O requests * - * @see DatabaseBackendInterface - An interface for database backends + * @see DatabaseBackend - An interface for database backends * @author Roland Haeder * @version 0.0.0 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core Developer Team @@ -22,7 +22,7 @@ * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ -abstract class BaseDatabaseBackend extends BaseFrameworkSystem implements DatabaseBackendInterface { +abstract class BaseDatabaseBackend extends BaseFrameworkSystem implements DatabaseBackend { // Constants for exceptions const EXCEPTION_SQL_QUERY = 0x140; diff --git a/inc/classes/main/database/databases/class_LocalFileDatabase.php b/inc/classes/main/database/databases/class_LocalFileDatabase.php index e7378df5..445b7f8d 100644 --- a/inc/classes/main/database/databases/class_LocalFileDatabase.php +++ b/inc/classes/main/database/databases/class_LocalFileDatabase.php @@ -27,7 +27,7 @@ * You should have received a copy of the GNU General Public License * along with this program. If not, see . */ -class LocalFileDatabase extends BaseDatabaseBackend implements DatabaseBackendInterface { +class LocalFileDatabase extends BaseDatabaseBackend implements DatabaseBackend { /** * The file's extension */ diff --git a/inc/classes/middleware/database/class_DatabaseConnection.php b/inc/classes/middleware/database/class_DatabaseConnection.php index 95b01476..318073c8 100644 --- a/inc/classes/middleware/database/class_DatabaseConnection.php +++ b/inc/classes/middleware/database/class_DatabaseConnection.php @@ -49,7 +49,7 @@ class DatabaseConnection extends BaseMiddleware implements DatabaseConnector, Re } // Create new database connection layer - public static final function createDatabaseConnection (DebugMiddleware $debugInstance, DatabaseBackendInterface $dbLayer) { + public static final function createDatabaseConnection (DebugMiddleware $debugInstance, DatabaseBackend $dbLayer) { // Get instance $databaseInstance = new DatabaseConnection(); @@ -91,7 +91,7 @@ class DatabaseConnection extends BaseMiddleware implements DatabaseConnector, Re * @param $dbLayer An instance of the real database layer * @return void */ - public final function setDatabaseLayer (DatabaseBackendInterface $dbLayer) { + public final function setDatabaseLayer (DatabaseBackend $dbLayer) { $this->dbLayer = $dbLayer; }