Copyright updated, interface RenderableMenu added
[core.git] / inc / classes / main / controller / form / class_WebDoFormController.php
1 <?php
2 /**
3  * A controller for handling sent forms
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Core 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 WebDoFormController extends BaseController implements Controller {
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 class
37          *
38          * @param       $resolverInstance               An instance of a resolver class
39          * @return      $controllerInstance             A prepared instance of this class
40          */
41         public final static function createWebDoFormController (CommandResolver $resolverInstance) {
42                 // Create the instance
43                 $controllerInstance = new WebDoFormController();
44
45                 // Set resolver instance
46                 $controllerInstance->setResolverInstance($resolverInstance);
47
48                 // We need the controller instance in resolver class so set it here
49                 $resolverInstance->setControllerInstance($controllerInstance);
50
51                 // Return the prepared instance
52                 return $controllerInstance;
53         }
54
55         /**
56          * Handles the given request and response
57          *
58          * @param       $requestInstance        An instance of a request class
59          * @param       $responseInstance       An instance of a response class
60          * @return      void
61          */
62         public function handleRequest (Requestable $requestInstance, Responseable $responseInstance) {
63                 // Get the "form action"
64                 $formAction = $requestInstance->getRequestElement('form');
65
66                 // Get command instance from resolver
67                 $commandInstance = $this->getResolverInstance()->resolveCommand($formAction);
68
69                 // Add more filters by the command
70                 $commandInstance->addExtraFilters($this, $requestInstance);
71
72                 // Try to run the pre filters, if auth exceptions come through redirect here
73                 try {
74                         // Run the pre filters
75                         $this->executePreFilters($requestInstance, $responseInstance);
76                 } catch (UserAuthorizationException $e) {
77                         // Redirect to main page
78                         $responseInstance->redirectToConfiguredUrl('login_failed');
79
80                         // Exit here
81                         exit();
82                 }
83
84                 // Is the request still valid? Post filters shall only be executed of
85                 // the request is valid
86                 if ($requestInstance->isRequestValid()) {
87                         // Execute the command
88                         $commandInstance->execute($requestInstance, $responseInstance);
89
90                         // Execute *very* generic ppost filters
91                         $this->executePostFilters($requestInstance, $responseInstance);
92                 }
93
94                 // Flush the buffer out
95                 $responseInstance->flushBuffer();
96         }
97 }
98
99 // [EOF]
100 ?>