application/ship-simu/main/login/class_ShipSimuUserLogin.php

   1 <?php
   2 /**
   3  * A special login 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 ShipSimuUserLogin extends BaseFrameworkSystem implements LoginableUser {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Set part description
  35                 $this->setObjectDescription("Login for Ship-Simu");
  36
  37                 // Create unique ID number
  38                 $this->generateUniqueId();
  39
  40                 // Clean up a little
  41                 $this->removeNumberFormaters();
  42                 $this->removeSystemArray();
  43         }
  44
  45         /**
  46          * Creates an instance of this login class
  47          *
  48          * @return      $loginInstance  An instance of this login class
  49          */
  50         public final static function createShipSimuUserLogin () {
  51                 // Get a new instance
  52                 $loginInstance = new ShipSimuUserLogin();
  53
  54                 // Return the instance
  55                 return $loginInstance;
  56         }
  57
  58         /**
  59          * Logins the user with the given request containing the credential. The
  60          * result of the login can be thrown by exception or, if prefered stored
  61          * in a boolean attribute which is then readable by a matching getter.
  62          *
  63          * @param       $requestInstance        An instance of a Requestable class
  64          * @return      void
  65          */
  66         public function doLogin (Requestable $requestInstance) {
  67                 $this->partialStub();
  68         }
  69 }
  70
  71 // [EOF]
  72 ?>