inc/main/interfaces/registration/class_UserRegister.php

   1 <?php
   2 // Own namespace
   3 namespace CoreFramework\User\Registration;
   4
   5 /**
   6  * A class for user registration
   7  *
   8  * @author              Roland Haeder <webmaster@shipsimu.org>
   9  * @version             0.0.0
  10  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
  11  * @license             GNU GPL 3.0 or any newer version
  12  * @link                http://www.shipsimu.org
  13  *
  14  * This program is free software: you can redistribute it and/or modify
  15  * it under the terms of the GNU General Public License as published by
  16  * the Free Software Foundation, either version 3 of the License, or
  17  * (at your option) any later version.
  18  *
  19  * This program is distributed in the hope that it will be useful,
  20  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  21  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  22  * GNU General Public License for more details.
  23  *
  24  * You should have received a copy of the GNU General Public License
  25  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  26  */
  27 interface UserRegister extends AddableCriteria {
  28         /**
  29          * Encrypt given request key or throws an exception if key was not found in
  30          * request.
  31          *
  32          * @param       $requestKey             Key in request class
  33          * @return      void
  34          */
  35         function encryptPassword ($requestKey);
  36
  37         /**
  38          * Perform things like informing assigned affilates about new registration
  39          * before registration
  40          *
  41          * @return      void
  42          */
  43         function doPreRegistration ();
  44
  45         /**
  46          * Registers the new user account by insterting the request data into the
  47          * database and paying some start credits or throw exceptions if this fails
  48          *
  49          * @return      void
  50          */
  51         function registerNewUser ();
  52
  53         /**
  54          * Perform things like notifying partner websites after registration is done
  55          *
  56          * @return      void
  57          */
  58         function doPostRegistration ();
  59
  60         /**
  61          * Do the action which is required after all registration steps are done.
  62          * This can be a simple redirect to another webpage or displaying a message
  63          * to the user. Or this can be a login step into the newly created account.
  64          *
  65          * @return      void
  66          */
  67         function doPostAction ();
  68
  69 }