3 namespace Org\Mxchange\City\Daemon\Filter\Shutdown;
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 ShutdownCity filter for shutting down the city. This filter should be the
16 * last one in 'shutdown' chain so the hub is shutted down at the very end of
17 * its life... R.I.P. little hub...
19 * @author Roland Haeder <webmaster@shipsimu.org>
21 * @copyright Copyright (c) 2015, 2016 City Developer Team
22 * @license GNU GPL 3.0 or any newer version
23 * @link http://www.shipsimu.org
25 * This program is free software: you can redistribute it and/or modify
26 * it under the terms of the GNU General Public License as published by
27 * the Free Software Foundation, either version 3 of the License, or
28 * (at your option) any later version.
30 * This program is distributed in the hope that it will be useful,
31 * but WITHOUT ANY WARRANTY; without even the implied warranty of
32 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
33 * GNU General Public License for more details.
35 * You should have received a copy of the GNU General Public License
36 * along with this program. If not, see <http://www.gnu.org/licenses/>.
38 class CityDaemonShutdownCityFilter extends BaseCityFilter implements Filterable {
40 * Protected constructor
44 protected function __construct () {
45 // Call parent constructor
46 parent::__construct(__CLASS__);
50 * Creates an instance of this filter class
52 * @return $filterInstance An instance of this filter class
54 public static final function createCityDaemonShutdownCityFilter () {
56 $filterInstance = new CityDaemonShutdownCityFilter();
58 // Return the instance
59 return $filterInstance;
63 * Executes the filter with given request and response objects
65 * @param $requestInstance An instance of a class with an Requestable interface
66 * @param $responseInstance An instance of a class with an Responseable interface
68 * @throws FilterChainException If $cityInstance is null (no NullPointerException please)
70 public function execute (Requestable $requestInstance, Responseable $responseInstance) {
72 $cityInstance = CityDaemonFactory::createCityDaemonInstance();
74 // Shutdown the city. This should be the last line
75 $cityInstance->doShutdown();