inc/classes/interfaces/registration/class_UserRegister.php

   1 <?php
   2 /**
   3  * A class for user registration
   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 interface UserRegister extends FrameworkInterface {
  25         /**
  26          * Encrypt given request key or throws an exception if key was not found in
  27          * request.
  28          *
  29          * @param       $requestKey             Key in request class
  30          * @return      void
  31          */
  32         function encryptPassword ($requestKey);
  33
  34         /**
  35          * Perform things like informing assigned affilates about new registration
  36          * before registration
  37          *
  38          * @return      void
  39          */
  40         function doPreRegistration ();
  41
  42         /**
  43          * Registers the new user account by insterting the request data into the
  44          * database and paying some start credits or throw exceptions if this fails
  45          *
  46          * @return      void
  47          */
  48         function registerNewUser ();
  49
  50         /**
  51          * Perform things like notifying partner websites after registration is done
  52          *
  53          * @return      void
  54          */
  55         function doPostRegistration ();
  56
  57         /**
  58          * Do the action which is required after all registration steps are done.
  59          * This can be a simple redirect to another webpage or displaying a message
  60          * to the user. Or this can be a login step into the newly created account.
  61          *
  62          * @return      void
  63          */
  64         function doPostAction ();
  65
  66         /**
  67          * Adds registration elements to a given dataset instance
  68          *
  69          * @param       $criteriaInstance       An instance of a storeable criteria
  70          * @return      void
  71          */
  72         function addElementsToDataSet (StoreableCriteria $criteriaInstance);
  73 }
  74
  75 //
  76 ?>