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 {
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);
38 // Set part description
39 $this->setObjectDescription("Special member class for Ship-Simu");
41 // Create unique ID number
42 $this->generateUniqueId();
46 * Creates an instance of this user class by a provided username. This
47 * factory method will check if the username is already taken and if not
48 * so it will throw an exception.
50 * @param $userName Username we need a class instance for
51 * @return $userInstance An instance of this user class
52 * @throws UsernameMissingException If the username does not exist
54 public final static function createMemberByUsername ($userName) {
56 $userInstance = new ShipSimuMember();
59 $userInstance->setUserName($userName);
61 // Check if the username exists
62 if (!$userInstance->ifUsernameExists()) {
63 // Throw an exception here
64 throw new UsernameMissingException(array($userInstance, $userName), self::EXCEPTION_USERNAME_NOT_FOUND);
67 // Return the instance
72 * Creates an instance of this user class by a provided email address. This
73 * factory method will not check if the email address is there.
75 * @param $email Email address of the user
76 * @return $userInstance An instance of this user class
78 public final static function createMemberByEmail ($email) {
80 $userInstance = new ShipSimuMember();
83 $userInstance->setEmail($email);
85 // Return the instance
90 * Creates a user by a given request instance
92 * @param $requestInstance An instance of a Requestable class
93 * @return $userInstance An instance of this user class
95 public final static function createMemberByRequest (Requestable $requestInstance) {
96 // Determine if by email or username
97 if (!is_null($requestInstance->getRequestElement('username'))) {
99 $userInstance = self::createMemberByUserName($requestInstance->getRequestElement('username'));
100 } elseif (!is_null($requestInstance->getRequestElement('email'))) {
102 $userInstance = self::createMemberByEmail($requestInstance->getRequestElement('email'));
105 $userInstance = new ShipSimuMember();
106 $userInstance->partialStub("We need to add more ways of creating user classes here.");
107 $userInstance->debugBackTrace();
111 // Return the prepared instance
112 return $userInstance;
116 * Updates the last activity timestamp and last performed action in the
117 * database result. You should call flushPendingUpdates() to flush these updates
118 * to the database layer.
120 * @param $requestInstance A requestable class instance
123 public function updateLastActivity (Requestable $requestInstance) {
125 $lastAction = $requestInstance->getRequestElement('action');
127 // If there is no action use the default on
128 if (is_null($lastAction)) {
129 $lastAction = $this->getConfigInstance()->readConfig('login_default_action');
132 // Get a critieria instance
133 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
135 // Add search criteria
136 $searchInstance->addCriteria(UserDatabaseWrapper::DB_COLUMN_USERNAME, $this->getUserName());
137 $searchInstance->setLimit(1);
139 // Now get another criteria
140 $updateInstance = ObjectFactory::createObjectByConfiguredName('update_criteria_class');
142 // And add our both entries
143 $updateInstance->addCriteria('last_activity', date("Y-m-d H:i:s", time()));
144 $updateInstance->addCriteria('last_action', $lastAction);
146 // Add the search criteria for searching for the right entry
147 $updateInstance->setSearchInstance($searchInstance);
149 // Remember the update in database result
150 $this->getResultInstance()->add2UpdateQueue($updateInstance);
154 * Flushs all pending updates to the database layer
158 public function flushPendingUpdates () {
159 // Do we have data to update?
160 if ($this->getResultInstance()->ifDataNeedsFlush()) {
161 // Get a database wrapper
162 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('user_db_wrapper_class');
164 // Yes, then send the whole result to the database layer
165 $wrapperInstance->doUpdateByResult($this->getResultInstance());