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

   1 <?php
   2 /**
   3  * The default controller with news for e.g. home or news page
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub 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 HubConsoleDefaultNewsController 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', 'activation','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 createHubConsoleDefaultNewsController (CommandResolver $resolverInstance) {
  47                 // Create the instance
  48                 $controllerInstance = new HubConsoleDefaultNewsController();
  49
  50                 // Set the command resolver
  51                 $controllerInstance->setResolverInstance($resolverInstance);
  52
  53                 // Add news filters to this controller
  54                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('news_download_filter'));
  55                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('news_process_filter'));
  56
  57                 // Return the prepared instance
  58                 return $controllerInstance;
  59         }
  60
  61         /**
  62          * Handles the given request and response
  63          *
  64          * @param       $requestInstance        An instance of a request class
  65          * @param       $responseInstance       An instance of a response class
  66          * @return      void
  67          */
  68         public function handleRequest (Requestable $requestInstance, Responseable $responseInstance) {
  69                 // Get the command instance from the resolver by sending a request instance to the resolver
  70                 $commandInstance = $this->getResolverInstance()->resolveCommandByRequest($requestInstance);
  71
  72                 // Add more filters by the command
  73                 $commandInstance->addExtraFilters($this, $requestInstance);
  74
  75                 // Run the pre filters
  76                 $this->executePreFilters($requestInstance, $responseInstance);
  77
  78                 // This request was valid! :-D
  79                 $requestInstance->requestIsValid();
  80
  81                 // Execute the command
  82                 $commandInstance->execute($requestInstance, $responseInstance);
  83
  84                 // Run the pre filters
  85                 $this->executePostFilters($requestInstance, $responseInstance);
  86
  87                 // Flush the response out
  88                 $responseInstance->flushBuffer();
  89         }
  90
  91         /**
  92          * Add a bootstrap filter
  93          *
  94          * @param       $filterInstance         A Filterable class
  95          * @return      void
  96          */
  97         public function addBootstrapFilter (Filterable $filterInstance) {
  98                 $this->addFilter('bootstrap', $filterInstance);
  99         }
 100
 101         /**
 102          * Executes all bootstrap filters
 103          *
 104          * @param       $requestInstance        A Requestable class
 105          * @param       $responseInstance       A Responseable class
 106          * @return      void
 107          */
 108         public function executeBootstrapFilters (Requestable $requestInstance, Responseable $responseInstance) {
 109                 $this->executeFilters('bootstrap', $requestInstance, $responseInstance);
 110         }
 111
 112         /**
 113          * Add a hub activation filter
 114          *
 115          * @param       $filterInstance         A Filterable class
 116          * @return      void
 117          */
 118         public function addActivationFilter (Filterable $filterInstance) {
 119                 $this->addFilter('activation', $filterInstance);
 120         }
 121
 122         /**
 123          * Executes all hub activation filters
 124          *
 125          * @param       $requestInstance        A Requestable class
 126          * @param       $responseInstance       A Responseable class
 127          * @return      void
 128          */
 129         public function executeActivationFilters (Requestable $requestInstance, Responseable $responseInstance) {
 130                 $this->executeFilters('activation', $requestInstance, $responseInstance);
 131         }
 132 }
 133
 134 // [EOF]
 135 ?>