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\Request\Requestable;
  10 use CoreFramework\Resolver\Command\CommandResolver;
  11 use 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) 2007, 2008 Roland Haeder, 2009 - 2015 Hub 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 TestsConsoleDefaultNewsController 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                 /*
  47                 foreach (array('bootstrap', 'activation','shutdown') as $filterChain) {
  48                         $this->initFilterChain($filterChain);
  49                 } // END - foreach
  50                 */
  51         }
  52
  53         /**
  54          * Creates an instance of this class
  55          *
  56          * @param       $resolverInstance               An instance of a command resolver class
  57          * @return      $controllerInstance             A prepared instance of this class
  58          */
  59         public static final function createTestsConsoleDefaultNewsController (CommandResolver $resolverInstance) {
  60                 // Create the instance
  61                 $controllerInstance = new TestsConsoleDefaultNewsController();
  62
  63                 // Set the command resolver
  64                 $controllerInstance->setResolverInstance($resolverInstance);
  65
  66                 // Add news filters to this controller
  67                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('news_download_filter'));
  68                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('news_process_filter'));
  69
  70                 // Return the prepared instance
  71                 return $controllerInstance;
  72         }
  73
  74         /**
  75          * Handles the given request and response
  76          *
  77          * @param       $requestInstance        An instance of a request class
  78          * @param       $responseInstance       An instance of a response class
  79          * @return      void
  80          */
  81         public function handleRequest (Requestable $requestInstance, Responseable $responseInstance) {
  82                 // Get the command instance from the resolver by sending a request instance to the resolver
  83                 $commandInstance = $this->getResolverInstance()->resolveCommandByRequest($requestInstance);
  84
  85                 // Add more filters by the command
  86                 $commandInstance->addExtraFilters($this, $requestInstance);
  87
  88                 // Run the pre filters
  89                 $this->executePreFilters($requestInstance, $responseInstance);
  90
  91                 // This request was valid! :-D
  92                 $requestInstance->requestIsValid();
  93
  94                 // Execute the command
  95                 $commandInstance->execute($requestInstance, $responseInstance);
  96
  97                 // Run the pre filters
  98                 $this->executePostFilters($requestInstance, $responseInstance);
  99
 100                 // Flush the response out
 101                 $responseInstance->flushBuffer();
 102         }
 103
 104         /**
 105          * Add a bootstrap filter
 106          *
 107          * @param       $filterInstance         A Filterable class
 108          * @return      void
 109          */
 110         public function addBootstrapFilter (Filterable $filterInstance) {
 111                 $this->addFilter('bootstrap', $filterInstance);
 112         }
 113
 114         /**
 115          * Executes all bootstrap filters
 116          *
 117          * @param       $requestInstance        A Requestable class
 118          * @param       $responseInstance       A Responseable class
 119          * @return      void
 120          */
 121         public function executeBootstrapFilters (Requestable $requestInstance, Responseable $responseInstance) {
 122                 $this->executeFilters('bootstrap', $requestInstance, $responseInstance);
 123         }
 124
 125         /**
 126          * Add a hub activation filter
 127          *
 128          * @param       $filterInstance         A Filterable class
 129          * @return      void
 130          */
 131         public function addActivationFilter (Filterable $filterInstance) {
 132                 $this->addFilter('activation', $filterInstance);
 133         }
 134
 135         /**
 136          * Executes all hub activation filters
 137          *
 138          * @param       $requestInstance        A Requestable class
 139          * @param       $responseInstance       A Responseable class
 140          * @return      void
 141          */
 142         public function executeActivationFilters (Requestable $requestInstance, Responseable $responseInstance) {
 143                 $this->executeFilters('activation', $requestInstance, $responseInstance);
 144         }
 145
 146 }