application/ship-simu/main/registration/class_ShipSimuRegistration.php

   1 <?php
   2 /**
   3  * A user registration specially 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 ShipSimuRegistration extends BaseRegistration {
  25         /**
  26          * Hashed password
  27          */
  28         private $hashedPassword = "";
  29
  30         /**
  31          * Private constructor
  32          *
  33          * @return      void
  34          */
  35         protected function __construct () {
  36                 // Call parent constructor
  37                 parent::__construct(__CLASS__);
  38
  39                 // Set part description
  40                 $this->setObjectDescription("Ship-Simu registration class");
  41
  42                 // Create unique ID number
  43                 $this->createUniqueID();
  44         }
  45
  46         /**
  47          * Create a new instance
  48          *
  49          * @return      $registrationInstance   An instance of this registration class
  50          */
  51         public final static function createShipSimuRegistration () {
  52                 // Get a new instance
  53                 $registrationInstance = new ShipSimuRegistration();
  54
  55                 // And return it
  56                 return $registrationInstance;
  57         }
  58
  59         /**
  60          * Encrypt the given request key or throw an exception if the key was not
  61          * found in the request
  62          *
  63          * @param       $requestKey             Key in request class
  64          * @return      void
  65          */
  66         public function encryptPassword ($requestKey) {
  67                 // Check if the password is found in the request
  68                 if ($this->getRequestInstance()->isRequestElementSet($requestKey)) {
  69                         // So encrypt the password and store it for later usage in
  70                         // the request:
  71                         // 1.: Get the plain password
  72                         $plainPassword = $this->getRequestInstance()->getRequestElement($requestKey);
  73                         // 2. Get a crypto helper and hash the password
  74                         $this->hashedPassword = ObjectFactory::createObjectByConfiguredName('crypto_heler')->hashPassword($plainPassword);
  75                         // 3. Store the hash back in the request
  76                         $this->getRequestInstance()->setRequestElement('pass_hash', $this->hashedPassword);
  77                 }
  78         }
  79
  80         /**
  81          * Perform things like informing assigned affilates about new registration
  82          * before registration
  83          *
  84          * @return      void
  85          */
  86         public function doPreRegistration () {
  87                 $this->partialStub();
  88         }
  89
  90         /**
  91          * Registers the new user account by insterting the request data into the
  92          * database and paying some start credits or throw exceptions if this fails
  93          *
  94          * @return      void
  95          */
  96         public function registerNewUser () {
  97                 $this->partialStub();
  98         }
  99
 100         /**
 101          * Perform things like notifying partner websites after registration is done
 102          *
 103          * @return      void
 104          */
 105         public function doPostRegistration () {
 106                 $this->partialStub();
 107         }
 108
 109         /**
 110          * Do the action which is required after all registration steps are done.
 111          * This can be a simple redirect to another webpage or displaying a message
 112          * to the user. Or this can be a login step into the newly created account.
 113          *
 114          * @return      void
 115          */
 116         public function doPostAction () {
 117                 $this->partialStub();
 118         }
 119 }
 120
 121 //
 122 ?>