framework/main/interfaces/registration/class_UserRegister.php

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