inc/classes/main/user/guest/class_Guest.php

   1 <?php
   2 /**
   3  * A generic class for handling guests
   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 Guest 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                 // Set part description
  44                 $this->setObjectDescription("Generic user class");
  45
  46                 // Create unique ID number
  47                 $this->generateUniqueId();
  48         }
  49
  50         /**
  51          * Creates an instance of this user class by a provided username. This
  52          * factory method will check if the username is already taken and if not
  53          * so it will throw an exception.
  54          *
  55          * @param       $userName               Username we need a class instance for
  56          * @return      $userInstance   An instance of this user class
  57          * @throws      UsernameMissingException        If the username does not exist
  58          */
  59         public final static function createGuestByUsername ($userName) {
  60                 // Get a new instance
  61                 $userInstance = new Guest();
  62
  63                 // Set the username
  64                 $userInstance->setUserName($userName);
  65
  66                 // Check if the username exists
  67                 if (!$userInstance->ifUsernameExists()) {
  68                         // Throw an exception here
  69                         throw new UsernameMissingException(array($userInstance, $userName), self::EXCEPTION_USERNAME_NOT_FOUND);
  70                 }
  71
  72                 // Return the instance
  73                 return $userInstance;
  74         }
  75
  76         /**
  77          * Creates an instance of this user class by a provided email address. This
  78          * factory method will not check if the email address is there.
  79          *
  80          * @param       $email                  Email address of the user
  81          * @return      $userInstance   An instance of this user class
  82          */
  83         public final static function createGuestByEmail ($email) {
  84                 // Get a new instance
  85                 $userInstance = new User();
  86
  87                 // Set the username
  88                 $userInstance->setEmail($email);
  89
  90                 // Return the instance
  91                 return $userInstance;
  92         }
  93
  94         /**
  95          * Updates the last activity timestamp and last performed action in the
  96          * database result. You should call flushUpdates() to flush these updates
  97          * to the database layer.
  98          *
  99          * @param       $requestInstance        A requestable class instance
 100          * @return      void
 101          */
 102         public function updateLastActivity (Requestable $requestInstance) {
 103                 // No activity will be logged for guest accounts
 104         }
 105
 106         /**
 107          * Flushs all updated entries to the database layer
 108          *
 109          * @return      void
 110          */
 111         public function flushUpdates () {
 112                 // No updates will be flushed to database!
 113         }
 114 }
 115
 116 // [EOF]
 117 ?>