3 * A generic class for handling users
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 Member extends BaseUser implements ManageableMember, Registerable, Updateable {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
34 // Set part description
35 $this->setObjectDescription("Generic user class");
37 // Create unique ID number
38 $this->generateUniqueId();
42 * Destructor to always flush updates
46 public function __destruct () {
47 // Flush any updated entries to the database
48 $this->flushPendingUpdates();
50 // Call parent destructor
55 * Creates an instance of this user class by a provided username. This
56 * factory method will check if the username is already taken and if not
57 * so it will throw an exception.
59 * @param $userName Username we need a class instance for
60 * @return $userInstance An instance of this user class
61 * @throws UsernameMissingException If the username does not exist
63 public final static function createMemberByUsername ($userName) {
65 $userInstance = new Member();
68 $userInstance->setUserName($userName);
70 // Check if the username exists
71 if (!$userInstance->ifUsernameExists()) {
72 // Throw an exception here
73 throw new UsernameMissingException(array($userInstance, $userName), self::EXCEPTION_USERNAME_NOT_FOUND);
76 // Return the instance
81 * Creates an instance of this user class by a provided email address. This
82 * factory method will not check if the email address is there.
84 * @param $email Email address of the user
85 * @return $userInstance An instance of this user class
87 public final static function createMemberByEmail ($email) {
89 $userInstance = new Member();
92 $userInstance->setEmail($email);
94 // Return the instance
99 * Creates a user by a given request instance
101 * @param $requestInstance An instance of a Requestable class
102 * @return $userInstance An instance of this user class
104 public final static function createMemberByRequest (Requestable $requestInstance) {
105 // Determine if by email or username
106 if (!is_null($requestInstance->getRequestElement('username'))) {
108 $userInstance = self::createMemberByUserName($requestInstance->getRequestElement('username'));
109 } elseif (!is_null($requestInstance->getRequestElement('email'))) {
111 $userInstance = self::createMemberByEmail($requestInstance->getRequestElement('email'));
114 $userInstance = new Member();
115 $userInstance->partialStub("We need to add more ways of creating user classes here.");
116 $userInstance->debugBackTrace();
120 // Return the prepared instance
121 return $userInstance;
125 * Updates the last activity timestamp and last performed action in the
126 * database result. You should call flushPendingUpdates() to flush these updates
127 * to the database layer.
129 * @param $requestInstance A requestable class instance
132 public function updateLastActivity (Requestable $requestInstance) {
134 $lastAction = $requestInstance->getRequestElement('action');
136 // If there is no action use the default on
137 if (is_null($lastAction)) {
138 $lastAction = $this->getConfigInstance()->readConfig('login_default_action');
141 // Get a critieria instance
142 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
144 // Add search criteria
145 $searchInstance->addCriteria(UserDatabaseWrapper::DB_COLUMN_USERNAME, $this->getUserName());
146 $searchInstance->setLimit(1);
148 // Now get another criteria
149 $updateInstance = ObjectFactory::createObjectByConfiguredName('update_criteria_class');
151 // And add our both entries
152 $updateInstance->addCriteria('last_activity', date("Y-m-d H:i:s", time()));
153 $updateInstance->addCriteria('last_action', $lastAction);
155 // Add the search criteria for searching for the right entry
156 $updateInstance->setSearchInstance($searchInstance);
158 // Remember the update in database result
159 $this->getResultInstance()->add2UpdateQueue($updateInstance);
163 * Flushs all pending updates to the database layer
167 public function flushPendingUpdates () {
168 // Do we have data to update?
169 if ($this->getResultInstance()->ifDataNeedsFlush()) {
170 // Get a database wrapper
171 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('user_db_wrapper_class');
173 // Yes, then send the whole result to the database layer
174 $wrapperInstance->doUpdateByResult($this->getResultInstance());