More renamed
[shipsimu.git] / application / ship-simu / main / commands / web / class_WebShipsimuRegisterCommand.php
1 <?php
2 /**
3  * A command for registration handling
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Ship-Simu Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.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 WebShipsimuRegisterCommand extends BaseCommand implements Commandable {
25         /**
26          * Protected constructor
27          *
28          * @return      void
29          */
30         protected function __construct () {
31                 // Call parent constructor
32                 parent::__construct(__CLASS__);
33         }
34
35         /**
36          * Creates an instance of this command and sets the resolver instance
37          *
38          * @param       $resolverInstance       An instance of a command resolver
39          * @return      $commandInstance        The created command instance
40          */
41         public static final function createWebShipsimuRegisterCommand (CommandResolver $resolverInstance) {
42                 // Get a new instance
43                 $commandInstance = new WebShipsimuRegisterCommand();
44
45                 // Set the resolver instance
46                 $commandInstance->setResolverInstance($resolverInstance);
47
48                 // Return the prepared instance
49                 return $commandInstance;
50         }
51
52         /**
53          * Executes the command with given request and response objects
54          *
55          * @param       $requestInstance        An instance of a class with an Requestable interface
56          * @param       $responseInstance       An instance of a class with an Responseable interface
57          * @return      void
58          */
59         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
60                 // First get a UserRegistration instance
61                 $registerInstance = ObjectFactory::createObjectByConfiguredName('user_registration_class');
62
63                 // First set request and response instance
64                 $registerInstance->setRequestInstance($requestInstance);
65                 $registerInstance->setResponseInstance($responseInstance);
66
67                 // Encrypt the password
68                 $registerInstance->encryptPassword('pass1');
69
70                 // Do things before registration
71                 $registerInstance->doPreRegistration();
72
73                 // Register the new user
74                 $registerInstance->registerNewUser();
75
76                 // Do things after registration like notifying partner pages or queueing
77                 // them for notification
78                 $registerInstance->doPostRegistration();
79
80                 // Redirect or login after registration
81                 $registerInstance->doPostAction();
82         }
83
84         /**
85          * Adds extra filters to the given controller instance
86          *
87          * @param       $controllerInstance             A controller instance
88          * @param       $requestInstance                An instance of a class with an Requestable interface
89          * @return      void
90          * @todo        Add some more pre/post filters to the controller
91          */
92         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
93                 // Validate email address (if configured: check on double email addresses)
94                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('email_validator_filter'));
95
96                 // Validate username and check if it does not exist
97                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('username_validator_filter'));
98
99                 // Validate if username is "guest" and not taken
100                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('username_is_guest_filter'));
101
102                 // Validate if password is set
103                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('password_validator_filter'));
104
105                 // Check if rules where accepted
106                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('rules_accepted_filter'));
107
108                 // Validate CAPTCHA input
109                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('captcha_register_verifier_filter'));
110
111                 // Validate birthday
112                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('birthday_register_verifier_filter'));
113         }
114 }
115
116 // [EOF]
117 ?>