application/hub/classes/factories/states/crawler/class_CrawlerStateFactory.php

   1 <?php
   2 /**
   3  * A factory class for crawler states
   4  *
   5  * @author              Roland Haeder <webmaster@shipsimu.org>
   6  * @version             0.0.0
   7  * @copyright   Copyright (c) 2014, 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 CrawlerStateFactory extends ObjectFactory {
  25         /**
  26          * Protected constructor
  27          *
  28          * @return      void
  29          */
  30         protected function __construct () {
  31                 // Call parent constructor
  32                 parent::__construct(__CLASS__);
  33         }
  34
  35         /**
  36          * Creates an instance of a configurable crawler state and sets it in the
  37          * given crawler instance.
  38          *
  39          * @param       $stateName                      Name of the state
  40          * @return      $stateInstance          A Stateable class instance
  41          */
  42         public static final function createCrawlerStateInstanceByName ($stateName) {
  43                 // Then construct the class' configuraton entry
  44                 $className = 'crawler_' . $stateName . '_state_class';
  45
  46                 // Get a class from that configuration entry
  47                 $stateInstance = self::createObjectByConfiguredName($className);
  48
  49                 // Get crawler instance
  50                 $crawlerInstance = Registry::getRegistry()->getInstance('crawler');
  51
  52                 // Debug message
  53                 self::createDebugInstance(__CLASS__)->debugOutput('CRAWLER-STATE-FACTORY[' . __METHOD__ . ':' . __LINE__ . ']: Crawler state has changed from ' . $crawlerInstance->getPrintableState() . ' to ' . $stateInstance->getStateName() . '.');
  54
  55                 // Once we have that state, set it in the crawler instance
  56                 $crawlerInstance->setStateInstance($stateInstance);
  57
  58                 // Update crawler data
  59                 $crawlerInstance->updateCrawlerData();
  60
  61                 // For any purposes, return the state instance
  62                 return $stateInstance;
  63         }
  64 }
  65
  66 // [EOF]
  67 ?>