application/hub/main/states/miner/init/class_MinerInitState.php

   1 <?php
   2 /**
   3  * A Init miner state class
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2011 - 2014 Miner 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 MinerInitState extends BaseMinerState implements Stateable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33
  34                 // Set state name
  35                 $this->setStateName('init');
  36         }
  37
  38         /**
  39          * Creates an instance of this class
  40          *
  41          * @param       $minerInstance  An instance of a MinerHelper class
  42          * @return      $stateInstance  An instance of a Stateable class
  43          */
  44         public final static function createMinerInitState (MinerHelper $minerInstance) {
  45                 // Get new instance
  46                 $stateInstance = new MinerInitState();
  47
  48                 // Set the miner instance
  49                 $stateInstance->setMinerInstance($minerInstance);
  50
  51                 // Return the prepared instance
  52                 return $stateInstance;
  53         }
  54
  55         /**
  56          * Executes the state with given Executor instance
  57          *
  58          * @param       $executorInstance       An instance of a Executor class
  59          * @return      void
  60          * @todo        0% done?
  61          */
  62         public function executeState (Executor $executorInstance) {
  63         }
  64
  65         /**
  66          * An encrypted message has been generated so we change the state to
  67          * 'virgin'.
  68          *
  69          * @return      void
  70          */
  71         public function encryptedMessageGenerated () {
  72                 // Change the state now to 'virgin'
  73                 MinerStateFactory::createMinerStateInstanceByName('virgin', $this->getMinerInstance());
  74         }
  75 }
  76
  77 // [EOF]
  78 ?>