<?php
/**
 * A hub-miner class for the '???' mode
 *
 * @author		Roland Haeder <webmaster@ship-simu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2014 Miner Developer Team
 * @license		GNU GPL 3.0 or any newer version
 * @link		http://www.ship-simu.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 Hub???Miner extends BaseHubMiner implements MinerHelper, Registerable {
	/**
	 * Protected constructor
	 *
	 * @return	void
	 */
	protected function __construct () {
		// Call parent constructor
		parent::__construct(__CLASS__);

		// Set version number
		$this->setVersion('x.x');
	}

	/**
	 * Creates an instance of this hub-miner class
	 *
	 * @param	$requestInstance	An instance of a Requestable class
	 * @return	$minerInstance		An instance of this hub-miner class
	 */
	public final static function createHub???Miner (Requestable $requestInstance) {
		// Get a new instance
		$minerInstance = new Hub???Miner();

		// Set the request instance
		$minerInstance->setRequestInstance($requestInstance);

		// Return the instance
		return $minerInstance;
	}

	/**
	 * Method to "bootstrap" the miner. This step does also apply provided
	 * command-line arguments stored in the request instance. The regular miner
	 * should communicate with the bootstrap-miners at this point.
	 *
	 * @return	void
	 * @todo	Implement this method
	 */
	public function doBootstrapping () {
		// Call generic (parent) bootstrapping method first
		parent::doGenericBootstrapping();
		$this->partialStub('Please implement this method.');
	}

	/**
	 * Outputs the console teaser. This should only be executed on startup or
	 * full restarts. This method generates some space around the teaser.
	 *
	 * @return	void
	 */
	public function outputConsoleTeaser () {
		$this->partialStub('Please implement this method.');
	}

	/**
	 * Add some miner-specific filters
	 *
	 * @return	void
	 */
	public function addExtraHubFilters () {
		// Add some filters here
	}
}

// [EOF]
?>