Renamed to DatabaseBackend to get rid of word 'Interface' in an interface name as...
authorRoland Haeder <roland@mxchange.org>
Tue, 4 Feb 2014 19:41:53 +0000 (20:41 +0100)
committerRoland Haeder <roland@mxchange.org>
Tue, 4 Feb 2014 19:41:53 +0000 (20:41 +0100)
Signed-off-by: Roland H├Ąder <roland@mxchange.org>
inc/classes/interfaces/database/backend/class_DatabaseBackend.php [new file with mode: 0644]
inc/classes/interfaces/database/backend/class_DatabaseBackendInterface.php [deleted file]
inc/classes/main/database/class_BaseDatabaseBackend.php
inc/classes/main/database/databases/class_LocalFileDatabase.php
inc/classes/middleware/database/class_DatabaseConnection.php

diff --git a/inc/classes/interfaces/database/backend/class_DatabaseBackend.php b/inc/classes/interfaces/database/backend/class_DatabaseBackend.php
new file mode 100644 (file)
index 0000000..30a2182
--- /dev/null
@@ -0,0 +1,68 @@
+<?php
+/**
+ * An interface for front-end database classes. The classes should prepare the
+ * objects for saving in the database. So for server-bases database classes SQL
+ * queries shall be generated and send to the backend classes. In case of local
+ * file databases the object shall be serialized and (maybe) transparently
+ * compressed before they got saved to a local file.
+ *
+ * @author             Roland Haeder <webmaster@shipsimu.org>
+ * @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 <http://www.gnu.org/licenses/>.
+ */
+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 (file)
index ea7710d..0000000
+++ /dev/null
@@ -1,68 +0,0 @@
-<?php
-/**
- * An interface for front-end database classes. The classes should prepare the
- * objects for saving in the database. So for server-bases database classes SQL
- * queries shall be generated and send to the backend classes. In case of local
- * file databases the object shall be serialized and (maybe) transparently
- * compressed before they got saved to a local file.
- *
- * @author             Roland Haeder <webmaster@shipsimu.org>
- * @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 <http://www.gnu.org/licenses/>.
- */
-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]
-?>
index 9dd41a9..5c0d29b 100644 (file)
@@ -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 <webmaster@shipsimu.org>
  * @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 <http://www.gnu.org/licenses/>.
  */
-abstract class BaseDatabaseBackend extends BaseFrameworkSystem implements DatabaseBackendInterface {
+abstract class BaseDatabaseBackend extends BaseFrameworkSystem implements DatabaseBackend {
        // Constants for exceptions
        const EXCEPTION_SQL_QUERY = 0x140;
 
index e7378df..445b7f8 100644 (file)
@@ -27,7 +27,7 @@
  * You should have received a copy of the GNU General Public License
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
-class LocalFileDatabase extends BaseDatabaseBackend implements DatabaseBackendInterface {
+class LocalFileDatabase extends BaseDatabaseBackend implements DatabaseBackend {
        /**
         * The file's extension
         */
index 95b0147..318073c 100644 (file)
@@ -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;
        }