Opps, forgot this.

[core.git] / inc / classes / main / database / class_BaseDatabaseBackend.php

diff --git a/inc/classes/main/database/class_BaseDatabaseBackend.php b/inc/classes/main/database/class_BaseDatabaseBackend.php
index bd9fde97c02b3795798cbae2b89859672f29295e..62805655864f331c5c17a68181bae3538d4d98ae 100644 (file)
--- a/inc/classes/main/database/class_BaseDatabaseBackend.php
+++ b/inc/classes/main/database/class_BaseDatabaseBackend.php
@@ -2,12 +2,12 @@
 /**
  * An abstract database access class for handling database I/O requests
  *
- * @see                        DatabaseBackendInterface - An interface for database backends
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @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 - 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,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;
 
@@ -31,6 +31,14 @@ abstract class BaseDatabaseBackend extends BaseFrameworkSystem implements Databa
        const RESULT_INDEX_STATUS    = 'status';
        const RESULT_INDEX_EXCEPTION = 'exception';
 
+       // Constants for MySQL backward-compatiblity (PLEASE FIX THEM!)
+       const DB_CODE_TABLE_MISSING     = 0x100;
+       const DB_CODE_TABLE_UNWRITEABLE = 0x101;
+       const DB_CODE_DATA_FILE_CORRUPT = 0x102;
+
+       // Status results
+       const RESULT_OKAY = 'ok';
+
        /**
         * Last thrown exception or NULL if all is fine
         */
@@ -75,6 +83,14 @@ abstract class BaseDatabaseBackend extends BaseFrameworkSystem implements Databa
        protected final function resetLastException () {
                $this->lastException = NULL;
        }
+
+       /**
+        * Removes non-public data from given array.
+        *
+        * @param       $data   An array with possible non-public data that needs to be removed.
+        * @return      $data   A cleaned up array with only public data.
+        */
+       public abstract function removeNonPublicDataFromArray (array $data);
 }
 
 // [EOF]