application/hub/main/controller/console/class_HubConsoleCruncherController.php

   1 <?php
   2 /**
   3  * A console controller for the cruncher, which is our very first hub
   4  * application.
   5  *
   6  * @author              Roland Haeder <webmaster@shipsimu.org>
   7  * @version             0.0.0
   8  * @copyright   Copyright (c) 2011 - 2014 Cruncher Developer Team
   9  * @license             GNU GPL 3.0 or any newer version
  10  * @link                http://www.shipsimu.org
  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 HubConsoleCruncherController 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                 // Init additional filter chains
  36                 foreach (array('bootstrap','shutdown') as $filterChain) {
  37                         $this->initFilterChain($filterChain);
  38                 } // END - foreach
  39         }
  40
  41         /**
  42          * Creates an instance of this class
  43          *
  44          * @param       $resolverInstance               An instance of a command resolver class
  45          * @return      $controllerInstance             A prepared instance of this class
  46          */
  47         public static final function createHubConsoleCruncherController (CommandResolver $resolverInstance) {
  48                 // Create the instance
  49                 $controllerInstance = new HubConsoleCruncherController();
  50
  51                 // Set the command resolver
  52                 $controllerInstance->setResolverInstance($resolverInstance);
  53
  54                 // Return the prepared instance
  55                 return $controllerInstance;
  56         }
  57
  58         /**
  59          * Handles the given request and response
  60          *
  61          * @param       $requestInstance        An instance of a request class
  62          * @param       $responseInstance       An instance of a response class
  63          * @return      void
  64          */
  65         public function handleRequest (Requestable $requestInstance, Responseable $responseInstance) {
  66                 // Get the command instance from the resolver by sending a request instance to the resolver
  67                 $commandInstance = $this->getResolverInstance()->resolveCommandByRequest($requestInstance);
  68
  69                 // Add more filters by the command
  70                 $commandInstance->addExtraFilters($this, $requestInstance);
  71
  72                 // Run the pre filters
  73                 $this->executePreFilters($requestInstance, $responseInstance);
  74
  75                 // This request was valid! :-D
  76                 $requestInstance->requestIsValid();
  77
  78                 // Execute the command
  79                 $commandInstance->execute($requestInstance, $responseInstance);
  80
  81                 // Run the pre filters
  82                 $this->executePostFilters($requestInstance, $responseInstance);
  83
  84                 // Flush the response out
  85                 $responseInstance->flushBuffer();
  86         }
  87
  88         /**
  89          * Add a bootstrap filter
  90          *
  91          * @param       $filterInstance         A Filterable class
  92          * @return      void
  93          */
  94         public function addBootstrapFilter (Filterable $filterInstance) {
  95                 $this->addFilter('bootstrap', $filterInstance);
  96         }
  97
  98         /**
  99          * Executes all bootstrap filters
 100          *
 101          * @param       $requestInstance        A Requestable class
 102          * @param       $responseInstance       A Responseable class
 103          * @return      void
 104          */
 105         public function executeBootstrapFilters (Requestable $requestInstance, Responseable $responseInstance) {
 106                 $this->executeFilters('bootstrap', $requestInstance, $responseInstance);
 107         }
 108 }
 109
 110 // [EOF]
 111 ?>