<?php
/**
 * A general NodeCrawler class
 *
 * @author		Roland Haeder <webmaster@shipsimu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2014 Crawler Developer Team
 * @license		GNU GPL 3.0 or any newer version
 * @link		http://www.shipsimu.org
 *
 * This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 */
class BaseNodeCrawler extends BaseHubSystem {
	/**
	 * Whether this Crawler is active
	 */
	private $isActive = FALSE;

	/**
	 * Protected constructor
	 *
	 * @param	$className	Name of the class
	 * @return	void
	 */
	protected function __construct ($className) {
		// Call parent constructor
		parent::__construct($className);

		// Set this crawler instance in registry
		Registry::getRegistry()->addInstance('crawler', $this);

		// Init state which sets the state to 'init'
		$this->initState();
	}

	/**
	 * Initializes the node's state which sets it to 'init'
	 *
	 * @return	void
	 */
	private function initState() {
		// Get the state factory and create the initial state.
		CrawlerStateFactory::createCrawlerStateInstanceByName('init');
	}

	/**
	 * Initializes this crawler instance
	 *
	 * @param	$stateInstance	An instance of a Stateable class
	 * @return	void
	 * @todo	0% done
	 */
	public function initCrawler (Stateable $stateInstance) {
		// Please implement
		$this->partialStub('Unfinished method.');
	}

	/**
	 * Enables/disables the crawler (just sets a flag)
	 *
	 * @param	$version	Version number of this crawler
	 * @return	void
	 */
	public final function enableIsActive ($isActive = TRUE) {
		$this->isActive = (bool) $isActive;
	}

	/**
	 * Determines whether the crawler is active
	 *
	 * @return	$isActive	Whether the crawler is active
	 */
	public final function isActive () {
		return $this->isActive;
	}
}

// [EOF]
?>