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