inc/classes/main/controller/web/class_WebDefaultController.php

   1 <?php
   2 /**
   3  * The default controller for all other web requests
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, this is free software
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  * @todo                This controller shall still provide some headlines for sidebars
  11  *
  12  * This program is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation, either version 3 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  24  */
  25 class WebDefaultController extends BaseController implements Controller {
  26         /**
  27          * Protected constructor
  28          *
  29          * @return      void
  30          */
  31         protected function __construct () {
  32                 // Call parent constructor
  33                 parent::__construct(__CLASS__);
  34
  35                 // Set part description
  36                 $this->setObjectDescription("Default controller for all other web requests");
  37
  38                 // Create unique ID number
  39                 $this->generateUniqueId();
  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 final static function createWebDefaultController (CommandResolver $resolverInstance) {
  49                 // Create the instance
  50                 $controllerInstance = new WebDefaultController();
  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 request class
  63          * @param       $responseInstance       An instance of a response 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
  81 // [EOF]
  82 ?>