3 * A database wrapper for the User class
5 * @author Roland Haeder <webmaster@ship-simu.org>
7 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core Developer Team
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 implements ManageableAccountWrapper {
25 // Constants for exceptions
26 const EXCEPTION_CLIENT_USERNAME_NOT_FOUND = 0x180;
28 // Constants for database columns
29 const DB_COLUMN_USERID = 'userid';
30 const DB_COLUMN_USERNAME = 'username';
31 const DB_COLUMN_EMAIL = 'email';
32 const DB_COLUMN_CONFIRM_HASH = 'confirm_hash';
33 const DB_COLUMN_USER_STATUS = 'user_status';
35 // Constants for database table names
36 const DB_TABLE_USER = 'user';
39 * Protected constructor
43 protected function __construct () {
44 // Call parent constructor
45 parent::__construct(__CLASS__);
49 * Creates an instance of this database wrapper by a provided user class
51 * @return $wrapperInstance An instance of the created wrapper class
53 public final static function createUserDatabaseWrapper () {
55 $wrapperInstance = new UserDatabaseWrapper();
57 // Set (primary!) table name
58 $wrapperInstance->setTableName(self::DB_TABLE_USER);
60 // Return the instance
61 return $wrapperInstance;
65 * Getter for index key
67 * @return $indexKey Index key
69 public final function getIndexKey () {
70 return $this->getDatabaseInstance()->getIndexKey();
74 * Handles inserting the registration data from a registration instance into the database
76 * @param $registrationInstance An instance of a registration class
79 public function insertRegistrationObject (UserRegister $registrationInstance) {
80 // Generate a data set for the request
81 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_USER));
83 // Set the primary key
84 $dataSetInstance->setUniqueKey(self::DB_COLUMN_USERNAME);
86 // Add registration elements to the dataset
87 $registrationInstance->addElementsToDataSet($dataSetInstance);
89 // "Insert" this request instance completely into the database
90 $this->getDatabaseInstance()->queryInsertDataSet($dataSetInstance);
94 * Updates an user database entry with given result
96 * @param $resultInstance An instance of a Updateable database result
98 * @throws NullPointerException If $updateInstance or $searchInstance is null
100 public function doUpdateByResult (UpdateableResult $resultInstance) {
101 // Get the search instance from result
102 $searchInstance = $resultInstance->getSearchInstance();
105 if (is_null($searchInstance)) {
106 // Get the update instance
107 $updateInstance = $resultInstance->getUpdateInstance();
110 if (is_null($updateInstance)) {
111 // Throw an exception here
112 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
115 // Get search instance from update instance
116 $searchInstance = $updateInstance->getSearchInstance();
119 if (is_null($searchInstance)) {
120 // Throw an exception here
121 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
125 // Generate a data set object
126 $dataSetInstance = ObjectFactory::createObjectByConfiguredName('dataset_criteria_class', array(self::DB_TABLE_USER));
128 // Add seach criteria
129 $dataSetInstance->setSearchInstance($searchInstance);
131 // Set the primary key
132 $dataSetInstance->setUniqueKey(self::DB_COLUMN_USERNAME);
134 // Add all update criteria to the database set
135 $resultInstance->addElementsToDataSet($dataSetInstance);
137 // "Update" this request with the database
138 $this->getDatabaseInstance()->queryUpdateDataSet($dataSetInstance);