<?php
/**
 * An object factory for clients
 *
 * @author		Roland Haeder <webmaster@shipsimu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2013 Core 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 ClientFactory extends ObjectFactory {
	/**
	 * Protected constructor
	 *
	 * @return	void
	 */
	protected function __construct () {
		// Call parent constructor
		parent::__construct(__CLASS__);
	}

	/**
	 * Creates a client object for given protocol. This method uses the
	 * registry pattern to cache those instances.
	 *
	 * @param	$protocol			Protocol to create a client object for (e.g. 'http' for a HTTP/1.1 client)
	 * @param	$socketResource		A valid socket resource (optional)
	 * @return	$clientInstance		An instance of the requested client
	 * @throws	EmptyVariableException	If a variable is empty unexpectly
	 */
	public static final function createClientByProtokol ($protocol, $socketResource = FALSE) {
		// Is the class name valid and is the class there?
		if (empty($protocol)) {
			// Get an instance of this factory
			$factoryInstance = new ClientFactory();

			// Throw an exception here
			throw new EmptyVariableException(array($factoryInstance, 'protocol'), self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
		} // END - if

		// Default is NULL (to initialize variable)
		$clientInstance = NULL;

		// Generate registry key
		$registryKey = $protocol . '_client';

		// Is the key already in registry?
		if (Registry::getRegistry()->instanceExists($registryKey)) {
			// Then use that instance
			$clientInstance = Registry::getRegistry()->getInstance($registryKey);

			// Set socket resource
			$clientInstance->setSocketResource($socketResource);
		} else {
			// Generate object instance
			$clientInstance = self::createObjectByConfiguredName($registryKey, array($socketResource));

			// Set it in registry for later re-use
			Registry::getRegistry()->addInstance($registryKey, $clientInstance);
		}

		// Return the prepared instance
		return $clientInstance;
	}
}

// [EOF]
?>