application/hub/main/states/node/virgin/class_NodeVirginState.php

   1 <?php
   2 /**
   3  * A virgin node state class
   4  *
   5  * @author              Roland Haeder <webmaster@ship-simu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Hub Developer Team
   8  * @license             GNU GPL 3.0 or any newer version
   9  * @link                http://www.ship-simu.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 NodeVirginState extends BaseNodeState 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('virgin');
  36         }
  37
  38         /**
  39          * Creates an instance of this class
  40          *
  41          * @param       $nodeInstance   An instance of a NodeHelper class
  42          * @return      $stateInstance  An instance of a Stateable class
  43          */
  44         public static final function createNodeVirginState (NodeHelper $nodeInstance) {
  45                 // Get new instance
  46                 $stateInstance = new NodeVirginState();
  47
  48                 // Debug message
  49                 $stateInstance->debugOutput('NODE-STATE: Has changed from ' . $nodeInstance->getPrintableState() . ' to ' . $stateInstance->getStateName() . '.');
  50
  51                 // Set the node instance
  52                 $stateInstance->setNodeInstance($nodeInstance);
  53
  54                 // Return the prepared instance
  55                 return $stateInstance;
  56         }
  57
  58         /**
  59          * Change the state to 'active' when the hub has initialized all
  60          * listeners, tasks, queues, etc. An active hub does not imply that it
  61          * can be reached from outside so we have to deal with that state with
  62          * yet another state class.
  63          *
  64          * @return      void
  65          */
  66         public function nodeIsActivated () {
  67                 // Create the new state instance
  68                 StateFactory::createStateInstanceByName('active', $this->getNodeInstance());
  69         }
  70
  71 }
  72
  73 // [EOF]
  74 ?>