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