3 * A special member class for Ship-Simu
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 ShipSimuMember extends ShipSimuBaseUser implements ManageableMember, Registerable, Updateable {
26 * Protected constructor
28 * @param $className Name of the class
31 protected function __construct ($className = "") {
32 // Is the class name empty? Then this is not a specialized user class
33 if (empty($className)) $className = __CLASS__;
35 // Call parent constructor
36 parent::__construct($className);
40 * Destructor to always flush updates
44 public function __destruct () {
45 // Flush any updated entries to the database
46 $this->flushPendingUpdates();
48 // Call parent destructor
53 * Creates an instance of this user class by a provided username. This
54 * factory method will check if the username is already taken and if not
55 * so it will throw an exception.
57 * @param $userName Username we need a class instance for
58 * @return $userInstance An instance of this user class
59 * @throws UsernameMissingException If the username does not exist
61 public final static function createMemberByUsername ($userName) {
63 $userInstance = new ShipSimuMember();
66 $userInstance->setUserName($userName);
68 // Check if the username exists
69 if (!$userInstance->ifUsernameExists()) {
70 // Throw an exception here
71 throw new UsernameMissingException(array($userInstance, $userName), self::EXCEPTION_USERNAME_NOT_FOUND);
74 // Return the instance
79 * Creates an instance of this user class by a provided email address. This
80 * factory method will not check if the email address is there.
82 * @param $email Email address of the user
83 * @return $userInstance An instance of this user class
85 public final static function createMemberByEmail ($email) {
87 $userInstance = new ShipSimuMember();
90 $userInstance->setEmail($email);
92 // Return the instance
97 * Creates a user by a given request instance
99 * @param $requestInstance An instance of a Requestable class
100 * @return $userInstance An instance of this user class
102 public final static function createMemberByRequest (Requestable $requestInstance) {
103 // Determine if by email or username
104 if (!is_null($requestInstance->getRequestElement('username'))) {
106 $userInstance = self::createMemberByUserName($requestInstance->getRequestElement('username'));
107 } elseif (!is_null($requestInstance->getRequestElement('email'))) {
109 $userInstance = self::createMemberByEmail($requestInstance->getRequestElement('email'));
112 $userInstance = new ShipSimuMember();
113 $userInstance->partialStub("We need to add more ways of creating user classes here.");
114 $userInstance->debugBackTrace();
118 // Return the prepared instance
119 return $userInstance;
123 * Updates the last activity timestamp and last performed action in the
124 * database result. You should call flushPendingUpdates() to flush these updates
125 * to the database layer.
127 * @param $requestInstance A requestable class instance
130 public function updateLastActivity (Requestable $requestInstance) {
132 $lastAction = $requestInstance->getRequestElement('action');
134 // If there is no action use the default on
135 if (is_null($lastAction)) {
136 $lastAction = $this->getConfigInstance()->readConfig('login_default_action');
139 // Get a critieria instance
140 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
142 // Add search criteria
143 $searchInstance->addCriteria(UserDatabaseWrapper::DB_COLUMN_USERNAME, $this->getUserName());
144 $searchInstance->setLimit(1);
146 // Now get another criteria
147 $updateInstance = ObjectFactory::createObjectByConfiguredName('update_criteria_class');
149 // And add our both entries
150 $updateInstance->addCriteria('last_activity', date("Y-m-d H:i:s", time()));
151 $updateInstance->addCriteria('last_action', $lastAction);
153 // Add the search criteria for searching for the right entry
154 $updateInstance->setSearchInstance($searchInstance);
156 // Remember the update in database result
157 $this->getResultInstance()->add2UpdateQueue($updateInstance);
161 * Flushs all pending updates to the database layer
165 public function flushPendingUpdates () {
166 // Do we have data to update?
167 if ($this->getResultInstance()->ifDataNeedsFlush()) {
168 // Get a database wrapper
169 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('user_db_wrapper_class');
171 // Yes, then send the whole result to the database layer
172 $wrapperInstance->doUpdateByResult($this->getResultInstance());