55f6b1a7b01df1953009249b0164808db0fdb4ff
[core.git] / framework / main / classes / controller / html / class_HtmlDefaultController.php
1 <?php
2 // Own namespace
3 namespace Org\Mxchange\CoreFramework\Controller;
4
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Controller\BaseController;
7 use Org\Mxchange\CoreFramework\Controller\Controller;
8 use Org\Mxchange\CoreFramework\Request\Requestable;
9 use Org\Mxchange\CoreFramework\Resolver\Command\CommandResolver;
10 use Org\Mxchange\CoreFramework\Response\Responseable;
11
12 /**
13  * The default controller for all other web requests
14  *
15  * @author              Roland Haeder <webmaster@shipsimu.org>
16  * @version             0.0.0
17 <<<<<<< HEAD:framework/main/classes/controller/html/class_HtmlDefaultController.php
18  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2017 Core Developer Team
19 =======
20  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2016 Core Developer Team
21 >>>>>>> Some updates::inc/main/classes/controller/html/class_HtmlDefaultController.php
22  * @license             GNU GPL 3.0 or any newer version
23  * @link                http://www.shipsimu.org
24  * @todo                This controller shall still provide some headlines for sidebars
25  *
26  * This program is free software: you can redistribute it and/or modify
27  * it under the terms of the GNU General Public License as published by
28  * the Free Software Foundation, either version 3 of the License, or
29  * (at your option) any later version.
30  *
31  * This program is distributed in the hope that it will be useful,
32  * but WITHOUT ANY WARRANTY; without even the implied warranty of
33  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
34  * GNU General Public License for more details.
35  *
36  * You should have received a copy of the GNU General Public License
37  * along with this program. If not, see <http://www.gnu.org/licenses/>.
38  */
39 class HtmlDefaultController extends BaseController implements Controller {
40         /**
41          * Protected constructor
42          *
43          * @return      void
44          */
45         protected function __construct () {
46                 // Call parent constructor
47                 parent::__construct(__CLASS__);
48         }
49
50         /**
51          * Creates an instance of this class
52          *
53          * @param       $resolverInstance               An instance of a command resolver class
54          * @return      $controllerInstance             A prepared instance of this class
55          */
56         public static final function createHtmlDefaultController (CommandResolver $resolverInstance) {
57                 // Create the instance
58                 $controllerInstance = new HtmlDefaultController();
59
60                 // Set the command resolver
61                 $controllerInstance->setResolverInstance($resolverInstance);
62
63                 // Return the prepared instance
64                 return $controllerInstance;
65         }
66
67         /**
68          * Handles the given request and response
69          *
70          * @param       $requestInstance        An instance of a Requestable class
71          * @param       $responseInstance       An instance of a Responseable class
72          * @return      void
73          */
74         public function handleRequest (Requestable $requestInstance, Responseable $responseInstance) {
75                 // Get the command instance
76                 $commandInstance = $this->getResolverInstance()->resolveCommandByRequest($requestInstance);
77
78                 // This request was valid! :-D
79                 $requestInstance->requestIsValid();
80
81                 // Execute the command
82                 $commandInstance->execute($requestInstance, $responseInstance);
83
84                 // Flush the response out
85                 $responseInstance->flushBuffer();
86         }
87
88 }