<?php
/**
 * A wrapper for database access to shipping company data
 *
 * @author		Roland Haeder <webmaster@ship-simu.org>
 * @version		0.0.0
 * @copyright	Copyright (c) 2007, 2008 Roland Haeder, 2009 Ship-Simu 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 CompanyDatabaseWrapper extends BaseDatabaseWrapper {
	/**
	 * Company instance
	 */
	private $companyInstance = null;

	// Constants for database tables
	const DB_TABLE_COMPANY_DATA = "company";
	const DB_TABLE_COMPANY_USER = "company_user";

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

	/**
	 * Creates an instance of this wrapper class
	 *
	 * @param	$companyInstance	An instance of a generic company class or null if no specific
	 * @return	$wrapperInstance	An instance of this wrapper class
	 * @todo	Find an interface which is suitable for all companies
	 */
	public final static function createCompanyDatabaseWrapper (ShippingCompany $companyInstance = null) {
		// Create a new instance
		$wrapperInstance = new CompanyDatabaseWrapper();

		// Set (primary!) table name
		$wrapperInstance->setTableName(self::DB_TABLE_COMPANY_DATA);

		// Set the company instance if not null
		if (!is_null($companyInstance)) {
			$wrapperInstance->setCompanyInstance($companyInstance);
		} // END - if

		// Return the instance
		return $wrapperInstance;
	}

	/**
	 * Checks wether the given user participates in a company
	 *
	 * @param	$userInstance	An instance of a user class
	 * @return	$participates	Wether the user participates at lease in one company
	 */
	public function ifUserParticipatesInCompany (ManageableAccount $userInstance)  {
		// By default no user owns any company... ;)
		$participates = false;

		// Get a search criteria class
		$criteriaInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');

		// Add the user primary key as a search criteria
		$criteriaInstance->addCriteria("participant_id", $userInstance->getPrimaryKey());
		$criteriaInstance->setLimit(1);

		// Set company->user table
		$this->setTableName(self::DB_TABLE_COMPANY_USER);

		// Get the result back
		$resultInstance = $this->doSelectByCriteria($criteriaInstance);

		// Is there a result?
		if ($resultInstance->next()) {
			// Then cache it
			$this->setResultInstance($resultInstance);

			// Entry found for further analysis/processing
			$participates = true;
		} // END - if

		// Return the result
		return $participates;
	}

	/**
	 * Setter for company instance
	 *
	 * @param	$companyInstance	An instance of a generic company
	 * @return	void
	 * @todo	Find an interface suitable for all types of companies
	 */
	protected final function setCompanyInstance (ShippingCompany $companyInstance) {
		$this->companyInstance = $companyInstance;
	}

	/**
	 * Getter for company instance
	 *
	 * @return	$companyInstance	An instance of a generic company
	 * @todo	Find an interface suitable for all types of companies
	 */
	public final function getCompanyInstance () {
		return $this->companyInstance;
	}
}

// [EOF]
?>