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, 2009 Core Developer Team
   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          * @return      void
  34          */
  35         protected function __construct () {
  36                 // Call parent constructor
  37                 parent::__construct(__CLASS__);
  38         }
  39
  40         /**
  41          * Creates an instance of this user class by a provided username. This
  42          * factory method will check if username is already taken and if not so it
  43          * will throw an exception.
  44          *
  45          * @param       $userName               Username we need a class instance for
  46          * @return      $userInstance   An instance of this user class
  47          * @throws      UsernameMissingException        If the username does not exist
  48          */
  49         public final static function createGuestByUsername ($userName) {
  50                 // Get a new instance
  51                 $userInstance = new Guest();
  52
  53                 // Set the username
  54                 $userInstance->setUserName($userName);
  55
  56                 // Check if username exists
  57                 if ($userInstance->ifUsernameExists() === false) {
  58                         // Throw an exception here
  59                         throw new UsernameMissingException(array($userInstance, $userName), self::EXCEPTION_USERNAME_NOT_FOUND);
  60                 } // END - if
  61
  62                 // Return the instance
  63                 return $userInstance;
  64         }
  65
  66         /**
  67          * Creates an instance of this user class by a provided email address. This
  68          * factory method will not check if email address is there.
  69          *
  70          * @param       $email                  Email address of the user
  71          * @return      $userInstance   An instance of this user class
  72          */
  73         public final static function createGuestByEmail ($email) {
  74                 // Get a new instance
  75                 $userInstance = new Guest();
  76
  77                 // Set the username
  78                 $userInstance->setEmail($email);
  79
  80                 // Return the instance
  81                 return $userInstance;
  82         }
  83
  84         /**
  85          * Updates the last activity timestamp and last performed action in the
  86          * database result. You should call flushPendingUpdates() to flush these updates
  87          * to the database layer.
  88          *
  89          * @param       $requestInstance        A requestable class instance
  90          * @return      void
  91          */
  92         public function updateLastActivity (Requestable $requestInstance) {
  93                 // No activity will be logged for guest accounts
  94         }
  95
  96         /**
  97          * Flushs all pending updates to the database layer
  98          *
  99          * @return      void
 100          */
 101         public function flushPendingUpdates () {
 102                 // No updates will be flushed to database!
 103         }
 104 }
 105
 106 // [EOF]
 107 ?>