3 namespace Org\Mxchange\CoreFramework\Tests\Controller;
5 // Import framework stuff
6 use Org\Mxchange\CoreFramework\Controller\BaseController;
7 use Org\Mxchange\CoreFramework\Controller\Controller;
8 use Org\Mxchange\CoreFramework\Factory\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;
15 * The default controller with news for e.g. home or news page
17 * @author Roland Haeder <webmaster@shipsimu.org>
19 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2020 Core Developer Team
20 * @license GNU GPL 3.0 or any newer version
21 * @link http://www.shipsimu.org
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.
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.
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/>.
36 class TestsConsoleDefaultNewsController extends BaseController implements Controller {
38 * Protected constructor
42 protected function __construct () {
43 // Call parent constructor
44 parent::__construct(__CLASS__);
46 // Init additional filter chains
47 foreach (array('bootstrap', 'tests', 'shutdown') as $filterChain) {
48 $this->initFilterChain($filterChain);
53 * Creates an instance of this class
55 * @param $resolverInstance An instance of a command resolver class
56 * @return $controllerInstance A prepared instance of this class
58 public static final function createTestsConsoleDefaultNewsController (CommandResolver $resolverInstance) {
59 // Create the instance
60 $controllerInstance = new TestsConsoleDefaultNewsController();
62 // Set the command resolver
63 $controllerInstance->setResolverInstance($resolverInstance);
65 // Add news filters to this controller
66 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('news_download_filter_class'));
67 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('news_process_filter_class'));
69 // Return the prepared instance
70 return $controllerInstance;
74 * Handles the given request and response
76 * @param $requestInstance An instance of a request class
77 * @param $responseInstance An instance of a response class
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);
84 // Add more filters by the command
85 $commandInstance->addExtraFilters($this, $requestInstance);
87 // Run the pre filters
88 $this->executePreFilters($requestInstance, $responseInstance);
90 // This request was valid! :-D
91 $requestInstance->requestIsValid();
93 // Execute the command
94 $commandInstance->execute($requestInstance, $responseInstance);
96 // Run the post filters
97 $this->executePostFilters($requestInstance, $responseInstance);
99 // Flush the response out
100 $responseInstance->flushBuffer();
104 * Add a bootstrap filter
106 * @param $filterInstance A Filterable class
109 public function addBootstrapFilter (Filterable $filterInstance) {
110 $this->addFilter('bootstrap', $filterInstance);
116 * @param $filterInstance A Filterable class
119 public function addTestsFilter (Filterable $filterInstance) {
120 $this->addFilter('tests', $filterInstance);
124 * Executes all bootstrap filters
126 * @param $requestInstance A Requestable class
127 * @param $responseInstance A Responseable class
130 public function executeBootstrapFilters (Requestable $requestInstance, Responseable $responseInstance) {
131 $this->executeFilters('bootstrap', $requestInstance, $responseInstance);
135 * Executes all tests filters
137 * @param $requestInstance A Requestable class
138 * @param $responseInstance A Responseable class
141 public function executeTestsFilters (Requestable $requestInstance, Responseable $responseInstance) {
142 $this->executeFilters('tests', $requestInstance, $responseInstance);