3 namespace Org\Mxchange\City\Daemon\Filter;
5 // Import application-specific stuff
6 use Org\Mxchange\City\Filter\BaseCityFilter;
7 use Org\Mxchange\Factory\City\Daemon\CityDaemonFactory;
9 // Import framework stuff
10 use Org\Mxchange\CoreFramework\Filter\Chain\FilterChainException;
11 use Org\Mxchange\CoreFramework\Filter\Filterable;
12 use Org\Mxchange\CoreFramework\Request\Requestable;
13 use Org\Mxchange\CoreFramework\Response\Responseable;
16 * A welcome-teaser filter for the console
18 * @author Roland Haeder <webmaster@shipsimu.org>
20 * @copyright Copyright (c) 2015 - 2023 City Developer Team
21 * @license GNU GPL 3.0 or any newer version
22 * @link http://www.shipsimu.org
24 * This program is free software: you can redistribute it and/or modify
25 * it under the terms of the GNU General Public License as published by
26 * the Free Software Foundation, either version 3 of the License, or
27 * (at your option) any later version.
29 * This program is distributed in the hope that it will be useful,
30 * but WITHOUT ANY WARRANTY; without even the implied warranty of
31 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
32 * GNU General Public License for more details.
34 * You should have received a copy of the GNU General Public License
35 * along with this program. If not, see <http://www.gnu.org/licenses/>.
37 class CityDaemonWelcomeTeaserFilter extends BaseCityFilter implements Filterable {
39 * Protected constructor
43 protected function __construct () {
44 // Call parent constructor
45 parent::__construct(__CLASS__);
49 * Creates an instance of this filter class
51 * @return $filterInstance An instance of this filter class
53 public static final function createCityDaemonWelcomeTeaserFilter () {
55 $filterInstance = new CityDaemonWelcomeTeaserFilter();
57 // Return the instance
58 return $filterInstance;
62 * Executes the filter with given request and response objects
64 * @param $requestInstance An instance of a class with an Requestable interface
65 * @param $responseInstance An instance of a class with an Responseable interface
67 * @throws FilterChainException If $cityInstance is null (no NullPointerException here)
68 * @todo Handle over the $responseInstance to outputConsoleTeaser()
70 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
72 $cityInstance = CityDaemonFactory::createCityDaemonInstance();
74 // Now output the teaser
75 $cityInstance->outputConsoleTeaser();