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