3 * A controller for handling sent forms
5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
24 class WebDoFormController extends BaseController implements Controller {
26 * Protected constructor
30 protected function __construct () {
31 // Call parent constructor
32 parent::__construct(__CLASS__);
34 // Set part description
35 $this->setObjectDescription("Controller for handling forms");
37 // Create unique ID number
38 $this->generateUniqueId();
42 * Creates an instance of this class
44 * @param $resolverInstance An instance of a resolver class
45 * @return $controllerInstance A prepared instance of this class
47 public final static function createWebDoFormController (CommandResolver $resolverInstance) {
48 // Create the instance
49 $controllerInstance = new WebDoFormController();
51 // Set resolver instance
52 $controllerInstance->setResolverInstance($resolverInstance);
54 // We need the controller instance in the resolver class so set it here
55 $resolverInstance->setControllerInstance($controllerInstance);
57 // Return the prepared instance
58 return $controllerInstance;
62 * Handles the given request and response
64 * @param $requestInstance An instance of a request class
65 * @param $responseInstance An instance of a response class
68 public function handleRequest (Requestable $requestInstance, Responseable $responseInstance) {
69 // Get the "form action"
70 $formAction = $requestInstance->getRequestElement('form');
72 // Get command instance from resolver
73 $commandInstance = $this->getResolverInstance()->resolveCommand($formAction);
75 // Add more filters by the command
76 $commandInstance->addExtraFilters($this, $requestInstance);
78 // Try to run the pre filters, if auth exceptions come through redirect here
80 // Run the pre filters
81 $this->executePreFilters($requestInstance, $responseInstance);
82 } catch (UserAuthorizationException $e) {
83 // Redirect to main page
84 $responseInstance->redirectToConfiguredUrl('login_failed_url');
87 // Is the request still valid? Post filters shall only be executed of
88 // the request is valid
89 if ($requestInstance->isRequestValid()) {
90 // Execute the command
91 $commandInstance->execute($requestInstance, $responseInstance);
93 // Execute *very* generic ppost filters
94 $this->executePostFilters($requestInstance, $responseInstance);
97 // Flush the buffer out
98 $responseInstance->flushBuffer();