framework/main/classes/controller/class_

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