<?php
/**
 * A ??? discovery class.
 *
 * @author		Roland Haeder <webmaster@ship-simu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core 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 ???Discovery extends BaseDiscovery implements Discoverable {
	/**
	 * Protected constructor
	 *
	 * @return	void
	 */
	protected function __construct () {
		// Call parent constructor
		parent::__construct(__CLASS__);
	}

	/**
	 * Create an instance of this class
	 *
	 * @return	$discoveryInstance	An instance of this discovery class
	 */
	public final static function create???Discovery () {
		// Get an instance of this class
		$discoveryInstance = new ???Discovery();

		// Return the prepared instance
		return $discoveryInstance;
	}

	/**
	 * Discovers the request
	 *
	 * @param	$requestInstance	An instance of a Requestable class
	 * @return	void
	 * @todo	0% done
	 */
	public function discover (Requestable $requestInstance) {
		$this->partialStub("Please implement this method.");
	}

	/**
	 * Adds the database result in a human-readable format to the helper class
	 *
	 * @param	$helperInstance		An instance of a helper class
	 * @return	void
	 * @todo	0% done
	 */
	public function addResultsToHelper (HelpableTemplate $helperInstance) {
		$this->partialStub("Please implement this method.");
	}
}

// [EOF]
?>