application/hub/classes/controller/console/class_HubConsoleChatController.php

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