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