No longer thrown exceptions deprecated (still some there), naming-convention todo...

[shipsimu.git] / inc / classes / main / database / wrapper / class_UserDatabaseWrapper.php

diff --git a/inc/classes/main/database/wrapper/class_UserDatabaseWrapper.php b/inc/classes/main/database/wrapper/class_UserDatabaseWrapper.php
index 97e7344d23573322b3a1bc806091269b78c90441..503fbadb02089e2e2f0007fec6b077d5e406135a 100644 (file)
--- a/inc/classes/main/database/wrapper/class_UserDatabaseWrapper.php
+++ b/inc/classes/main/database/wrapper/class_UserDatabaseWrapper.php
@@ -2,10 +2,9 @@
 /**
  * A database wrapper for the User class
  *
- * @see                        DatabaseFrontendInterface - An interface for database frontends (front-end to the application)
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, this is free software
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -23,17 +22,15 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 class UserDatabaseWrapper extends BaseDatabaseWrapper {
-       /**
-        * Cache instance
-        */
-       private $cacheInstance = null;
-
        // Constants for exceptions
        const EXCEPTION_CLIENT_USERNAME_NOT_FOUND = 0x180;
 
        // Constants for database columns
-       const DB_COLUMN_USERNAME = "username";
-       const DB_COLUMN_EMAIL    = "email";
+       const DB_COLUMN_USERID       = "userid";
+       const DB_COLUMN_USERNAME     = "username";
+       const DB_COLUMN_EMAIL        = "email";
+       const DB_COLUMN_CONFIRM_HASH = "confirm_hash";
+       const DB_COLUMN_USER_STATUS  = "user_status";
 
        // Constants for database table names
        const DB_TABLE_USER = "user";
@@ -46,82 +43,31 @@ class UserDatabaseWrapper extends BaseDatabaseWrapper {
        protected function __construct() {
                // Call parent constructor
                parent::__construct(__CLASS__);
-
-               // Set part description
-               $this->setObjectDescription("Database wrapper for user objects");
-
-               // Create unique ID number
-               $this->generateUniqueId();
        }
 
        /**
         * Creates an instance of this database wrapper by a provided user class
         *
         * @return      $wrapperInstance        An instance of the created wrapper class
-        * @throws      WrapperUserNameNotFoundException        If the supplied username
-        *                                                                                              does not exist
         */
        public final static function createUserDatabaseWrapper () {
                // Get a new instance
                $wrapperInstance = new UserDatabaseWrapper();
 
-               // Initialize the cache instance
-               $wrapperInstance->initCacheInstance();
+               // Set (primary!) table name
+               $wrapperInstance->setTableName(self::DB_TABLE_USER);
 
                // Return the instance
                return $wrapperInstance;
        }
 
        /**
-        * Initializes the cache instance with a new object
+        * Getter for index key
         *
-        * @return      void
+        * @return      $indexKey       Index key
         */
-       protected function initCacheInstance () {
-               // Set the new instance
-               $this->cacheInstance = CacheFactory::getFactory()->createConfiguredCache();
-       }
-
-       /**
-        * Do a "select" query on the user table with the given search criteria and
-        * store it in cache for later usage
-        *
-        * @param       $criteriaInstance       An instance of a Criteria class
-        * @return      $resultInstance         An instance of a database result class
-        */
-       public function doSelectByCriteria (Criteria $criteriaInstance) {
-               // First get a key suitable for our cache and extend it with this class name
-               $cacheKey = sprintf("%s@%s",
-                       $this->__toString(),
-                       $criteriaInstance->getCacheKey()
-               );
-
-               // Does this key exists in cache?
-               if ($this->cacheInstance->offsetExists($cacheKey)) {
-                       // Then use this result
-                       $result = $cacheInstance->offsetGet($cacheKey);
-               } else {
-                       // Now it's time to ask the database layer for this select statement
-                       $result = $this->getDatabaseInstance()->doSelectByTableCriteria(self::DB_TABLE_USER, $criteriaInstance);
-
-                       // Cache the result if not null
-                       if (!is_null($result)) {
-                               // A valid result has returned from the database layer
-                               $this->cacheInstance->offsetSet($cacheKey, $result);
-                       } else {
-                               // This invalid result must be wrapped
-                               $result = array(
-                                       'status'                => "invalid",
-                                       'exception'             => $this->getDatabaseInstance()->getLastException()
-                               );
-                       }
-               }
-
-               // Create an instance of a DatabaseResult class with the given result
-               $resultInstance = DatabaseResult::createDatabaseResult($result);
-
-               // And return the instance
-               return $resultInstance;
+       public final function getIndexKey () {
+               return $this->getDatabaseInstance()->getIndexKey();
        }
 
        /**
@@ -132,8 +78,10 @@ class UserDatabaseWrapper extends BaseDatabaseWrapper {
         */
        public function insertRegistrationObject (UserRegister $registrationInstance) {
                // Generate a data set for the request
-               $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class');
-               $dataSetInstance->setTableName(self::DB_TABLE_USER);
+               $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_USER));
+
+               // Set the primary key
+               $dataSetInstance->setUniqueKey('username');
 
                // Add registration elements to the dataset
                $registrationInstance->addElementsToDataSet($dataSetInstance);
@@ -150,8 +98,7 @@ class UserDatabaseWrapper extends BaseDatabaseWrapper {
         */
        public function doUpdateByResult (UpdateableResult $resultInstance) {
                // Generate a data set object
-               $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class');
-               $dataSetInstance->setTableName(self::DB_TABLE_USER);
+               $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_USER));
 
                // Add all update criteria to the database set
                $resultInstance->addElementsToDataSet($dataSetInstance);
@@ -159,7 +106,7 @@ class UserDatabaseWrapper extends BaseDatabaseWrapper {
                // Add seach criteria
                $dataSetInstance->setSearchInstance($resultInstance->getSearchInstance());
 
-               // Add the primary key
+               // Set the primary key
                $dataSetInstance->setUniqueKey('username');
 
                // "Update" this request with the database