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