Typos fixed and special command resolver are now possible

[shipsimu.git] / application / ship-simu / main / companies / class_ShippingCompany.php

diff --git a/application/ship-simu/main/companies/class_ShippingCompany.php b/application/ship-simu/main/companies/class_ShippingCompany.php
index 7a00527ffa33504c8600a871aca9d3e59df05ea1..24603fd86b1309381305e1b132eb44c6c1f5e6b2 100644 (file)
--- a/application/ship-simu/main/companies/class_ShippingCompany.php
+++ b/application/ship-simu/main/companies/class_ShippingCompany.php
@@ -81,6 +81,7 @@ class ShippingCompany extends BaseSimulator implements Customer, ContractPartner
         *
         * @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) {
                // Get new instance
@@ -133,6 +134,7 @@ class ShippingCompany extends BaseSimulator implements Customer, ContractPartner
         * 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
@@ -155,6 +157,7 @@ class ShippingCompany extends BaseSimulator implements Customer, ContractPartner
         * 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
@@ -322,7 +325,7 @@ class ShippingCompany extends BaseSimulator implements Customer, ContractPartner
                                $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
@@ -386,10 +389,10 @@ class ShippingCompany extends BaseSimulator implements Customer, ContractPartner
                // 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();
@@ -401,7 +404,7 @@ class ShippingCompany extends BaseSimulator implements Customer, ContractPartner
                        } elseif (!is_object($shipyard)) {
                                // Not an object! ;-(
                                throw new NoObjectException($shipyard, self::EXCEPTION_IS_NO_OBJECT);
-                       } elseif (!$shipyard->isClass("Shipyard")) {
+                       } elseif ($shipyard->isClass("Shipyard") === false) {
                                // Nope, so throw exception
                                throw new ClassMismatchException(array($shipyard->__toString(), "Shipyard"), self::EXCEPTION_CLASSES_NOT_MATCHING);
                        }
@@ -489,14 +492,14 @@ class ShippingCompany extends BaseSimulator implements Customer, ContractPartner
                        } elseif (!is_object($shipyard)) {
                                // Not an object! ;-(
                                throw new NoObjectException($shipyard, self::EXCEPTION_IS_NO_OBJECT);
-                       } elseif (!$shipyard->isClass("Shipyard")) {
+                       } 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
@@ -516,7 +519,7 @@ class ShippingCompany extends BaseSimulator implements Customer, ContractPartner
                // Get it's real class name
                $shipType = $shipInstance->__toString();
 
-               // 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));
        }
 
@@ -548,17 +551,17 @@ class ShippingCompany extends BaseSimulator implements Customer, ContractPartner
                        } elseif (!is_object($shipyard)) {
                                // Not an object! ;-(
                                throw new NoObjectException($shipyard, self::EXCEPTION_IS_NO_OBJECT);
-                       } elseif (!$shipyard->isClass("Shipyard")) {
+                       } 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.",
@@ -597,10 +600,10 @@ class ShippingCompany extends BaseSimulator implements Customer, ContractPartner
        // 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)) {
@@ -649,7 +652,7 @@ class ShippingCompany extends BaseSimulator implements Customer, ContractPartner
                } elseif (!is_object($contractInstance)) {
                        // Not an object! ;-(
                        throw new NoObjectException($contractInstance, self::EXCEPTION_IS_NO_OBJECT);
-               } elseif (!$contractInstance->isClass('WorksContract')) {
+               } elseif ($contractInstance->isClass("WorksContract") === false) {
                        // Is not a merchant
                        throw new ClassMismatchException(array($contractInstance->__toString(), "WorksContract"), self::EXCEPTION_CLASSES_NOT_MATCHING);
                }