application/ship-simu/main/user/class_ShipSimuGuest.php

   1 <?php
   2 /**
   3  * A special guest class for Ship-Simu
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   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
  10  *
  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.
  15  *
  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.
  20  *
  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/>.
  23  */
  24 class ShipSimuGuest extends BaseUser implements ManageableGuest, Registerable {
  25         // Exceptions
  26         const EXCEPTION_USERNAME_NOT_FOUND   = 0x170;
  27         const EXCEPTION_USER_EMAIL_NOT_FOUND = 0x171;
  28         const EXCEPTION_USER_PASS_MISMATCH   = 0x172;
  29
  30         /**
  31          * Protected constructor
  32          *
  33          * @param       $className      Name of the class
  34          * @return      void
  35          */
  36         protected function __construct ($className = "") {
  37                 // Is the class name empty? Then this is not a specialized user class
  38                 if (empty($className)) $className = __CLASS__;
  39
  40                 // Call parent constructor
  41                 parent::__construct($className);
  42         }
  43
  44         /**
  45          * Creates an instance of this user class by a provided username. This
  46          * factory method will check if the username is already taken and if not
  47          * so it will throw an exception.
  48          *
  49          * @param       $userName               Username we need a class instance for
  50          * @return      $userInstance   An instance of this user class
  51          * @throws      UsernameMissingException        If the username does not exist
  52          */
  53         public final static function createGuestByUsername ($userName) {
  54                 // Get a new instance
  55                 $userInstance = new ShipSimuGuest();
  56
  57                 // Set the username
  58                 $userInstance->setUserName($userName);
  59
  60                 // Check if the username exists
  61                 if (!$userInstance->ifUsernameExists()) {
  62                         // Throw an exception here
  63                         throw new UsernameMissingException(array($userInstance, $userName), self::EXCEPTION_USERNAME_NOT_FOUND);
  64                 }
  65
  66                 // Return the instance
  67                 return $userInstance;
  68         }
  69
  70         /**
  71          * Creates an instance of this user class by a provided email address. This
  72          * factory method will not check if the email address is there.
  73          *
  74          * @param       $email                  Email address of the user
  75          * @return      $userInstance   An instance of this user class
  76          */
  77         public final static function createGuestByEmail ($email) {
  78                 // Get a new instance
  79                 $userInstance = new ShipSimuGuest();
  80
  81                 // Set the username
  82                 $userInstance->setEmail($email);
  83
  84                 // Return the instance
  85                 return $userInstance;
  86         }
  87
  88         /**
  89          * Updates the last activity timestamp and last performed action in the
  90          * database result. You should call flushPendingUpdates() to flush these updates
  91          * to the database layer.
  92          *
  93          * @param       $requestInstance        A requestable class instance
  94          * @return      void
  95          */
  96         public function updateLastActivity (Requestable $requestInstance) {
  97                 // No activity will be logged for guest accounts
  98         }
  99
 100         /**
 101          * Flushs all pending updates to the database layer
 102          *
 103          * @return      void
 104          */
 105         public function flushPendingUpdates () {
 106                 // No updates will be flushed to database!
 107         }
 108 }
 109
 110 // [EOF]
 111 ?>