3 * A class for user registration
5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
24 interface UserRegister extends FrameworkInterface {
26 * Encrypt given request key or throws an exception if key was not found in
29 * @param $requestKey Key in request class
32 function encryptPassword ($requestKey);
35 * Perform things like informing assigned affilates about new registration
40 function doPreRegistration ();
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
48 function registerNewUser ();
51 * Perform things like notifying partner websites after registration is done
55 function doPostRegistration ();
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.
64 function doPostAction ();
67 * Adds registration elements to a given dataset instance
69 * @param $criteriaInstance An instance of a storeable criteria
72 function addElementsToDataSet (StoreableCriteria $criteriaInstance);