3 * A database wrapper for the User class
5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
24 class UserDatabaseWrapper extends BaseDatabaseWrapper {
25 // Constants for exceptions
26 const EXCEPTION_CLIENT_USERNAME_NOT_FOUND = 0x180;
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 const DB_COLUMN_USER_STATUS = "user_status";
34 // Constants for database table names
35 const DB_TABLE_USER = "user";
38 * Protected constructor
42 protected function __construct() {
43 // Call parent constructor
44 parent::__construct(__CLASS__);
48 * Creates an instance of this database wrapper by a provided user class
50 * @return $wrapperInstance An instance of the created wrapper class
51 * @throws WrapperUserNameNotFoundException If the supplied username
54 public final static function createUserDatabaseWrapper () {
56 $wrapperInstance = new UserDatabaseWrapper();
58 // Set (primary!) table name
59 $wrapperInstance->setTableName(self::DB_TABLE_USER);
61 // Return the instance
62 return $wrapperInstance;
66 * Handles inserting the registration data from a registration instance into the database
68 * @param $registrationInstance An instance of a registration class
71 public function insertRegistrationObject (UserRegister $registrationInstance) {
72 // Generate a data set for the request
73 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_USER));
75 // Set the primary key
76 $dataSetInstance->setUniqueKey('username');
78 // Add registration elements to the dataset
79 $registrationInstance->addElementsToDataSet($dataSetInstance);
81 // "Insert" this request instance completely into the database
82 $this->getDatabaseInstance()->queryInsertDataSet($dataSetInstance);
86 * Updates an user database entry with given result
88 * @param $resultInstance An instance of a Updateable database result
91 public function doUpdateByResult (UpdateableResult $resultInstance) {
92 // Generate a data set object
93 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_USER));
95 // Add all update criteria to the database set
96 $resultInstance->addElementsToDataSet($dataSetInstance);
99 $dataSetInstance->setSearchInstance($resultInstance->getSearchInstance());
101 // Set the primary key
102 $dataSetInstance->setUniqueKey('username');
104 // "Update" this request with the database
105 $this->getDatabaseInstance()->queryUpdateDataSet($dataSetInstance);