inc/main/classes/controller/console/class_ConsoleDefaultController.php

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