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