3 namespace Org\Mxchange\City\Daemon\Filter\Initialization;
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\Filterable;
11 use Org\Mxchange\CoreFramework\Request\Requestable;
12 use Org\Mxchange\CoreFramework\Response\Responseable;
15 * A Initialization filter for cities
17 * @author Roland Haeder <webmaster@shipsimu.org>
19 * @copyright Copyright (c) 2015 - 2023 City 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 CityDaemonInitializationFilter extends BaseCityFilter implements Filterable {
38 * Protected constructor
42 protected function __construct () {
43 // Call parent constructor
44 parent::__construct(__CLASS__);
48 * Creates an instance of this filter class
50 * @return $filterInstance An instance of this filter class
52 public static final function createCityDaemonInitializationFilter () {
54 $filterInstance = new CityDaemonInitializationFilter();
56 // Return the instance
57 return $filterInstance;
61 * Executes the filter with given request and response objects
63 * @param $requestInstance An instance of a class with an Requestable interface
64 * @param $responseInstance An instance of a class with an Responseable interface
67 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
68 // Try to instance it by using a factory
71 $cityInstance = CityDaemonFactory::createCityDaemonInstance($requestInstance, $responseInstance);
72 } catch (ClassNotFoundException $e) {
73 // This exception means, the city mode is invalid.
74 // @TODO Can we rewrite this to app_exit() ?
75 $this->debugBackTrace('[' . __METHOD__ . ':' . __LINE__ . ']: City daemon could not be initialized: ' . $e->getMessage());
79 /* DEBUG: */ self::createDebugInstance(__CLASS__, __LINE__)->debugMessage('CITY-INIT-FILTER[' . __METHOD__ . ':' . __LINE__ . ']: City daemon has been added to registry.');