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

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