More conventions than code added:
[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@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 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                 // Set part description
35                 $this->setObjectDescription("Registration handling command for Ship-Simu");
36
37                 // Create unique ID number
38                 $this->generateUniqueId();
39
40                 // Clean up a little
41                 $this->removeNumberFormaters();
42                 $this->removeSystemArray();
43         }
44
45         /**
46          * Creates an instance of this command and sets the resolver instance
47          *
48          * @param       $resolverInstance       An instance of a command resolver
49          * @return      $commandInstance        The created command instance
50          */
51         public final static function createWebShipsimuRegisterCommand (CommandResolver $resolverInstance) {
52                 // Get a new instance
53                 $commandInstance = new WebShipsimuRegisterCommand();
54
55                 // Set the resolver instance
56                 $commandInstance->setResolverInstance($resolverInstance);
57
58                 // Return the prepared instance
59                 return $commandInstance;
60         }
61
62         /**
63          * Executes the command with given request and response objects
64          *
65          * @param       $requestInstance        An instance of a class with an Requestable interface
66          * @param       $responseInstance       An instance of a class with an Responseable interface
67          * @return      void
68          */
69         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
70                 // First get a UserRegistration instance
71                 $registerInstance = ObjectFactory::createObjectByConfiguredName('user_registration_class');
72
73                 // First set request and response instance
74                 $registerInstance->setRequestInstance($requestInstance);
75                 $registerInstance->setResponseInstance($responseInstance);
76
77                 // Encrypt the password
78                 $registerInstance->encryptPassword('pass1');
79
80                 // Do things before registration
81                 $registerInstance->doPreRegistration();
82
83                 // Register the new user
84                 $registerInstance->registerNewUser();
85
86                 // Do things after registration like notifying partner pages or queueing
87                 // them for notification
88                 $registerInstance->doPostRegistration();
89
90                 // Redirect or login after registration
91                 $registerInstance->doPostAction();
92         }
93
94         /**
95          * Adds extra filters to the given controller instance
96          *
97          * @param       $controllerInstance             A controller instance
98          * @param       $requestInstance                An instance of a class with an Requestable interface
99          * @return      void
100          * @todo        Add some more pre/post filters to the controller
101          */
102         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
103                 // Validate email address (if configured: check on double email addresses)
104                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('email_validator_class'));
105
106                 // Validate username and check if it does not exist
107                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('username_validator_class'));
108
109                 // Validate if username is "guest" and not taken
110                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('username_is_guest_class'));
111
112                 // Validate if password is set
113                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('password_validator_class'));
114
115                 // Check if rules where accepted
116                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('rules_accepted_class'));
117
118                 // Validate CAPTCHA input
119                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('captcha_register_verifier_class'));
120         }
121 }
122
123 // [EOF]
124 ?>