Copyright updated, menu class added for 'home'
[shipsimu.git] / application / ship-simu / main / commands / web / class_WebShipsimuProfileCommand.php
1 <?php
2 /**
3  * A command for profile-update 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 WebShipsimuProfileCommand extends BaseCommand implements Commandable {
25         /**
26          * Filtered request data
27          */
28         private $requestData = array();
29
30         /**
31          * Allowed profile data to pass through
32          */
33         private $allowedData = array(
34                 'pass'  => 'pass1',
35                 'email' => 'email1',
36                 'surname',
37                 'family',
38                 'street',
39                 'city',
40                 'zip',
41                 'icq',
42                 'jabber',
43                 'yahoo',
44                 'aol',
45                 'msn',
46                 'rules'
47         );
48
49         /**
50          * Protected constructor
51          *
52          * @return      void
53          */
54         protected function __construct () {
55                 // Call parent constructor
56                 parent::__construct(__CLASS__);
57
58                 // Clean up a little
59                 $this->removeNumberFormaters();
60                 $this->removeSystemArray();
61         }
62
63         /**
64          * Creates an instance of this command and sets the resolver instance
65          *
66          * @param       $resolverInstance       An instance of a command resolver
67          * @return      $commandInstance        The created command instance
68          */
69         public final static function createWebShipsimuProfileCommand (CommandResolver $resolverInstance) {
70                 // Get a new instance
71                 $commandInstance = new WebShipsimuProfileCommand();
72
73                 // Set the resolver instance
74                 $commandInstance->setResolverInstance($resolverInstance);
75
76                 // Return the prepared instance
77                 return $commandInstance;
78         }
79
80         /**
81          * Executes the command with given request and response objects
82          *
83          * @param       $requestInstance        An instance of a class with an Requestable interface
84          * @param       $responseInstance       An instance of a class with an Responseable interface
85          * @return      void
86          * @todo        Add functionality here
87          */
88         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
89                 // Make sure only allowed values are comming through
90                 foreach ($this->allowedData as $alias => $element) {
91                         // Get data
92                         $data = $requestInstance->getRequestElement($element);
93
94                         // Silently skip empty fields
95                         if (empty($data)) continue;
96
97                         // Do we have an alias?
98                         if (is_string($alias)) {
99                                 // Yes, so use it
100                                 $this->requestData[$alias]   = $data;
101                         } else {
102                                 // No, default entry
103                                 $this->requestData[$element] = $data;
104                         }
105                 } // END - foreach
106
107                 // Remove the array, we don't need it anymore
108                 unset($this->allowedData);
109
110                 // Unfinished!
111                 $this->partialStub("Unfinished work.");
112                 $this->debugBackTrace();
113         }
114
115         /**
116          * Adds extra filters to the given controller instance
117          *
118          * @param       $controllerInstance             A controller instance
119          * @param       $requestInstance                An instance of a class with an Requestable interface
120          * @return      void
121          * @todo        Add some more pre/post filters to the controller
122          */
123         public function addExtraFilters (Controller $controllerInstance, Requestable $requestInstance) {
124                 // Add user auth filter (we don't need an update of the user here because it will be redirected)
125                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_auth_filter'));
126
127                 // User status filter
128                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('user_status_filter'));
129
130                 // Updated rules accepted
131                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('rules_accepted_filter'));
132
133                 // Account password validation
134                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('account_password_filter'));
135
136                 // Validate CAPTCHA input
137                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('captcha_profile_verifier_filter'));
138
139                 // Validate birthday input
140                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('birthday_profile_verifier_filter'));
141
142                 // Email changed
143                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('email_change_filter'));
144
145                 // Password changed
146                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('password_change_filter'));
147         }
148 }
149
150 // [EOF]
151 ?>