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          * Private 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("Ship-Simu registration class");
  36
  37                 // Create unique ID number
  38                 $this->createUniqueID();
  39         }
  40
  41         /**
  42          * Create a new instance
  43          *
  44          * @return      $registrationInstance   An instance of this registration class
  45          */
  46         public final static function createShipSimuRegistration () {
  47                 // Get a new instance
  48                 $registrationInstance = new ShipSimuRegistration();
  49
  50                 // And return it
  51                 return $registrationInstance;
  52         }
  53
  54         /**
  55          * Encrypt the given request key or throws an exception if the key was not
  56          * found in the request
  57          *
  58          * @param       $requestKey             Key in request class
  59          * @return      void
  60          */
  61         public function encryptPassword ($requestKey) {
  62                 $this->partialStub(sprintf("requestKey=%s", $requestKey));
  63         }
  64
  65         /**
  66          * Perform things like informing assigned affilates about new registration
  67          * before registration
  68          *
  69          * @return      void
  70          */
  71         public function doPreRegistration () {
  72                 $this->partialStub();
  73         }
  74
  75         /**
  76          * Registers the new user account by insterting the request data into the
  77          * database and paying some start credits or throw exceptions if this fails
  78          *
  79          * @return      void
  80          */
  81         public function registerNewUser () {
  82                 $this->partialStub();
  83         }
  84
  85         /**
  86          * Perform things like notifying partner websites after registration is done
  87          *
  88          * @return      void
  89          */
  90         public function doPostRegistration () {
  91                 $this->partialStub();
  92         }
  93
  94         /**
  95          * Do the action which is required after all registration steps are done.
  96          * This can be a simple redirect to another webpage or displaying a message
  97          * to the user. Or this can be a login step into the newly created account.
  98          *
  99          * @return      void
 100          */
 101         public function doPostAction () {
 102                 $this->partialStub();
 103         }
 104 }
 105
 106 //
 107 ?>