application/hub/classes/states/crawler/init/class_CrawlerInitState.php

   1 <?php
   2 /**
   3  * A init crawler state class
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Hub 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 CrawlerInitState extends BaseCrawlerState implements Stateable {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructo
  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          * @return      $stateInstance  An instance of a Stateable class
  42          */
  43         public static final function createCrawlerInitState () {
  44                 // Get new instance
  45                 $stateInstance = new CrawlerInitState();
  46
  47                 // Return the prepared instance
  48                 return $stateInstance;
  49         }
  50
  51         /**
  52          * Executes the state with given Executor instance
  53          *
  54          * @param       $executorInstance       An instance of a Executor class
  55          * @return      void
  56          */
  57         public function executeState (Executor $executorInstance) {
  58                 // Initialize the executor (can be a Communicator instance)
  59                 $executorInstance->initExecutor($this);
  60         }
  61
  62         /**
  63          * State change if the communicator has fully initialized.
  64          *
  65          * @return      void
  66          * @todo        ~30% done
  67          */
  68         public function communicatorHasInitialized () {
  69                 // Please implement
  70                 $this->partialStub('Unfinished method.');
  71
  72                 // Change state to 'booting'
  73                 CrawlerStateFactory::createCrawlerStateInstanceByName('booting');
  74         }
  75 }
  76
  77 // [EOF]
  78 ?>