inc/classes/main/database/wrapper/class_UserDatabaseWrapper.php

   1 <?php
   2 /**
   3  * A database wrapper for the User class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class UserDatabaseWrapper extends BaseDatabaseWrapper {
  25         // Constants for exceptions
  26         const EXCEPTION_CLIENT_USERNAME_NOT_FOUND = 0x180;
  27
  28         // Constants for database columns
  29         const DB_COLUMN_USERNAME     = "username";
  30         const DB_COLUMN_EMAIL        = "email";
  31         const DB_COLUMN_CONFIRM_HASH = "confirm_hash";
  32
  33         // Constants for database table names
  34         const DB_TABLE_USER = "user";
  35
  36         /**
  37          * Protected constructor
  38          *
  39          * @return      void
  40          */
  41         protected function __construct() {
  42                 // Call parent constructor
  43                 parent::__construct(__CLASS__);
  44
  45                 // Set part description
  46                 $this->setObjectDescription("Database wrapper for user objects");
  47
  48                 // Create unique ID number
  49                 $this->generateUniqueId();
  50         }
  51
  52         /**
  53          * Creates an instance of this database wrapper by a provided user class
  54          *
  55          * @return      $wrapperInstance        An instance of the created wrapper class
  56          * @throws      WrapperUserNameNotFoundException        If the supplied username
  57          *                                                                                              does not exist
  58          */
  59         public final static function createUserDatabaseWrapper () {
  60                 // Get a new instance
  61                 $wrapperInstance = new UserDatabaseWrapper();
  62
  63                 // Set (primary!) table name
  64                 $wrapperInstance->setTableName(self::DB_TABLE_USER);
  65
  66                 // Return the instance
  67                 return $wrapperInstance;
  68         }
  69
  70         /**
  71          * Handles inserting the registration data from a registration instance into the database
  72          *
  73          * @param       $registrationInstance   An instance of a registration class
  74          * @return      void
  75          */
  76         public function insertRegistrationObject (UserRegister $registrationInstance) {
  77                 // Generate a data set for the request
  78                 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_USER));
  79
  80                 // Set the primary key
  81                 $dataSetInstance->setUniqueKey('username');
  82
  83                 // Add registration elements to the dataset
  84                 $registrationInstance->addElementsToDataSet($dataSetInstance);
  85
  86                 // "Insert" this request instance completely into the database
  87                 $this->getDatabaseInstance()->queryInsertDataSet($dataSetInstance);
  88         }
  89
  90         /**
  91          * Updates an user database entry with given result
  92          *
  93          * @param       $resultInstance         An instance of a Updateable database result
  94          * @return      void
  95          */
  96         public function doUpdateByResult (UpdateableResult $resultInstance) {
  97                 // Generate a data set object
  98                 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_USER));
  99
 100                 // Add all update criteria to the database set
 101                 $resultInstance->addElementsToDataSet($dataSetInstance);
 102
 103                 // Add seach criteria
 104                 $dataSetInstance->setSearchInstance($resultInstance->getSearchInstance());
 105
 106                 // Set the primary key
 107                 $dataSetInstance->setUniqueKey('username');
 108
 109                 // "Update" this request with the database
 110                 $this->getDatabaseInstance()->queryUpdateDataSet($dataSetInstance);
 111         }
 112 }
 113
 114 // [EOF]
 115 ?>