application/city/classes/controller/console/class_CityConsoleDefaultNewsController.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\City\Controller;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Controller\BaseController;
   7 use Org\Mxchange\CoreFramework\Controller\Controller;
   8 use Org\Mxchange\CoreFramework\Request\Requestable;
   9 use Org\Mxchange\CoreFramework\Response\Responseable;
  10
  11 /**
  12  * The default controller with news for e.g. home or news page
  13  *
  14  * @author              Roland Haeder <webmaster@shipsimu.org>
  15  * @version             0.0.0
  16  * @copyright   Copyright (c) 2015, 2016 City Developer Team
  17  * @license             GNU GPL 3.0 or any newer version
  18  * @link                http://www.shipsimu.org
  19  *
  20  * This program is free software: you can redistribute it and/or modify
  21  * it under the terms of the GNU General Public License as published by
  22  * the Free Software Foundation, either version 3 of the License, or
  23  * (at your option) any later version.
  24  *
  25  * This program is distributed in the hope that it will be useful,
  26  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  27  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28  * GNU General Public License for more details.
  29  *
  30  * You should have received a copy of the GNU General Public License
  31  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  32  */
  33 class CityConsoleDefaultNewsController extends BaseController implements Controller {
  34         /**
  35          * Protected constructor
  36          *
  37          * @return      void
  38          */
  39         protected function __construct () {
  40                 // Call parent constructor
  41                 parent::__construct(__CLASS__);
  42
  43                 // Init additional filter chains
  44                 foreach (array('bootstrap', 'activation','shutdown') as $filterChain) {
  45                         $this->initFilterChain($filterChain);
  46                 } // END - foreach
  47         }
  48
  49         /**
  50          * Creates an instance of this class
  51          *
  52          * @param       $resolverInstance               An instance of a command resolver class
  53          * @return      $controllerInstance             A prepared instance of this class
  54          */
  55         public static final function createCityConsoleDefaultNewsController (CommandResolver $resolverInstance) {
  56                 // Create the instance
  57                 $controllerInstance = new CityConsoleDefaultNewsController();
  58
  59                 // Set the command resolver
  60                 $controllerInstance->setResolverInstance($resolverInstance);
  61
  62                 // Add news filters to this controller
  63                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('news_download_filter'));
  64                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('news_process_filter'));
  65
  66                 // Return the prepared instance
  67                 return $controllerInstance;
  68         }
  69
  70         /**
  71          * Handles the given request and response
  72          *
  73          * @param       $requestInstance        An instance of a request class
  74          * @param       $responseInstance       An instance of a response class
  75          * @return      void
  76          */
  77         public function handleRequest (Requestable $requestInstance, Responseable $responseInstance) {
  78                 // Get the command instance from the resolver by sending a request instance to the resolver
  79                 $commandInstance = $this->getResolverInstance()->resolveCommandByRequest($requestInstance);
  80
  81                 // Add more filters by the command
  82                 $commandInstance->addExtraFilters($this, $requestInstance);
  83
  84                 // Run the pre filters
  85                 $this->executePreFilters($requestInstance, $responseInstance);
  86
  87                 // This request was valid! :-D
  88                 $requestInstance->requestIsValid();
  89
  90                 // Execute the command
  91                 $commandInstance->execute($requestInstance, $responseInstance);
  92
  93                 // Run the pre filters
  94                 $this->executePostFilters($requestInstance, $responseInstance);
  95
  96                 // Flush the response out
  97                 $responseInstance->flushBuffer();
  98         }
  99
 100         /**
 101          * Add a bootstrap filter
 102          *
 103          * @param       $filterInstance         A Filterable class
 104          * @return      void
 105          */
 106         public function addBootstrapFilter (Filterable $filterInstance) {
 107                 $this->addFilter('bootstrap', $filterInstance);
 108         }
 109
 110         /**
 111          * Executes all bootstrap filters
 112          *
 113          * @param       $requestInstance        A Requestable class
 114          * @param       $responseInstance       A Responseable class
 115          * @return      void
 116          */
 117         public function executeBootstrapFilters (Requestable $requestInstance, Responseable $responseInstance) {
 118                 $this->executeFilters('bootstrap', $requestInstance, $responseInstance);
 119         }
 120
 121         /**
 122          * Add a city activation filter
 123          *
 124          * @param       $filterInstance         A Filterable class
 125          * @return      void
 126          */
 127         public function addActivationFilter (Filterable $filterInstance) {
 128                 $this->addFilter('activation', $filterInstance);
 129         }
 130
 131         /**
 132          * Executes all city activation filters
 133          *
 134          * @param       $requestInstance        A Requestable class
 135          * @param       $responseInstance       A Responseable class
 136          * @return      void
 137          */
 138         public function executeActivationFilters (Requestable $requestInstance, Responseable $responseInstance) {
 139                 $this->executeFilters('activation', $requestInstance, $responseInstance);
 140         }
 141 }