Style convention applied (incomplete), pre/post filters added for form handler
[shipsimu.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, 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 WebDoFormController extends BaseController implements Controller {
25         /**
26          * Private 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("Controller for handling forms");
36
37                 // Create unique ID number
38                 $this->createUniqueID();
39         }
40
41         /**
42          * Creates an instance of this class
43          *
44          * @param       $resolverInstance               An instance of a resolver class
45          * @return      $controllerInstance             A prepared instance of this class
46          */
47         public final static function createWebDoFormController (CommandResolver $resolverInstance) {
48                 // Create the instance
49                 $controllerInstance = new WebDoFormController();
50
51                 // Set resolver instance
52                 $controllerInstance->setResolverInstance($resolverInstance);
53
54                 // We need the controller instance in the resolver class so set it here
55                 $resolverInstance->setControllerInstance($controllerInstance);
56
57                 // Return the prepared instance
58                 return $controllerInstance;
59         }
60
61         /**
62          * Handles the given request and response
63          *
64          * @param       $requestInstance        An instance of a request class
65          * @param       $responseInstance       An instance of a response class
66          * @return      void
67          */
68         public function handleRequest (Requestable $requestInstance, Responseable $responseInstance) {
69                 // Get the "form action"
70                 $formAction = $requestInstance->getRequestElement('form');
71
72                 // Get command instance from resolver
73                 $commandInstance = $this->getResolverInstance()->resolveCommand($formAction);
74
75                 // Execute *very* generic pre filters
76                 $this->executePreFilters($requestInstance, $responseInstance);
77
78                 // This request was valid! :-D
79                 $requestInstance->requestIsValid();
80
81                 // Execute the command
82                 $commandInstance->execute($requestInstance, $responseInstance);
83
84                 // Execute *very* generic ppost filters
85                 $this->executePostFilters($requestInstance, $responseInstance);
86
87                 // Flush the buffer out
88                 $responseInstance->flushBuffer();
89         }
90 }
91
92 // [EOF]
93 ?>