application/hub/classes/states/peer/class_BasePeerState.php

   1 <?php
   2 /**
   3  * A general peer 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  *
  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 BasePeerState extends BaseState {
  25         /**
  26          * Protected constructor
  27          *
  28          * @param       $className      Name of the class
  29          * @return      void
  30          */
  31         protected function __construct ($className) {
  32                 // Call parent constructor
  33                 parent::__construct($className);
  34         }
  35
  36         /**
  37          * Validates whether the state is 'connected' or throws an exception if
  38          * it is every other state.
  39          *
  40          * @return      void
  41          * @throws      UnexpectedStateException        If the state is not 'connected'
  42          */
  43         public function validatePeerStateConnected () {
  44                 // Just compare it...
  45                 if (!$this->isPeerStateConnected()) {
  46                         // Throw the exception
  47                         throw new UnexpectedStateException($this, self::EXCEPTION_INVALID_STATE);
  48                 } // END - if
  49         }
  50
  51         /**
  52          * Checks whether the peer's state is 'connected'
  53          *
  54          * @return      $isConnected    Whether the state is 'connected'
  55          */
  56         public function isPeerStateConnected () {
  57                 // Just compare it...
  58                 return ($this instanceof ConnectedPeerState);
  59         }
  60 }
  61
  62 // [EOF]
  63 ?>