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 = __CLASS__) {
32 // Call parent constructor
33 parent::__construct($className);
37 * Destructor for e.g. flushing pending updates to the database
41 public function __destruct () {
42 // Flush any updated entries to the database
43 $this->flushPendingUpdates();
45 // Call parent destructor
50 * Creates an instance of this user class by a provided username. This
51 * factory method will check if the username is already taken and if not
52 * so it will throw an exception.
54 * @param $userName Username we need a class instance for
55 * @return $userInstance An instance of this user class
56 * @throws UsernameMissingException If the username does not exist
58 public final static function createMemberByUsername ($userName) {
60 $userInstance = new ShipSimuMember();
63 $userInstance->setUserName($userName);
65 // Check if the username exists
66 if (!$userInstance->ifUsernameExists()) {
67 // Throw an exception here
68 throw new UsernameMissingException(array($userInstance, $userName), self::EXCEPTION_USERNAME_NOT_FOUND);
71 // Return the instance
76 * Creates an instance of this user class by a provided email address. This
77 * factory method will not check if the email address is there.
79 * @param $email Email address of the user
80 * @return $userInstance An instance of this user class
82 public final static function createMemberByEmail ($email) {
84 $userInstance = new ShipSimuMember();
87 $userInstance->setEmail($email);
89 // Return the instance
94 * Creates a user by a given request instance
96 * @param $requestInstance An instance of a Requestable class
97 * @return $userInstance An instance of this user class
98 * @todo Add more ways of creating user instances
100 public final static function createMemberByRequest (Requestable $requestInstance) {
101 // Determine if by email or username
102 if (!is_null($requestInstance->getRequestElement('username'))) {
104 $userInstance = self::createMemberByUserName($requestInstance->getRequestElement('username'));
105 } elseif (!is_null($requestInstance->getRequestElement('email'))) {
107 $userInstance = self::createMemberByEmail($requestInstance->getRequestElement('email'));
110 $userInstance = new ShipSimuMember();
111 $userInstance->partialStub("We need to add more ways of creating user classes here.");
112 $userInstance->debugBackTrace();
116 // Return the prepared instance
117 return $userInstance;
121 * Updates the last activity timestamp and last performed action in the
122 * database result. You should call flushPendingUpdates() to flush these updates
123 * to the database layer.
125 * @param $requestInstance A requestable class instance
128 public function updateLastActivity (Requestable $requestInstance) {
130 $lastAction = $requestInstance->getRequestElement('action');
132 // If there is no action use the default on
133 if (is_null($lastAction)) {
134 $lastAction = $this->getConfigInstance()->readConfig('login_default_action');
137 // Get a critieria instance
138 $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
140 // Add search criteria
141 $searchInstance->addCriteria(UserDatabaseWrapper::DB_COLUMN_USERNAME, $this->getUserName());
142 $searchInstance->setLimit(1);
144 // Now get another criteria
145 $updateInstance = ObjectFactory::createObjectByConfiguredName('update_criteria_class');
147 // And add our both entries
148 $updateInstance->addCriteria("last_activity", date("Y-m-d H:i:s", time()));
149 $updateInstance->addCriteria("last_action", $lastAction);
151 // Add the search criteria for searching for the right entry
152 $updateInstance->setSearchInstance($searchInstance);
154 // Remember the update in database result
155 $this->getResultInstance()->add2UpdateQueue($updateInstance);
159 * Flushs all pending updates to the database layer
163 public function flushPendingUpdates () {
164 // Is the object valid?
165 if (!$this->getResultInstance() instanceof SearchableResult) {
170 // Do we have data to update?
171 if ($this->getResultInstance()->ifDataNeedsFlush()) {
172 // Get a database wrapper
173 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('user_db_wrapper_class');
175 // Yes, then send the whole result to the database layer
176 $wrapperInstance->doUpdateByResult($this->getResultInstance());