application/tests/classes/controller/console/class_TestsConsoleDefaultNewsController.php

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