application/city/classes/filter/shutdown/city/class_CityDaemonShutdownCityFilter.php

   1 <?php
   2 // Own namespace
   3 namespace Org\Mxchange\City\Daemon\Filter\Shutdown;
   4
   5 // Import framework stuff
   6 use Org\Mxchange\CoreFramework\Request\Requestable;
   7 use Org\Mxchange\CoreFramework\Response\Responseable;
   8
   9 /**
  10  * A ShutdownCity filter for shutting down the city. This filter should be the
  11  * last one in 'shutdown' chain so the hub is shutted down at the very end of
  12  * its life... R.I.P. little hub...
  13  *
  14  * @author              Roland Haeder <webmaster@shipsimu.org>
  15  * @version             0.0.0
  16  * @copyright   Copyright (c) 2015, 2016 City Developer Team
  17  * @license             GNU GPL 3.0 or any newer version
  18  * @link                http://www.shipsimu.org
  19  *
  20  * This program is free software: you can redistribute it and/or modify
  21  * it under the terms of the GNU General Public License as published by
  22  * the Free Software Foundation, either version 3 of the License, or
  23  * (at your option) any later version.
  24  *
  25  * This program is distributed in the hope that it will be useful,
  26  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  27  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  28  * GNU General Public License for more details.
  29  *
  30  * You should have received a copy of the GNU General Public License
  31  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  32  */
  33 class CityDaemonShutdownCityFilter extends BaseCityFilter implements Filterable {
  34         /**
  35          * Protected constructor
  36          *
  37          * @return      void
  38          */
  39         protected function __construct () {
  40                 // Call parent constructor
  41                 parent::__construct(__CLASS__);
  42         }
  43
  44         /**
  45          * Creates an instance of this filter class
  46          *
  47          * @return      $filterInstance         An instance of this filter class
  48          */
  49         public static final function createCityDaemonShutdownCityFilter () {
  50                 // Get a new instance
  51                 $filterInstance = new CityDaemonShutdownCityFilter();
  52
  53                 // Return the instance
  54                 return $filterInstance;
  55         }
  56
  57         /**
  58          * Executes the filter with given request and response objects
  59          *
  60          * @param       $requestInstance        An instance of a class with an Requestable interface
  61          * @param       $responseInstance       An instance of a class with an Responseable interface
  62          * @return      void
  63          * @throws      FilterChainException    If $cityInstance is null (no NullPointerException please)
  64          */
  65         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  66                 // Get city instance
  67                 $cityInstance = CityDaemonFactory::createCityDaemonInstance();
  68
  69                 // Shutdown the city. This should be the last line
  70                 $cityInstance->doShutdown();
  71         }
  72 }