Added very basic classes and config entries (duplicated from cruncher sub-project...

[hub.git] / application / hub / main / states / miner / class_BaseMinerState.php

diff --git a/application/hub/main/states/miner/class_BaseMinerState.php b/application/hub/main/states/miner/class_BaseMinerState.php
new file mode 100644 (file)
index 0000000..e1a0ed3
--- /dev/null
+++ b/application/hub/main/states/miner/class_BaseMinerState.php
@@ -0,0 +1,63 @@
+<?php
+/**
+ * A general miner state class
+ *
+ * @author             Roland Haeder <webmaster@shipsimu.org>
+ * @version            0.0.0
+ * @copyright  Copyright (c) 2014 Miner Developer Team
+ * @license            GNU GPL 3.0 or any newer version
+ * @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
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+class BaseMinerState extends BaseState {
+       /**
+        * Protected constructor
+        *
+        * @param       $className      Name of the class
+        * @return      void
+        */
+       protected function __construct ($className) {
+               // Call parent constructor
+               parent::__construct($className);
+       }
+
+       /**
+        * Validates whether the state is 'active' or throws an exception if
+        * it is every other state.
+        *
+        * @return      void
+        * @throws      InvalidStateException   If the state is not 'active'
+        */
+       public function validateMinerStateIsActive () {
+               // Just compare it...
+               if (!$this instanceof MinerActiveState) {
+                       // Throw the exception
+                       throw new InvalidStateException($this, self::EXCEPTION_INVALID_STATE);
+               } // END - if
+       }
+
+       /**
+        * Checks if this state is 'virgin'
+        *
+        * @return      $isVirgin       Whether this state is 'virgin'
+        */
+       public function isMinerStateVirgin () {
+               // Just compare it...
+               return ($this instanceof MinerVirginState);
+       }
+}
+
+// [EOF]
+?>