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