application/hub/main/filter/shutdown/class_HubShutdown

   1 <?php
   2 /**
   3  * A ??? filter for shutting down the node.
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.org
  10  *
  11  * This program is free software: you can redistribute it and/or modify
  12  * it under the terms of the GNU General Public License as published by
  13  * the Free Software Foundation, either version 3 of the License, or
  14  * (at your option) any later version.
  15  *
  16  * This program is distributed in the hope that it will be useful,
  17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  19  * GNU General Public License for more details.
  20  *
  21  * You should have received a copy of the GNU General Public License
  22  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23  */
  24 class HubShutdown???Filter extends BaseFilter implements Filterable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of this filter class
  37          *
  38          * @return      $filterInstance         An instance of this filter class
  39          */
  40         public final static function createHubShutdown???Filter () {
  41                 // Get a new instance
  42                 $filterInstance = new HubShutdown???Filter();
  43
  44                 // Return the instance
  45                 return $filterInstance;
  46         }
  47
  48         /**
  49          * Executes the filter with given request and response objects
  50          *
  51          * @param       $requestInstance        An instance of a class with an Requestable interface
  52          * @param       $responseInstance       An instance of a class with an Responseable interface
  53          * @return      void
  54          * @throws      FilterChainException    If $nodeInstance is null (no NullPointerException here)
  55          * @todo        0% done
  56          */
  57         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
  58                 // Get node instance
  59                 $nodeInstance = Registry::getRegistry()->getInstance('node');
  60
  61                 // Sanity-check on it
  62                 if (is_null($nodeInstance)) {
  63                         // Throws a FilterChainException to stop further processing
  64                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
  65                 } // END - if
  66
  67                 // Now do something
  68                 $this->partialStub('Please implement this step.');
  69         }
  70 }
  71
  72 // [EOF]
  73 ?>
  74 <?php
  75 /**
  76  * A ??? filter for shutting down the node.
  77  *
  78  * @author              Roland Haeder <webmaster@ship-simu.org>
  79  * @version             0.0.0
  80  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
  81  * @license             GNU GPL 3.0 or any newer version
  82  * @link                http://www.ship-simu.org
  83  *
  84  * This program is free software: you can redistribute it and/or modify
  85  * it under the terms of the GNU General Public License as published by
  86  * the Free Software Foundation, either version 3 of the License, or
  87  * (at your option) any later version.
  88  *
  89  * This program is distributed in the hope that it will be useful,
  90  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  91  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  92  * GNU General Public License for more details.
  93  *
  94  * You should have received a copy of the GNU General Public License
  95  * along with this program. If not, see <http://www.gnu.org/licenses/>.
  96  */
  97 class HubShutdown???Filter extends BaseFilter implements Filterable {
  98         /**
  99          * Protected constructor
 100          *
 101          * @return      void
 102          */
 103         protected function __construct () {
 104                 // Call parent constructor
 105                 parent::__construct(__CLASS__);
 106         }
 107
 108         /**
 109          * Creates an instance of this filter class
 110          *
 111          * @return      $filterInstance         An instance of this filter class
 112          */
 113         public final static function createHubShutdown???Filter () {
 114                 // Get a new instance
 115                 $filterInstance = new HubShutdown???Filter();
 116
 117                 // Return the instance
 118                 return $filterInstance;
 119         }
 120
 121         /**
 122          * Executes the filter with given request and response objects
 123          *
 124          * @param       $requestInstance        An instance of a class with an Requestable interface
 125          * @param       $responseInstance       An instance of a class with an Responseable interface
 126          * @return      void
 127          * @throws      FilterChainException    If $nodeInstance is null (no NullPointerException here)
 128          * @todo        0% done
 129          */
 130         public function execute (Requestable $requestInstance, Responseable $responseInstance) {
 131                 // Get node instance
 132                 $nodeInstance = Registry::getRegistry()->getInstance('node');
 133
 134                 // Sanity-check on it
 135                 if (is_null($nodeInstance)) {
 136                         // Throws a FilterChainException to stop further processing
 137                         throw new FilterChainException($this, self::EXCEPTION_FILTER_CHAIN_INTERCEPTED);
 138                 } // END - if
 139
 140                 // Now do something
 141                 $this->partialStub('Please implement this step.');
 142         }
 143 }
 144
 145 // [EOF]
 146 ?>