3 * A general NodeCrawler class
5 * @author Roland Haeder <webmaster@shipsimu.org>
7 * @copyright Copyright (c) 2014 Crawler Developer Team
8 * @license GNU GPL 3.0 or any newer version
9 * @link http://www.shipsimu.org
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.
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.
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/>.
24 class BaseNodeCrawler extends BaseHubSystem {
26 * Whether this Crawler is active
28 private $isActive = FALSE;
31 * Protected constructor
33 * @param $className Name of the class
36 protected function __construct ($className) {
37 // Call parent constructor
38 parent::__construct($className);
40 // Init state which sets the state to 'init'
45 * Initializes the node's state which sets it to 'init'
49 private function initState() {
50 // Get the state factory and create the initial state.
51 CrawlerStateFactory::createCrawlerStateInstanceByName('init', $this);
55 * Initializes this crawler instance
57 * @param $stateInstance An instance of a Stateable class
61 public function initCrawler (Stateable $stateInstance) {
63 $this->partialStub('Unfinished method.');
67 * Enables/disables the crawler (just sets a flag)
69 * @param $version Version number of this crawler
72 public final function enableIsActive ($isActive = TRUE) {
73 $this->isActive = (bool) $isActive;
77 * Determines whether the crawler is active
79 * @return $isActive Whether the crawler is active
81 public final function isActive () {
82 return $this->isActive;