application/hub/main/states/node/announced/class_NodeAnnouncedState.php

   1 <?php
   2 /**
   3  * A Announced 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 - 2012 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 NodeAnnouncedState 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('announced');
  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 createNodeAnnouncedState (NodeHelper $nodeInstance) {
  45                 // Get new instance
  46                 $stateInstance = new NodeAnnouncedState();
  47
  48                 // Set the node instance
  49                 $stateInstance->setNodeInstance($nodeInstance);
  50
  51                 // Return the prepared instance
  52                 return $stateInstance;
  53         }
  54
  55         /**
  56          * Changes the state if the announcement (to bootstrap node) was
  57          * successful.
  58          *
  59          * @return      void
  60          */
  61         public function nodeAnnouncementSuccessful () {
  62                 // The node's announcement was successful
  63                 NodeStateFactory::createNodeStateInstanceByName('announcement_completed', $this->getNodeInstance());
  64         }
  65 }
  66
  67 // [EOF]
  68 ?>