<?php
/**
 * A hub-node class for the 'List' mode
 *
 * @author		Roland Haeder <webmaster@ship-simu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 Hub 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 HubListNode extends BaseHubNode implements NodeHelper, Registerable {
	/**
	 * Protected constructor
	 *
	 * @return	void
	 */
	protected function __construct () {
		// Call parent constructor
		parent::__construct(__CLASS__);
	}

	/**
	 * Creates an instance of this hub-node class
	 *
	 * @param	$requestInstance	An instance of a Requestable class
	 * @return	$nodeInstance		An instance of this hub-node class
	 */
	public final static function createHubListNode (Requestable $requestInstance) {
		// Get a new instance
		$nodeInstance = new HubListNode();

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

		// Return the instance
		return $nodeInstance;
	}

	/**
	 * Method to "bootstrap" the node. This step does also apply provided
	 * command-line arguments stored in the request instance. The regular node
	 * should communicate with the bootstrap-nodes at this point.
	 *
	 * @return	void
	 * @todo	Implement more bootstrap steps
	 */
	public function doBootstrapping () {
		// Do more here
		$this->partialStub('Do something before hub descriptor is published.');

		// Publish the descriptor of this hub, this will "announce" us to upper hubs
		$this->publishHubDescriptor();

		// Do more here
		$this->partialStub('Do something after hub descriptor is published.');
	}

	/**
	 * Initializes hub-specific queues
	 *
	 * @return	void
	 * @todo	Unfinished method
	 */
	public function initQueues () {
		// Call generic queues every hub may have, like the core queue
		parent::initGenericQueues();
		$this->partialStub('Please add some more hub-specific queues.');
	}

	/**
	 * Adds some node-specific filters to the filter chains
	 *
	 * @param	$requestInstance	A Requestable class
	 * @param	$responseInstance	A Responseable class
	 * @return	void
	 * @todo	0%
	 */
	public function addExtraFilters (Requestable $requestInstance, Responseable $responseInstance) {
		$this->partialStub('Please implement this method.');
	}
}

//
?>