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          * Protected 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                 // Initialize the filter chains
  56                 $registrationInstance->initFilterChains();
  57
  58                 // And return it
  59                 return $registrationInstance;
  60         }
  61
  62         /**
  63          * Encrypt the given request key or throw an exception if the key was not
  64          * found in the request
  65          *
  66          * @param       $requestKey             Key in request class
  67          * @return      void
  68          */
  69         public function encryptPassword ($requestKey) {
  70                 // Check if the password is found in the request
  71                 if ($this->getRequestInstance()->isRequestElementSet($requestKey)) {
  72                         // So encrypt the password and store it for later usage in
  73                         // the request:
  74                         // 1.: Get the plain password
  75                         $plainPassword = $this->getRequestInstance()->getRequestElement($requestKey);
  76                         // 2. Get a crypto helper and hash the password
  77                         $this->hashedPassword = ObjectFactory::createObjectByConfiguredName('crypto_heler')->hashPassword($plainPassword);
  78                         // 3. Store the hash back in the request
  79                         $this->getRequestInstance()->setRequestElement('pass_hash', $this->hashedPassword);
  80                 }
  81         }
  82
  83         /**
  84          * Perform things like informing assigned affilates about new registration
  85          * before registration
  86          *
  87          * @return      void
  88          */
  89         public function doPreRegistration () {
  90                 // First run all pre filters
  91                 $this->executePreFilters();
  92         }
  93
  94         /**
  95          * Registers the new user account by insterting the request data into the
  96          * database and paying some start credits or throw exceptions if this fails
  97          *
  98          * @return      void
  99          */
 100         public function registerNewUser () {
 101                 // Get a user database wrapper
 102                 $wrapperInstance = ObjectFactory::createObjectByConfiguredName('user_db_wrapper');
 103
 104                 // Use this instance to insert the whole registration instance
 105                 $wrapperInstance->insertRegistrationObject($this);
 106         }
 107
 108         /**
 109          * Perform things like notifying partner websites after registration is done
 110          *
 111          * @return      void
 112          */
 113         public function doPostRegistration () {
 114                 // First run all post filters
 115                 $this->executePostFilters();
 116         }
 117
 118         /**
 119          * Do the action which is required after all registration steps are done.
 120          * This can be a simple redirect to another webpage or displaying a message
 121          * to the user. Or this can be a login step into the newly created account.
 122          *
 123          * @return      void
 124          */
 125         public function doPostAction () {
 126                 $this->partialStub();
 127         }
 128 }
 129
 130 //
 131 ?>