framework/main/tests/controller/console/class_TestsConsoleDefaultNewsController.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\CoreFramework\Tests\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\Object\ObjectFactory;
   9 use Org\Mxchange\CoreFramework\Filter\Filterable;
  10 use Org\Mxchange\CoreFramework\Request\Requestable;
  11 use Org\Mxchange\CoreFramework\Resolver\Command\CommandResolver;
  12 use Org\Mxchange\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 - 2023 Core 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         private function __construct () {
  43                 // Call parent constructor
  44                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('TEST-CONSOLE-DEFAULT-NEWS-CONTROLLER: CONSTRUCTED!');
  45                 parent::__construct(__CLASS__);
  46
  47                 // Init additional filter chains
  48                 foreach (['bootstrap', 'tests', 'shutdown'] as $filterChain) {
  49                         self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('TEST-CONSOLE-DEFAULT-NEWS-CONTROLLER: Initializing filterChain=%s ...', $filterChain));
  50                         $this->initFilterChain($filterChain);
  51                 }
  52
  53                 // Trace message
  54                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('TEST-CONSOLE-DEFAULT-NEWS-CONTROLLER: EXIT!');
  55         }
  56
  57         /**
  58          * Creates an instance of this class
  59          *
  60          * @param       $resolverInstance               An instance of a command resolver class
  61          * @return      $controllerInstance             A prepared instance of this class
  62          */
  63         public static final function createTestsConsoleDefaultNewsController (CommandResolver $resolverInstance) {
  64                 // Create the instance
  65                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('TEST-CONSOLE-DEFAULT-NEWS-CONTROLLER: resolverInstance=%s - CALLED!', $resolverInstance->__toString()));
  66                 $controllerInstance = new TestsConsoleDefaultNewsController();
  67
  68                 // Set the command resolver
  69                 $controllerInstance->setResolverInstance($resolverInstance);
  70
  71                 // Add news filters to this controller
  72                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('news_download_filter_class'));
  73                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('news_process_filter_class'));
  74
  75                 // Return the prepared instance
  76                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('TEST-CONSOLE-DEFAULT-NEWS-CONTROLLER: controllerInstance=%s - EXIT!', $controllerInstance->__toString()));
  77                 return $controllerInstance;
  78         }
  79
  80         /**
  81          * Handles the given request and response
  82          *
  83          * @param       $requestInstance        An instance of a request class
  84          * @param       $responseInstance       An instance of a response class
  85          * @return      void
  86          */
  87         public function handleRequest (Requestable $requestInstance, Responseable $responseInstance) {
  88                 // Get the command instance from the resolver by sending a request instance to the resolver
  89                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput(sprintf('TEST-CONSOLE-DEFAULT-NEWS-CONTROLLER: requestInstance=%s,responseInstance=%s - CALLED!', $requestInstance->__toString(), $responseInstance->__toString()));
  90                 $commandInstance = $this->getResolverInstance()->resolveCommandByRequest($requestInstance);
  91
  92                 // Add more filters by the command
  93                 $commandInstance->addExtraFilters($this, $requestInstance);
  94
  95                 // Run the pre filters
  96                 $this->executePreFilters($requestInstance, $responseInstance);
  97
  98                 // This request was valid! :-D
  99                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('TEST-CONSOLE-DEFAULT-NEWS-CONTROLLER: Invoking requestInstance->setIsRequestValid(TRUE) ...');
 100                 $requestInstance->setIsRequestValid(TRUE);
 101
 102                 // Execute the command
 103                 $commandInstance->execute($requestInstance, $responseInstance);
 104
 105                 // Run the post filters
 106                 $this->executePostFilters($requestInstance, $responseInstance);
 107
 108                 // Flush the response out
 109                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('TEST-CONSOLE-DEFAULT-NEWS-CONTROLLER: Invoking responseInstance->flushBuffer() ...');
 110                 $responseInstance->flushBuffer();
 111
 112                 // Trace message
 113                 /* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugOutput('TEST-CONSOLE-DEFAULT-NEWS-CONTROLLER: EXIT!');
 114         }
 115
 116         /**
 117          * Add a bootstrap filter
 118          *
 119          * @param       $filterInstance         A Filterable class
 120          * @return      void
 121          */
 122         public function addBootstrapFilter (Filterable $filterInstance) {
 123                 $this->addFilter('bootstrap', $filterInstance);
 124         }
 125
 126         /**
 127          * Add a tests filter
 128          *
 129          * @param       $filterInstance         A Filterable class
 130          * @return      void
 131          */
 132         public function addTestsFilter (Filterable $filterInstance) {
 133                 $this->addFilter('tests', $filterInstance);
 134         }
 135
 136         /**
 137          * Executes all bootstrap filters
 138          *
 139          * @param       $requestInstance        A Requestable class
 140          * @param       $responseInstance       A Responseable class
 141          * @return      void
 142          */
 143         public function executeBootstrapFilters (Requestable $requestInstance, Responseable $responseInstance) {
 144                 $this->executeFilters('bootstrap', $requestInstance, $responseInstance);
 145         }
 146
 147         /**
 148          * Executes all tests filters
 149          *
 150          * @param       $requestInstance        A Requestable class
 151          * @param       $responseInstance       A Responseable class
 152          * @return      void
 153          */
 154         public function executeTestsFilters (Requestable $requestInstance, Responseable $responseInstance) {
 155                 $this->executeFilters('tests', $requestInstance, $responseInstance);
 156         }
 157
 158 }