Updated 'core'.

[hub.git] / application / hub / main / states / peer / class_BasePeerState.php

diff --git a/application/hub/main/states/peer/class_BasePeerState.php b/application/hub/main/states/peer/class_BasePeerState.php
index 1fc150a39278a93386e99e6c8a1c814f1711e9b8..cbbc183f2e0c193e72b6840eddc53718f3aa3e09 100644 (file)
--- a/application/hub/main/states/peer/class_BasePeerState.php
+++ b/application/hub/main/states/peer/class_BasePeerState.php
@@ -2,11 +2,11 @@
 /**
  * A general peer state class
  *
- * @author             Roland Haeder <webmaster@ship-simu.org>
+ * @author             Roland Haeder <webmaster@shipsimu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Hub Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub Developer Team
  * @license            GNU GPL 3.0 or any newer version
- * @link               http://www.ship-simu.org
+ * @link               http://www.shipsimu.org
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -32,6 +32,31 @@ class BasePeerState extends BaseState {
                // Call parent constructor
                parent::__construct($className);
        }
+
+       /**
+        * Validates whether the state is 'connected' or throws an exception if
+        * it is every other state.
+        *
+        * @return      void
+        * @throws      UnexpectedStateException        If the state is not 'connected'
+        */
+       public function validatePeerStateConnected () {
+               // Just compare it...
+               if (!$this->isPeerStateConnected()) {
+                       // Throw the exception
+                       throw new UnexpectedStateException($this, self::EXCEPTION_INVALID_STATE);
+               } // END - if
+       }
+
+       /**
+        * Checks whether the peer's state is 'connected'
+        *
+        * @return      $isConnected    Whether the state is 'connected'
+        */
+       public function isPeerStateConnected () {
+               // Just compare it...
+               return ($this instanceof ConnectedPeerState);
+       }
 }
 
 // [EOF]