application/hub/classes/states/dht/class_BaseDhtState.php

   1 <?php
   2 /**
   3  * A general DHT state class
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.shipsimu.org
  10  * @todo                Create generic DHT interface
  11  *
  12  * This program is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation, either version 3 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  24  */
  25 class BaseDhtState extends BaseState {
  26         /**
  27          * Protected constructor
  28          *
  29          * @param       $className      Name of the class
  30          * @return      void
  31          */
  32         protected function __construct ($className) {
  33                 // Call parent constructor
  34                 parent::__construct($className);
  35         }
  36
  37         /**
  38          * Validates whether the DHT state is 'virgin' or throws an exception if it
  39          * is every other state.
  40          *
  41          * @return      void
  42          * @throws      UnexpectedStateException        If the state is not 'virgin'
  43          */
  44         public function validateDhtStateIsVirginOrInit () {
  45                 // Just compare it...
  46                 if ((!$this instanceof DhtVirginState) && (!$this instanceof DhtInitState)) {
  47                         // Throw the exception
  48                         throw new UnexpectedStateException($this, self::EXCEPTION_INVALID_STATE);
  49                 } // END - if
  50         }
  51
  52         /**
  53          * Checks whether the DHT's state is 'booting' by comparing it with the
  54          * state's class name.
  55          *
  56          * @return      $isBooting      Whether this DHT's state is 'booting'
  57          */
  58         public function ifDhtIsBooting () {
  59                 // Check state
  60                 $isBooting = ($this instanceof DhtBootingState);
  61
  62                 // Return status
  63                 return $isBooting;
  64         }
  65 }
  66
  67 // [EOF]
  68 ?>