3 * A generic class for handling guests
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 Guest extends BaseUser implements ManageableGuest, Registerable {
26 const EXCEPTION_USERNAME_NOT_FOUND = 0x170;
27 const EXCEPTION_USER_EMAIL_NOT_FOUND = 0x171;
28 const EXCEPTION_USER_PASS_MISMATCH = 0x172;
31 * Protected constructor
35 protected function __construct () {
36 // Call parent constructor
37 parent::__construct(__CLASS__);
39 // Set part description
40 $this->setObjectDescription("Generic guest class");
42 // Create unique ID number
43 $this->generateUniqueId();
47 * Creates an instance of this user class by a provided username. This
48 * factory method will check if the username is already taken and if not
49 * so it will throw an exception.
51 * @param $userName Username we need a class instance for
52 * @return $userInstance An instance of this user class
53 * @throws UsernameMissingException If the username does not exist
55 public final static function createGuestByUsername ($userName) {
57 $userInstance = new Guest();
60 $userInstance->setUserName($userName);
62 // Check if the username exists
63 if (!$userInstance->ifUsernameExists()) {
64 // Throw an exception here
65 throw new UsernameMissingException(array($userInstance, $userName), self::EXCEPTION_USERNAME_NOT_FOUND);
68 // Return the instance
73 * Creates an instance of this user class by a provided email address. This
74 * factory method will not check if the email address is there.
76 * @param $email Email address of the user
77 * @return $userInstance An instance of this user class
79 public final static function createGuestByEmail ($email) {
81 $userInstance = new Guest();
84 $userInstance->setEmail($email);
86 // Return the instance
91 * Updates the last activity timestamp and last performed action in the
92 * database result. You should call flushPendingUpdates() to flush these updates
93 * to the database layer.
95 * @param $requestInstance A requestable class instance
98 public function updateLastActivity (Requestable $requestInstance) {
99 // No activity will be logged for guest accounts
103 * Flushs all pending updates to the database layer
107 public function flushPendingUpdates () {
108 // No updates will be flushed to database!
112 * Adds data for later complete update
114 * @param $column Column we want to update
115 * @param $value New value to store in database
118 public function addUpdateData ($column, $value) {
119 // Nothing shall be updated by user him/her self