/**
* A shipping company may be founded with this class
*
- * @author Roland Haeder <webmaster@ship-simu.org>
+ * @author Roland Haeder <webmaster@shipsimu.org>
* @version 0.0.0
- * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
+ * @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
+ * @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
protected function __construct () {
// Call parent constructor
parent::__construct(__CLASS__);
-
- // Set description
- $this->setObjectDescription("A shipping company class");
-
- // Generate unique ID number
- $this->generateUniqueId();
-
- // Clean up a little
- $this->removeSystemArray();
}
/**
*
* @param $userInstance A user class
* @return $companyInstance Prepared company instance
+ * @todo Add functionality if user participates in a company
*/
- public final static function createShippingCompany (ManageableAccount $userInstance) {
+ public static final function createShippingCompany (ManageableAccount $userInstance) {
// Get new instance
$companyInstance = new ShippingCompany();
// Does the given user owns a company?
if ($companyInstance->ifUserParticipatesInCompany($userInstance)) {
- // Then do some nastly caching here but don't throw an exception
+ // Then do some nasty caching here but don't throw an exception
// because then you will hurt our web helpers... :/
$companyInstance->partialStub("Don't throw exceptions here.");
} // END - if
$participates = false;
// Get a company database wrapper class
- $wrapperInstance = ObjectFactory::createObjectByConfiguredName('company_db_wrapper_class');
+ $wrapperInstance = ObjectFactory::createObjectByConfiguredName('company_db_wrapper_class', array($this));
// Ask the wrapper if this user participates
$participates = $wrapperInstance->ifUserParticipatesInCompany($userInstance);
* Checks wether the current user in registry is the company founder
*
* @return $isFounder Wether the current user is the company founder
+ * @todo Check if user is company founder
*/
public function ifUserIsFounder () {
// Default is not the founder
* Checks wether the current user in registry is the company owner
*
* @return $isOwner Wether the current user is the company owner
+ * @todo Check if user is company owner
*/
public function ifUserIsOwner () {
// Default is not the owner
return $isEmployee;
}
- //----------------------------------------------------------------------------
- // From here is very old code which needs to be translated and changed heavily
- //----------------------------------------------------------------------------
+ //------------------------------------------------------------------------------\
+ // Below here is very old code which needs to be translated and changed heavily |
+ //------------------------------------------------------------------------------/
/**
* Intialize all lists
$iterator->seek($pos);
// Is the current position valid?
- if (!$iterator->valid()) {
+ if ($iterator->valid() === false) {
// Should normally not happen... :(
throw new StructuresOutOfBoundsException($idx, self::EXCEPTION_INDEX_OUT_OF_BOUNDS);
} // END - if
// Make this person employed and give him some money to work
$employee->setEmployed(true);
- $employee->setObjectDescription($dummy->getObjectDescription());
$employee->setRealClass($dummy->__toString());
$employee->increaseSalary((mt_rand(7, 14) * 100)); // Are 700 to 1400 EUR for the begin okay?
// Iterate through all employees
for ($idx = $this->employeeList->getIterator(); $idx->valid(); $idx->next()) {
// Is the shipyard iterator still okay?
- if (!$shipyardIter->valid()) {
+ if ($shipyardIter->valid() === false) {
// Rewind to first position
$shipyardIter->seek(0);
- }
+ } // END - if
// Get Shipyard object
$shipyard = $shipyardIter->current();
throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
} elseif (!is_object($shipyard)) {
// Not an object! ;-(
- throw new NoObjectException($shipyard, self::EXCEPTION_IS_NO_OBJECT);
- } elseif (!$shipyard->isClass("Shipyard")) {
+ throw new InvalidObjectException($shipyard, self::EXCEPTION_IS_NO_OBJECT);
+ } elseif ($shipyard->isClass("Shipyard") === false) {
// Nope, so throw exception
throw new ClassMismatchException(array($shipyard->__toString(), "Shipyard"), self::EXCEPTION_CLASSES_NOT_MATCHING);
}
// Is the class there?
if (!class_exists($shipType)) {
// Throw exception
- throw new ClassNotFoundException($shipType, self::EXCEPTION_CLASS_NOT_FOUND);
+ throw new NoClassException($shipType, self::EXCEPTION_CLASS_NOT_FOUND);
}
// Create dummy ship
$shipType
));
- // Debug message
- if ((defined('DEBUG_COMPANY')) || (defined('DEBUG_ALL'))) $this->debugOutput(sprintf("[%s:%d] Die Reederei <strong>%s</strong> baut in allen Werften bald Schiffe vom Typ <strong>%s</strong>.",
- __CLASS__,
- __LINE__,
- $this->getCompanyName(),
- $shipInstance->getObjectDescription()
- ));
-
// Iterate shipyard list
for ($idx = $this->shipyardList->getIterator(); $idx->valid(); $idx->next()) {
// Get current element
throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
} elseif (!is_object($shipyard)) {
// Not an object! ;-(
- throw new NoObjectException($shipyard, self::EXCEPTION_IS_NO_OBJECT);
- } elseif (!$shipyard->isClass("Shipyard")) {
+ throw new InvalidObjectException($shipyard, self::EXCEPTION_IS_NO_OBJECT);
+ } elseif ($shipyard->isClass("Shipyard") === false) {
// Class is not a shipyard
throw new ClassMismatchException(array($shipyard->__toString(), "Shipyard"), self::EXCEPTION_CLASSES_NOT_MATCHING);
}
// Add the new ship type to the shipyard
$shipyard->addNewConstructableShipType($shipType);
- }
+ } // END - for
}
// Validate the requested ship type with the company if they can construct it
public function validateWorksContractShipType (SignableContract $contractInstance) {
- if ((defined('DEBUG_COMPANY')) || (defined('DEBUG_ALL'))) $this->debugOutput(sprintf("[%s:%d] Die Reederei <strong>%s</strong> prüft den Bauauftrag der <strong>%s</strong>.",
- __CLASS__,
- __LINE__,
- $this->getCompanyName(),
- $contractInstance->getShipName()
- ));
-
// First get the ship type
$shipInstance = $contractInstance->getShipInstance();
throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
} elseif (!is_object($shipInstance)) {
// Not an object! ;-(
- throw new NoObjectException($shipInstance, self::EXCEPTION_IS_NO_OBJECT);
+ throw new InvalidObjectException($shipInstance, self::EXCEPTION_IS_NO_OBJECT);
}
// Get it's real class name
$shipType = $shipInstance->__toString();
- // Debug message
- if ((defined('DEBUG_COMPANY')) || (defined('DEBUG_ALL'))) $this->debugOutput(sprintf("[%s:%d] Die Reederei <strong>%s</strong> prüft, ob die <strong>%s</strong> (Typ:<strong>%s</strong>) gebaut werden kann.",
- __CLASS__,
- __LINE__,
- $this->getCompanyName(),
- $contractInstance->getShipName(),
- $shipInstance->getObjectDescription()
- ));
-
- // Now check if the ship type is in any list and return the result
+ // Now check if ship type is in any list and return the result
return ($this->isShipTypeConstructable($shipType));
}
throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
} elseif (!is_object($shipyard)) {
// Not an object! ;-(
- throw new NoObjectException($shipyard, self::EXCEPTION_IS_NO_OBJECT);
- } elseif (!$shipyard->isClass("Shipyard")) {
+ throw new InvalidObjectException($shipyard, self::EXCEPTION_IS_NO_OBJECT);
+ } elseif ($shipyard->isClass("Shipyard") === false) {
// Class is not a shipyard
throw new ClassMismatchException(array($shipyard->__toString(), "Shipyard"), self::EXCEPTION_CLASSES_NOT_MATCHING);
}
- // Validate if the first found shipyard can construct the requested type
+ // Validate if first found shipyard can construct the requested type
$result = $shipyard->isShipTypeConstructable($shipType);
// Does this shipyard construct the requested ship type?
if ($result) break; // Then abort the search!
- }
+ } // END - for
// Debug message
if ((defined('DEBUG_COMPANY')) || (defined('DEBUG_ALL'))) $this->debugOutput(sprintf("[%s:%d] Die Reederei <strong>%s</strong> hat die Suche nach einer Werft beendet, die Schiffe vom Typ <strong>%s</strong> bauen kann.",
// As a customer the shipping company can add new contracts
public function addNewWorksContract (SignableContract $contractInstance) {
- if ((defined('DEBUG_COMPANY')) || (defined('DEBUG_ALL'))) $this->debugOutput(sprintf("[%s:%d] Die Reederei <strong>%s</strong> erstellt einen Bauauftrag für ein <strong>%s</strong> mit dem Namen <strong>%s</strong>.",
- __CLASS__,
- __LINE__,
- $this->getCompanyName(),
- $contractInstance->getShipInstance()->getObjectDescription(),
- $contractInstance->getShipInstance()->getShipName()
- ));
$this->contractList->append($contractInstance);
}
// Sign a contract with an other party which must also implement Customer
public function signContract (SignableContract $contractInstance, ContractPartner $partnerInstance) {
// Check wether the other party is our contract partner
- if (!$partnerInstance->isContractPartner($contractInstance)) {
+ if ($partnerInstance->isContractPartner($contractInstance) === false) {
// Invalid contract partner!
throw new InvalidContractPartnerException($partnerInstance, self::EXCEPTION_CONTRACT_PARTNER_INVALID);
- }
+ } // END - if
// Determine if company "signs" own contract (must be done) or with an other party
if ($this->equals($partnerInstance)) {
throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
} elseif (!is_object($contractInstance)) {
// Not an object! ;-(
- throw new NoObjectException($contractInstance, self::EXCEPTION_IS_NO_OBJECT);
- } elseif (!$contractInstance->isClass('WorksContract')) {
+ throw new InvalidObjectException($contractInstance, self::EXCEPTION_IS_NO_OBJECT);
+ } elseif ($contractInstance->isClass("WorksContract") === false) {
// Is not a merchant
throw new ClassMismatchException(array($contractInstance->__toString(), "WorksContract"), self::EXCEPTION_CLASSES_NOT_MATCHING);
}
projects / shipsimu.git / blobdiff