]> git.mxchange.org Git - core.git/blob - framework/main/tests/controller/console/class_TestsConsoleDefaultNewsController.php
Continued:
[core.git] / 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\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 - 2020 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         protected function __construct () {
43                 // Call parent constructor
44                 parent::__construct(__CLASS__);
45
46                 // Init additional filter chains
47                 foreach (array('bootstrap', 'tests', 'shutdown') as $filterChain) {
48                         $this->initFilterChain($filterChain);
49                 } // END - foreach
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_class'));
67                 $controllerInstance->addPreFilter(ObjectFactory::createObjectByConfiguredName('news_process_filter_class'));
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 post 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          * Add a tests filter
115          *
116          * @param       $filterInstance         A Filterable class
117          * @return      void
118          */
119         public function addTestsFilter (Filterable $filterInstance) {
120                 $this->addFilter('tests', $filterInstance);
121         }
122
123         /**
124          * Executes all bootstrap filters
125          *
126          * @param       $requestInstance        A Requestable class
127          * @param       $responseInstance       A Responseable class
128          * @return      void
129          */
130         public function executeBootstrapFilters (Requestable $requestInstance, Responseable $responseInstance) {
131                 $this->executeFilters('bootstrap', $requestInstance, $responseInstance);
132         }
133
134         /**
135          * Executes all tests filters
136          *
137          * @param       $requestInstance        A Requestable class
138          * @param       $responseInstance       A Responseable class
139          * @return      void
140          */
141         public function executeTestsFilters (Requestable $requestInstance, Responseable $responseInstance) {
142                 $this->executeFilters('tests', $requestInstance, $responseInstance);
143         }
144
145 }