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 18aabb060cbd68f9a2268901a3ddf33e60d0d4f5..503fbadb02089e2e2f0007fec6b077d5e406135a 100644 (file)
--- a/inc/classes/main/database/wrapper/class_UserDatabaseWrapper.php
+++ b/inc/classes/main/database/wrapper/class_UserDatabaseWrapper.php
@@ -1,13 +1,12 @@
 <?php
 /**
- * A database client for the User class
+ * 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
+ * @link               http://www.ship-simu.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
@@ -23,8 +22,18 @@
  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  */
 class UserDatabaseWrapper extends BaseDatabaseWrapper {
-       // Constants
-       const EXCEPTION_CLIENT_USERNAME_NOT_FOUND = 0xe00;
+       // Constants for exceptions
+       const EXCEPTION_CLIENT_USERNAME_NOT_FOUND = 0x180;
+
+       // Constants for database columns
+       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";
 
        /**
         * Protected constructor
@@ -34,37 +43,74 @@ class UserDatabaseWrapper extends BaseDatabaseWrapper {
        protected function __construct() {
                // Call parent constructor
                parent::__construct(__CLASS__);
+       }
+
+       /**
+        * Creates an instance of this database wrapper by a provided user class
+        *
+        * @return      $wrapperInstance        An instance of the created wrapper class
+        */
+       public final static function createUserDatabaseWrapper () {
+               // Get a new instance
+               $wrapperInstance = new UserDatabaseWrapper();
 
-               // Set part description
-               $this->setObjectDescription("Database client for user objects");
+               // Set (primary!) table name
+               $wrapperInstance->setTableName(self::DB_TABLE_USER);
 
-               // Create unique ID number
-               $this->createUniqueID();
+               // Return the instance
+               return $wrapperInstance;
        }
 
        /**
-        * Creates an instance of this database client by a provided user class
+        * Getter for index key
         *
-        * @param       $userInstance           An instance of a user class
-        * @return      $clientInstance         An instance of the created client class
-        * @throws      WrapperUserNameNotFoundException                If the supplied username
-        *                                                                                              does not exist
+        * @return      $indexKey       Index key
         */
-       public final static function createUserDatabaseWrapper (ManageableUser $userInstance) {
-               // Get a new instance
-               $clientInstance = new UserDatabaseWrapper();
+       public final function getIndexKey () {
+               return $this->getDatabaseInstance()->getIndexKey();
+       }
 
-               // Does the username exists?
-               if (!$clientInstance->ifUserNameExists($userInstance->getUserName())) {
-                       // Throw an exception here
-                       throw new WrapperUserNameNotFoundException (array($clientInstance, $userInstance), self::EXCEPTION_CLIENT_USERNAME_NOT_FOUND);
-               }
+       /**
+        * Handles inserting the registration data from a registration instance into the database
+        *
+        * @param       $registrationInstance   An instance of a registration class
+        * @return      void
+        */
+       public function insertRegistrationObject (UserRegister $registrationInstance) {
+               // Generate a data set for the request
+               $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_USER));
 
-               // The user exists
-               $clientInstance->partialStub("Add loading of full user details");
+               // Set the primary key
+               $dataSetInstance->setUniqueKey('username');
 
-               // Return the instance
-               return $clientInstance;
+               // Add registration elements to the dataset
+               $registrationInstance->addElementsToDataSet($dataSetInstance);
+
+               // "Insert" this request instance completely into the database
+               $this->getDatabaseInstance()->queryInsertDataSet($dataSetInstance);
+       }
+
+       /**
+        * Updates an user database entry with given result
+        *
+        * @param       $resultInstance         An instance of a Updateable database result
+        * @return      void
+        */
+       public function doUpdateByResult (UpdateableResult $resultInstance) {
+               // Generate a data set object
+               $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_USER));
+
+               // Add all update criteria to the database set
+               $resultInstance->addElementsToDataSet($dataSetInstance);
+
+               // Add seach criteria
+               $dataSetInstance->setSearchInstance($resultInstance->getSearchInstance());
+
+               // Set the primary key
+               $dataSetInstance->setUniqueKey('username');
+
+               // "Update" this request with the database
+               $this->getDatabaseInstance()->queryUpdateDataSet($dataSetInstance);
        }
 }