inc/main/classes/controller/html/class_HtmlDefaultController.php

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