<?php
/**
 * A database client for the User class
 *
 * @see			DatabaseFrontendInterface - An interface for database frontends (front-end to the application)
 * @author		Roland Haeder <webmaster@ship-simu.org>
 * @version		0.0.0
 * @copyright	Copyright(c) 2007, 2008 Roland Haeder, this is free software
 * @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 UserDatabaseWrapper extends BaseDatabaseWrapper {
	// Constants
	const EXCEPTION_CLIENT_USERNAME_NOT_FOUND = 0xe00;

	/**
	 * Protected constructor
	 *
	 * @return	void
	 */
	protected function __construct() {
		// Call parent constructor
		parent::__construct(__CLASS__);

		// Set part description
		$this->setObjectDescription("Database client for user objects");

		// Create unique ID number
		$this->createUniqueID();
	}

	/**
	 * Creates an instance of this database client by a provided user class
	 *
	 * @param	$userInstance		An instance of a user class
	 * @return	$clientInstance		An instance of the created client class
	 * @throws	WrapperUserNameNotFoundException		If the supplied username
	 *												does not exist
	 */
	public final static function createUserDatabaseWrapper (ManageableUser $userInstance) {
		// Get a new instance
		$clientInstance = new UserDatabaseWrapper();

		// Does the username exists?
		if (!$clientInstance->ifUserNameExists($userInstance->getUserName())) {
			// Throw an exception here
			throw new WrapperUserNameNotFoundException (array($clientInstance, $userInstance), self::EXCEPTION_CLIENT_USERNAME_NOT_FOUND);
		}

		// The user exists
		$clientInstance->partialStub("Add loading of full user details");

		// Return the instance
		return $clientInstance;
	}
}

// [EOF]
?>