code comments including license information added, type hints added, minor rewrites...
authorRoland Häder <roland@mxchange.org>
Sat, 8 Mar 2008 14:26:58 +0000 (14:26 +0000)
committerRoland Häder <roland@mxchange.org>
Sat, 8 Mar 2008 14:26:58 +0000 (14:26 +0000)
120 files changed:
application/selector/class_ApplicationHelper.php
application/selector/class_ApplicationSelector.php
application/selector/debug.php
application/selector/exceptions.php
application/selector/init.php
application/selector/loader.php
application/selector/starter.php
application/ship-simu/class_ApplicationHelper.php
application/ship-simu/debug.php
application/ship-simu/exceptions.php
application/ship-simu/exceptions/class_BirthdayInvalidException.php
application/ship-simu/exceptions/class_CabinShipMismatchException.php
application/ship-simu/exceptions/class_ContractAllreadySignedException.php
application/ship-simu/exceptions/class_ContractPartnerMismatchException.php
application/ship-simu/exceptions/class_DeckShipMismatchException.php
application/ship-simu/exceptions/class_EmptyStructuresListException.php
application/ship-simu/exceptions/class_InvalidContractPartnerException.php
application/ship-simu/exceptions/class_InvalidIDFormatException.php
application/ship-simu/exceptions/class_ItemNotInPriceListException.php
application/ship-simu/exceptions/class_ItemNotTradeableException.php
application/ship-simu/exceptions/class_MissingSimulatorIDException.php
application/ship-simu/exceptions/class_MotorShipMismatchException.php
application/ship-simu/exceptions/class_NoShipyardsConstructedException.php
application/ship-simu/exceptions/class_PersonellListAlreadyCreatedException.php
application/ship-simu/exceptions/class_RoomShipMismatchException.php
application/ship-simu/exceptions/class_ShipNotConstructedException.php
application/ship-simu/exceptions/class_ShipPartNotConstructableException.php
application/ship-simu/exceptions/class_StructureShipMismatchException.php
application/ship-simu/exceptions/class_StructuresOutOfBoundsException.php
application/ship-simu/exceptions/class_ToMuchEmployeesException.php
application/ship-simu/exceptions/class_TotalPriceNotCalculatedException.php
application/ship-simu/exceptions/class_UnsupportedLimitationPartException.php
application/ship-simu/exceptions/class_WrongGenderSpecifiedException.php
application/ship-simu/init.php
application/ship-simu/interfaces/class_ConstructableShip.php
application/ship-simu/interfaces/class_ConstructableShipPart.php
application/ship-simu/interfaces/class_ContractPartner.php
application/ship-simu/interfaces/class_Customer.php
application/ship-simu/interfaces/class_ItemIsTradeable.php
application/ship-simu/interfaces/class_Personellizer.php
application/ship-simu/interfaces/class_SignableContract.php
application/ship-simu/loader.php
application/ship-simu/main/class_BasePersonell.php
application/ship-simu/main/class_BaseSimulator.php
application/ship-simu/main/class_Merchant.php
application/ship-simu/main/class_WorksContract.php
application/ship-simu/main/companies/class_ShippingCompany.php
application/ship-simu/main/constructions/berths/class_Berth.php
application/ship-simu/main/constructions/class_BaseConstruction.php
application/ship-simu/main/constructions/docks/class_DryDock.php
application/ship-simu/main/constructions/harbors/class_Harbor.php
application/ship-simu/main/constructions/terminals/class_Terminal.php
application/ship-simu/main/constructions/yards/class_Shipyard.php
application/ship-simu/main/drives/class_BaseDrive.php
application/ship-simu/main/drives/motor/class_Motor.php
application/ship-simu/main/parts/class_BaseShipPart.php
application/ship-simu/main/parts/maschineroom/class_MaschineRoom.php
application/ship-simu/main/personell/class_SimulatorPersonell.php
application/ship-simu/main/personell/company/class_CompanyEmployee.php
application/ship-simu/main/ships/class_BaseShip.php
application/ship-simu/main/ships/passenger/class_PassengerShip.php
application/ship-simu/main/structures/class_BaseStructure.php
application/ship-simu/main/structures/extended/cabines/class_BaseCabin.php
application/ship-simu/main/structures/extended/cabines/ship/class_EconomyCabin.php
application/ship-simu/main/structures/extended/cabines/ship/class_LowCabin.php
application/ship-simu/main/structures/extended/cabines/ship/class_LuxuryCabin.php
application/ship-simu/main/structures/extended/cabines/ship/class_PremierCabin.php
application/ship-simu/main/structures/extended/class_BaseCabinStructure.php
application/ship-simu/main/structures/extended/class_BaseDeckStructure.php
application/ship-simu/main/structures/extended/class_BaseUpperStructure.php
application/ship-simu/main/structures/extended/decks/cargo/class_CarDeck.php
application/ship-simu/main/structures/extended/decks/cargo/class_TrainDeck.php
application/ship-simu/main/structures/extended/decks/cargo/class_TruckDeck.php
application/ship-simu/main/structures/extended/decks/class_BaseDeck.php
application/ship-simu/main/structures/extended/upper/class_Bridge.php
application/ship-simu/starter.php
inc/classes/exceptions/compressor/class_MismatchingCompressorsException.php
inc/classes/exceptions/container/class_ContainerItemIsNoArrayException.php
inc/classes/exceptions/container/class_ContainerItemIsNullException.php
inc/classes/exceptions/container/class_ContainerMaybeDamagedException.php
inc/classes/exceptions/database/local_file/class_SavePathIsEmptyException.php
inc/classes/exceptions/database/local_file/class_SavePathIsNoDirectoryException.php
inc/classes/exceptions/database/local_file/class_SavePathReadProtectedException.php
inc/classes/exceptions/database/local_file/class_SavePathWriteProtectedException.php
inc/classes/exceptions/io/class_DirPointerNotOpenedException.php
inc/classes/exceptions/io/class_FilePointerNotOpenedException.php
inc/classes/exceptions/io/class_InvalidDataLengthException.php
inc/classes/exceptions/io/class_InvalidDirectoryResourceException.php
inc/classes/exceptions/io/class_InvalidMD5ChecksumException.php
inc/classes/exceptions/io/class_PathIsEmptyException.php
inc/classes/exceptions/io/class_PathIsNoDirectoryException.php
inc/classes/exceptions/io/class_PathReadProtectedException.php
inc/classes/exceptions/language/class_InvalidLanguagePathStringException.php
inc/classes/exceptions/language/class_LanguagePathIsEmptyException.php
inc/classes/exceptions/language/class_LanguagePathIsNoDirectoryException.php
inc/classes/exceptions/language/class_LanguagePathReadProtectedException.php
inc/classes/exceptions/main/class_ClassMismatchException.php
inc/classes/exceptions/main/class_ClassNotFoundException.php
inc/classes/exceptions/main/class_ConfigEntryIsEmptyException.php
inc/classes/exceptions/main/class_ConfigEntryNotFoundException.php
inc/classes/exceptions/main/class_DimNotFoundInArrayException.php
inc/classes/exceptions/main/class_ExceptionNotChangedException.php
inc/classes/exceptions/main/class_ExceptionNotFoundException.php
inc/classes/exceptions/main/class_GetterNotFoundException.php
inc/classes/exceptions/main/class_InvalidArrayCountException.php
inc/classes/exceptions/main/class_InvalidObjectException.php
inc/classes/exceptions/main/class_MissingArrayElementsException.php
inc/classes/exceptions/main/class_MissingDecimalsThousandsSeperatorException.php
inc/classes/exceptions/main/class_MissingMethodException.php
inc/classes/exceptions/main/class_NoArrayCreatedException.php
inc/classes/exceptions/main/class_NoArrayException.php
inc/classes/exceptions/main/class_NoObjectException.php
inc/classes/exceptions/main/class_NullPointerException.php
inc/classes/exceptions/main/class_VariableIsNotSetException.php
inc/classes/exceptions/template/class_BasePathIsEmptyException.php
inc/classes/exceptions/template/class_BasePathIsNoDirectoryException.php
inc/classes/exceptions/template/class_BasePathReadProtectedException.php
inc/classes/exceptions/template/class_InvalidBasePathStringException.php
inc/classes/exceptions/template/class_InvalidTemplateVariableNameException.php
inc/classes/exceptions/template/class_UnexpectedTemplateTypeException.php

index 19b45b7..7655415 100644 (file)
  * Please remember that this include file is being loaded *before* the class
  * loader is loading classes from "exceptions", "interfaces" and "main"!
  *
- * @author     Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
- * @version    0.1
+ * @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 ApplicationHelper extends BaseFrameworkSystem implements ManageableApplication {
        /**
index cbfc91d..d95af7f 100644 (file)
@@ -5,10 +5,25 @@
  * Please remember that this include file is being loaded *before* the class
  * loader is loading classes from "exceptions", "interfaces" and "main"!
  *
- * @todo       Extend a later BaseFrameworkApplication class
+ * @todo               Extend a later BaseFrameworkApplication class
+ * @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
  *
- * @author     Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
- * @version    0.1
+ * 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 ApplicationSelector extends BaseFrameworkSystem {
        /**
index 2322bb5..8046ad4 100644 (file)
@@ -1,5 +1,26 @@
 <?php
-// Initialize some debug constants here
+/**
+ * Initialize some debug constants here
+ *
+ * @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/>.
+ */
 
 // [EOF]
 ?>
index c0d5422..ac62fc1 100644 (file)
@@ -1,4 +1,26 @@
 <?php
+/**
+ * The exception handle shall be implemented here
+ *
+ * @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/>.
+ */
 
 // Set the new handler
 //set_exception_handler('selector_exception_handler');
index a1255a9..9810579 100644 (file)
@@ -1,8 +1,30 @@
 <?php
-// Application initializer
+/**
+ * Application initializer
+ *
+ * Please remember that this include file is being loaded *before* the class
+ * loader is loading classes from "exceptions", "interfaces" and "main"!
+ *
+ * @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/>.
+ */
 //
-// Please remember that this include file is being loaded *before* the class
-// loader is loading classes from "exceptions", "interfaces" and "main"!
 //
 // Get an instance of the initializer
 $eval = sprintf("\$app = %s::getInstance();",
index 46f5bf8..44dbb5c 100644 (file)
@@ -1,5 +1,27 @@
 <?php
-// The application's class loader
+/**
+ * The application's class loader
+ * @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/>.
+ */
+
+// Is the application instance set?
 if (!isset($application)) {
        // We need this!
        ApplicationEntryPoint::app_die("[Main:] Interne Variable <strong>application</strong> nicht gefunden!");
index 1e6e523..0833cec 100644 (file)
@@ -1,6 +1,28 @@
 <?php
-// Is there an application helper instance? We need the method main() for
-// maining the application
+/**
+ * Starter of 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/>.
+ */
+
+// Get the application helper instance
 $app = ApplicationHelper::getInstance();
 
 // Some sanity checks
index a177d34..e3209ef 100644 (file)
  * Please remember that this include file is being loaded *before* the class
  * loader is loading classes from "exceptions", "interfaces" and "main"!
  *
- * @author     Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
- * @version    0.1
+ * @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 ApplicationHelper extends BaseFrameworkSystem implements ManageableApplication {
        /**
index 5c6e9c8..d9fff10 100644 (file)
@@ -1,5 +1,26 @@
 <?php
-// Initialize some debug constants here
+/**
+ * Some debugging stuff for this 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/>.
+ */
 
 // Reederei-Objekt debuggen
 //define('DEBUG_COMPANY_OBJ', true);
index df23634..53e4b95 100644 (file)
@@ -1,4 +1,26 @@
 <?php
+/**
+ * The exception handler for this 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/>.
+ */
 
 // Set the new handler
 //set_exception_handler('shipsimu_exception_handler');
index 032d5e4..913a429 100644 (file)
@@ -1,11 +1,28 @@
 <?php
-
-// An exception class for lost classes... ;-)
+/**
+ * An exception for invalid birthdays (like 13-01-2008)
+ *
+ * @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 BirthdayInvalidException extends FrameworkException {
-       public function __construct ($birthArray, $code) {
-               // Cast the array
-               $birthArray = (array) $birthArray;
-
+       public function __construct (array $birthArray, $code) {
                // Add a message around the missing class
                $message = sprintf("Das Geburtsdatum <u>%s</u> ist leider falsch.",
                        date("d.m.Y", mktime(
index 25890a9..735257f 100644 (file)
@@ -1,6 +1,26 @@
 <?php
-
-// Unsere eigene Exception!
+/**
+ * An exception for cabins which doesn't match the ship (why?)
+ *
+ * @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 CabinShipMismatchException extends FrameworkException {
 }
 
index 03b4f6e..b3f0e5e 100644 (file)
@@ -1,8 +1,28 @@
 <?php
-
-// An exception class for lost classes... ;-)
+/**
+ * An exception thrown when the contract we want to sign is already signed
+ *
+ * @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 ContractAllreadySignedException extends FrameworkException {
-       public function __construct ($classArray, $code) {
+       public function __construct (array $classArray, $code) {
                // Cast the array
                $classArray = (array) $classArray;
 
index 2195fbb..fce9e7a 100644 (file)
@@ -1,11 +1,28 @@
 <?php
-
-// An exception class for lost classes... ;-)
+/**
+ * An exception thrown when the contract partner did not match the excepted one
+ *
+ * @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 ContractPartnerMismatchException extends FrameworkException {
-       public function __construct ($classArray, $code) {
-               // Cast the array
-               $classArray = (array) $classArray;
-
+       public function __construct (array $classArray, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:] Der Vertragspartner von <u>%s</u> ist ung&uuml;tig (<u>%s</u>) und darf diesen Vertrag nicht unterzeichnen!",
                        $classArray[0]->__toString(),
index f4967aa..03e3c67 100644 (file)
@@ -1,6 +1,26 @@
 <?php
-
-// Unsere eigene Exception!
+/**
+ * An exception thrown when the deck mismatches the ship (why?)
+ *
+ * @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 DeckShipMismatchException extends FrameworkException {
 }
 
index d84efb7..cd01a1e 100644 (file)
@@ -1,8 +1,28 @@
 <?php
-
-// An exception class for lost classes... ;-)
+/**
+ * An exception thrown when the structure list is empty
+ *
+ * @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 EmptyStructuresListException extends FrameworkException {
-       public function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:] Die Strukturen-Liste ist leer.",
                        $class->__toString()
index 0b1c304..c0d0eb8 100644 (file)
@@ -1,8 +1,28 @@
 <?php
-
-// An exception class for lost classes... ;-)
+/**
+ * An exception thrown when the contract partner is invalid
+ *
+ * @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 InvalidContractPartnerException extends FrameworkException {
-       public function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:] <u>%s</u> ist kein g&uuml;tiger Vertragspartner.",
                        $class->__toString(),
index 3ce2e0d..295096a 100644 (file)
@@ -1,8 +1,28 @@
 <?php
-
-// An exception class for lost classes... ;-)
+/**
+ * An exception thrown when the format of the id number is invalid
+ *
+ * @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 InvalidIDFormatException extends FrameworkException {
-       public function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:] Ung&uuml;ltige ID-Nummer &uuml;bergeben.",
                        $class->__toString()
index 500ba92..8c12595 100644 (file)
@@ -1,8 +1,28 @@
 <?php
-
-// An exception class for lost classes... ;-)
+/**
+ * An exception thrown when the requested item is not in the pricing list
+ *
+ * @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 ItemNotInPriceListException extends FrameworkException {
-       public function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                $message = sprintf("[Merchant:] Preis f&uuml;r den Artikel <u>%s</u> <em><u>%s</u></em> nicht gefunden.",
                        $class->__toString(),
index a83485f..496e4b0 100644 (file)
@@ -1,8 +1,28 @@
 <?php
-
-// An exception class for lost classes... ;-)
+/**
+ * An exception thrown when an item is not tradeable (maybe unneccessary)
+ *
+ * @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 ItemNotTradeableException extends FrameworkException {
-       public function __construct ($classArray, $code) {
+       public function __construct (array $classArray, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:] <u>%s</u> ist nicht handelbar!",
                        $classArray[0]->__toString(),
index d656dde..d66b6e5 100644 (file)
@@ -1,8 +1,28 @@
 <?php
-
-// An exception class for lost classes... ;-)
+/**
+ * An exception thrown when the provided simulator id is invalid
+ *
+ * @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 MissingSimulatorIDException extends FrameworkException {
-       public function __construct ($classArray, $code) {
+       public function __construct (array $classArray, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:] Die Simulator-ID <u>%s</u> scheint ung&uuml;ltig zu sein.",
                        $classArray[0]->__toString(),
index ce48791..a86b6cb 100644 (file)
@@ -1,6 +1,26 @@
 <?php
-
-// Unsere eigene Exception!
+/**
+ * An exception thrown when the motor does not match the ship (why?)
+ *
+ * @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 MotorShipMismatchException extends FrameworkException {
 }
 
index 32e1339..ff01762 100644 (file)
@@ -1,8 +1,28 @@
 <?php
-
-// Unsere eigene Exception!
+/**
+ * An exception thrown when there are no shipyards constructed yet.
+ *
+ * @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 NoShipyardsConstructedException extends FrameworkException {
-       public function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                if (is_object($class)) {
                        // Add a message around the missing class
                        $message = sprintf("[%s:] Keine Werften gefunden!",
index 3ac9078..eeee651 100644 (file)
@@ -1,8 +1,28 @@
 <?php
-
-// A crew list has already been initialized
+/**
+ * An exception thrown when a crew list has already been initialized
+ *
+ * @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 PersonellListAlreadyCreatedException extends FrameworkException {
-       public function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:] Die interne Crew-Liste wurde bereits initialisiert.",
                        $class->__toString()
index 19d5eed..8555420 100644 (file)
@@ -1,6 +1,26 @@
 <?php
-
-// Unsere eigene Exception!
+/**
+ * An exception thrown when a room mismatches the ship (why?)
+ *
+ * @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 RoomShipMismatchException extends FrameworkException {
 }
 
index 07b9bb9..576629f 100644 (file)
@@ -1,6 +1,26 @@
 <?php
-
-// Unsere eigene Exception!
+/**
+ * An exception thrown when a ship is not constructed (yet)
+ *
+ * @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 ShipNotConstructedException extends FrameworkException {
 }
 
index 338386e..7202e97 100644 (file)
@@ -1,6 +1,26 @@
 <?php
-
-// An exception class for lost classes... ;-)
+/**
+ * An exception thrown when the ship part is not constructed yet.
+ *
+ * @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 ShipPartNotConstructableException extends FrameworkException {
        public function __construct (array $partArray, $code) {
                // Add a message around the missing class
index 273c405..73ef0c4 100644 (file)
@@ -1,6 +1,26 @@
 <?php
-
-// Unsere eigene Exception!
+/**
+ * An exception thrown when a structure does not match the ship (why?)
+ *
+ * @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 StructureShipMismatchException extends FrameworkException {
 }
 
index 8b5d4cd..bd10fbc 100644 (file)
@@ -1,6 +1,26 @@
 <?php
-
-// An exception class for lost classes... ;-)
+/**
+ * An exception thrown when the ship part index is out of bounds
+ *
+ * @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 StructuresOutOfBoundsException extends FrameworkException {
        public function __construct ($idx, $code) {
                // Add a message around the missing class
index 227c379..b25e465 100644 (file)
@@ -1,6 +1,26 @@
 <?php
-
-// An exception class for lost classes... ;-)
+/**
+ * An exception thrown when to less people are unemployed and cannot be recruited
+ *
+ * @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 ToMuchEmployeesException extends FrameworkException {
        public function __construct ($amountArray, $code) {
                // Cast the array
index c649bed..fb11e1b 100644 (file)
@@ -1,8 +1,28 @@
 <?php
-
-// An exception class for lost classes... ;-)
+/**
+ * An exception thrown when the total price was not calculated
+ *
+ * @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 TotalPriceNotCalculatedException extends FrameworkException {
-       public function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:] Gesamtpreis ist nicht ermittelbar.",
                        $class->__toString()
index 152a898..ce02a79 100644 (file)
@@ -1,6 +1,26 @@
 <?php
-
-// An exception class for lost classes... ;-)
+/**
+ * An exception thrown when the limitation type is not supported
+ *
+ * @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 UnsupportedLimitationPartException extends FrameworkException {
        public function __construct ($str, $code) {
                // Add a message around the missing class
index ae12ce5..d3802d4 100644 (file)
@@ -1,6 +1,26 @@
 <?php
-
-// An exception class for lost classes... ;-)
+/**
+ * An exception thrown when a wrong gender was specified
+ *
+ * @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 WrongGenderSpecifiedException extends FrameworkException {
        public function __construct ($gender, $code) {
                // Add a message around the missing class
index b14230c..0674104 100644 (file)
@@ -1,17 +1,38 @@
 <?php
-// Application initializer
-//
-// Please remember that this include file is being loaded *before* the class
-// loader is loading classes from "exceptions", "interfaces" and "main"!
-//
-// You can prevent adding this application to the selector by uncommenting the
-// following line:
-//
-// if ((isset($this)) && (is_object($this)) && ($this->isSameClass("ApplicationSelector"))) { return; }
-//
-// isset() is required to prevent a warning and is_object() is highly required
-// when the application itself is requested in URL (hint: index.php?app=your_app)
-//
+/**
+ * Application initializer
+ *
+ * Please remember that this include file is being loaded *before* the class
+ * loader is loading classes from "exceptions", "interfaces" and "main"!
+ *
+ * You can prevent adding this application to the selector by uncommenting the
+ * following line:
+ *
+ * if ((isset($this)) && (is_object($this)) && ($this->isSameClass("ApplicationSelector"))) { return; }
+ *
+ * isset() is required to prevent a warning and is_object() is highly required
+ * when the application itself is requested in URL (hint: index.php?app=your_app)
+ *
+ * @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/>.
+ */
+
 // Get an instance of the helper
 $eval = sprintf("\$app = %s::getInstance();",
        FrameworkConfiguration::getInstance()->readConfig("app_helper_class")
index 9804433..8f214c7 100644 (file)
@@ -2,8 +2,24 @@
 /**
  * An interface for constructable ships
  *
- * @author     Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
- * @version    0.1
+ * @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/>.
  */
 interface ConstructableShip extends FrameworkInterface {
 }
index 0721b8c..0ca9231 100644 (file)
@@ -2,8 +2,24 @@
 /**
  * An interface for constructable ship parts
  *
- * @author     Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
- * @version    0.1
+ * @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/>.
  */
 interface ConstructableShipPart extends FrameworkInterface {
 }
index b398c4f..f36a91e 100644 (file)
@@ -2,14 +2,30 @@
 /**
  * An interface for contract partners
  *
- * @author     Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
- * @version    0.1
+ * @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/>.
  */
 interface ContractPartner extends FrameworkInterface {
        /**
         * This is a contract partner
         *
-        * @param               $contractInstance       Must be a valid instance of WorksContract
+        * @param       $contractInstance       Must be a valid instance of WorksContract
         * @return      boolean                 true  = can be a contract partner,
         *                                                      false = no partner for contracts
         */
index a111b14..aa46e01 100644 (file)
@@ -2,8 +2,24 @@
 /**
  * An interface for all customers
  *
- * @author     Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
- * @version    0.1
+ * @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/>.
  */
 interface Customer extends FrameworkInterface {
        /**
index 8952000..e792622 100644 (file)
@@ -2,8 +2,24 @@
 /**
  * An interface for tradeable items
  *
- * @author     Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
- * @version    0.1
+ * @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/>.
  */
 interface ItemIsTradeable extends FrameworkInterface {
        /**
index f4474e7..e528625 100644 (file)
@@ -2,11 +2,27 @@
 /**
  * An interface for all personells
  *
- * @author     Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
- * @version    0.1
+ * @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/>.
  */
 interface Personellizer extends FrameworkInterface {
-         ///////////////////////
+               ///////////////////////
         /// General methods ///
        ///////////////////////
 
@@ -36,7 +52,7 @@ interface Personellizer extends FrameworkInterface {
         */
        function isDateValid ($year, $month, $day);
 
-         /////////////////////////
+               /////////////////////////
         //// Status requests ////
        /////////////////////////
 
@@ -72,7 +88,7 @@ interface Personellizer extends FrameworkInterface {
         */
        function isFemale ();
 
-         /////////////////
+               /////////////////
         //// Getters ////
        /////////////////
 
@@ -104,7 +120,7 @@ interface Personellizer extends FrameworkInterface {
         */
        function getSalary ();
 
-         /////////////////
+               /////////////////
         //// Setters ////
        /////////////////
 
@@ -159,7 +175,7 @@ interface Personellizer extends FrameworkInterface {
         */
        function setBirthday ($year, $month, $day);
 
-         /////////////////////////////////////
+               /////////////////////////////////////
         //// Methods for changing salary ////
        /////////////////////////////////////
 
index 6b1636e..8834d17 100644 (file)
@@ -2,8 +2,24 @@
 /**
  * An interface for signable contracts
  *
- * @author     Roland Haeder <roland __NOSPAM__ [at] __REMOVE_ME__ mxchange [dot] org>
- * @version    0.1
+ * @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/>.
  */
 interface SignableContract extends FrameworkInterface {
        // Sign the contract
index 41dca7d..e44ed0f 100644 (file)
@@ -1,5 +1,28 @@
 <?php
-// The application's class loader
+/**
+ * A specialized class loader for this class
+ *
+ * @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/>.
+ */
+
+// Is the application instance set?
 if (!isset($application)) {
        // We need this!
        ApplicationEntryPoint::app_die("[Main:] Interne Variable <strong>application</strong> nicht gefunden!");
index d79a0d8..848989c 100644 (file)
@@ -1,5 +1,26 @@
 <?php
-// What every kind of personell have
+/**
+ * A general class for personell
+ *
+ * @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 BasePersonell extends BaseFrameworkSystem implements Personellizer {
        // Maximum/minimum age
        private $MIN_AGE = 21;
index 5671ee2..a4df6f4 100644 (file)
@@ -1,6 +1,26 @@
 <?php
-
-// Ein sehr abstraktes Objekt, Abmasse, Beschreibung und Teil-Instanz werden hier gespeichert
+/**
+ * The general simulator class
+ *
+ * @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 BaseSimulator extends BaseFrameworkSystem {
        // Schiffsteilinstanz
        private $partInstance = null;
index 3f13a63..40d2207 100644 (file)
@@ -1,6 +1,26 @@
 <?php
-
-// Die Haendler-Klasse
+/**
+ * A class for merchants which can trade items
+ *
+ * @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 Merchant extends BaseFrameworkSystem {
        // Name des Haendlers
        private $merchantName   = "Namenloser H&auml;ndler";
@@ -152,7 +172,7 @@ class Merchant extends BaseFrameworkSystem {
 
                // Iterate throw whole list
                for ($iter = $this->priceList->getIterator(); $iter->valid(); $iter->next()) {
-                       //Get current item
+                       // Get current item
                        $item = $iter->current();
 
                        // Does this item match? The unique ID may not work...
index d2d4aec..0504fa5 100644 (file)
@@ -1,6 +1,26 @@
 <?php
-
-// Bauvertrag-Klasse
+/**
+ * The work constract class which can be used for contract parties
+ *
+ * @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 WorksContract extends BaseFrameworkSystem implements SignableContract {
        // Zukuenftiger Schiffsname
        private $shipName         = "";
index 3fca7ea..87a4a7c 100644 (file)
@@ -1,6 +1,26 @@
 <?php
-
-// Die Reederei-Klasse
+/**
+ * A shipping company may be founded with this class
+ *
+ * @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 ShippingCompany extends BaseSimulator implements Customer, ContractPartner {
        /**
         * Full name of this company
@@ -526,7 +546,7 @@ class ShippingCompany extends BaseSimulator implements Customer, ContractPartner
                        // Validate if the first found shipyard can construct the requested type
                        $result = $shipyard->isShipTypeConstructable($shipType);
 
-                       //Does this shipyard construct the requested ship type?
+                       // Does this shipyard construct the requested ship type?
                        if ($result) break; // Then abort the search!
                }
 
index e268397..b802608 100644 (file)
@@ -1,5 +1,26 @@
 <?php
-// Die Liegeplatz-Klasse
+/**
+ * A berth is a place where ships can wait for their next assignment
+ *
+ * @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 Berth extends BaseConstruction {
        // Durchlaufende Nummer der Liegeplaetze
        private $berthIndex = 0;
index 8edd23d..2874302 100644 (file)
@@ -1,5 +1,26 @@
 <?php
-// Die abstrakte Bauten-Klasse
+/**
+ * A general construction (land) class
+ *
+ * @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 BaseConstruction extends BaseSimulator {
        // Tiefgang fuer z.B. Trockdocks
        private $draught = 0;
index f90c2da..e945128 100644 (file)
@@ -1,6 +1,26 @@
 <?php
-
-// Die Werft-Klasse
+/**
+ * A dry dock where ships can be repaired, repainted or modified in.
+ *
+ * @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 DryDock extends BaseConstruction {
        // Zugewiesener Hafen
        private $harborInstance = null;
index 2a687b0..ce273ad 100644 (file)
@@ -1,11 +1,31 @@
 <?php
-
-// Die Hafen-Klasse
+/**
+ * A harbor class suitable for all kind of harbors
+ *
+ * @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 Harbor extends BaseConstruction {
        // Namen des Hafens (z.B. Hamburger Hafen)
        private $harborName = "Unbekannter Hafen";
 
-       //Schiffsliste aller gebauten Schiffe
+       // Schiffsliste aller gebauten Schiffe
        private $constructedShips = null;
 
        // Liegeplatz-Liste
index dbbed27..aa38ee7 100644 (file)
@@ -1,6 +1,26 @@
 <?php
-
-// Die Anlegebruecke-Klasse
+/**
+ * A terminal class where ships can land and passengers can board the ship
+ *
+ * @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 Terminal extends BaseConstruction {
        // Zugewiesener Hafen
        private $harborInstance = null;
index 641ffee..050f0d7 100644 (file)
@@ -1,6 +1,27 @@
 <?php
-
-// Die Werft-Klasse
+/**
+ * A shipyard construction class which can be used for constructing all kinds of
+ * ships.
+ *
+ * @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 Shipyard extends BaseConstruction {
        // Werft-Name
        private $shipyardName    = "Namenlose Werft";
index ad52dd2..ce8d9e4 100644 (file)
@@ -1,6 +1,26 @@
 <?php
-
-// Die abstrakte Antrieb-Klasse
+/**
+ * A general drive class for all kind of "drives".
+ *
+ * @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 BaseDrive extends BaseSimulator {
        // Price of this drive
        private $price      = 0.00;
index 42e75f4..1e1bb2a 100644 (file)
@@ -1,6 +1,26 @@
 <?php
-
-// Motorisierter Antrieb
+/**
+ * A motorized drive for bigger ships
+ *
+ * @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 Motor extends BaseDrive implements ItemIsTradeable, ConstructableShipPart {
        // Constructor
        private function __construct() {
index 8a95e54..f209652 100644 (file)
@@ -1,6 +1,26 @@
 <?php
-
-// Dieses kann z.B. der Maschinenraum, die Bruecke, Kabinen, Laderaum, etc. sein
+/**
+ * This is a general ship part which can be used for all other ship parts...
+ *
+ * @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 BaseShipPart extends BaseSimulator {
        // Price of this ship part
        private $price = 0.00;
index f2ef225..2367ab7 100644 (file)
@@ -1,6 +1,26 @@
 <?php
-// Der Maschinenraum ist etwas anderes als eine Kabine, etc. !
-// Daher hat er eine eigene Klasse
+/**
+ * A maschine room class for really huge ships
+ *
+ * @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 MaschineRoom extends BaseShipPart {
        // Constructor
        private function __construct () {
index 532ca3f..f04a029 100644 (file)
@@ -1,6 +1,26 @@
 <?php
-
-// Die Schiffsbesatzung
+/**
+ * The general simulator personell class
+ *
+ * @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 SimulatorPersonell extends BasePersonell {
        // Personell list
        private $personellList = null;
index d996f9f..970017b 100644 (file)
@@ -1,6 +1,26 @@
 <?php
-
-// Die Schiffsbesatzung
+/**
+ * Campany employees may be handled and payed within this class
+ *
+ * @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 CompanyEmployee extends SimulatorPersonell {
        // Employeee list
        private $employeeList = null;
index 6893740..c4a548b 100644 (file)
@@ -1,4 +1,26 @@
 <?php
+/**
+ * A general ship class for all other kinds of ships even small sail ships
+ *
+ * @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 BaseShip extends BaseSimulator {
        // Name des Shipes
        private $shipName   = "Unbekanntes Schiff";
index c5dfc01..23a6c3e 100644 (file)
@@ -1,5 +1,27 @@
 <?php
-
+/**
+ * A passenger ship with one or more decks, cabins, bridge (replacement for the
+ * captain) and many more
+ *
+ * @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 PassengerShip extends BaseShip implements ConstructableShip, LimitableObject {
        // Konstruktor
        private function __construct () {
index 007f9bf..733f0c4 100644 (file)
@@ -1,5 +1,26 @@
 <?php
-// Konstruktionen allgemein (also Aufbauten/Unterbauten)
+/**
+ * A general construction class
+ *
+ * @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 BaseStructure extends BaseSimulator {
        // Price of this structure
        private $price = 0.00;
index b12cfcd..0831a3b 100644 (file)
@@ -1,5 +1,26 @@
 <?php
-// Kabinen allgemein
+/**
+ * A general cabin class
+ *
+ * @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 BaseCabin extends BaseCabinStructure {
        // Konstruktor
        private function __construct ($class) {
index fadd15e..52cf199 100644 (file)
@@ -1,5 +1,26 @@
 <?php
-// Economy-Class-Kabinen
+/**
+ * Cabins in the economy class may use this class
+ *
+ * @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 EconomyCabin extends BaseCabin implements ItemIsTradeable, ConstructableShipPart {
        // Konstruktor
        private function __construct () {
index b1707ab..bdb6796 100644 (file)
@@ -1,5 +1,26 @@
 <?php
-// 2-Sterne-Kabinen
+/**
+ * Cabins in the lower decks may use this class
+ *
+ * @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 LowCabin extends BaseCabin implements ItemIsTradeable, ConstructableShipPart {
        // Konstruktor
        private function __construct () {
index bc70665..25c0dd4 100644 (file)
@@ -1,9 +1,30 @@
 <?php
-// Luxuskabinen
+/**
+ * Luxury class cabins  resists here
+ *
+ * @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 LuxuryCabin extends BaseCabin implements ItemIsTradeable, ConstructableShipPart {
        // Konstruktor
        private function __construct () {
-               //Call parent constructor
+               // Call parent constructor
                parent::constructor(__CLASS__);
 
                // Debug message
index c7d846d..3be9a95 100644 (file)
@@ -1,5 +1,26 @@
 <?php
-// Premier-Kabinen
+/**
+ * So-called "premier class" cabins are constructed with this class (medium class)
+ *
+ * @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 PremierCabin extends BaseCabin implements ItemIsTradeable, ConstructableShipPart {
        // Konstruktor
        private function __construct () {
index 9f80e43..e989b25 100644 (file)
@@ -1,5 +1,26 @@
 <?php
-// Kabinen allgemein
+/**
+ * General cabin structure class
+ *
+ * @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 BaseCabinStructure extends BaseStructure {
        // --- Besondere Eigenschaften dazufuegen: ---
        // Anzahl der Kabinen im Schiff
index 5c218cc..2ba52a5 100644 (file)
@@ -1,5 +1,26 @@
 <?php
-// Decks (fuer Cargo) allgemein
+/**
+ * A general deck structure class
+ *
+ * @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 BaseDeckStructure extends BaseStructure {
        // Anzahl Decks
        private $numDecks = 0;
index ee7264d..e52a124 100644 (file)
@@ -1,5 +1,26 @@
 <?php
-// Super structures (renamed to UpperStructure to avoid mixing it with super classes
+/**
+ * A general upper structure class.
+ *
+ * @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 BaseUpperStructure extends BaseStructure {
        /**
         * Constructor for all super structures on a ship
index 110d360..397b348 100644 (file)
@@ -1,5 +1,26 @@
 <?php
-// Auto-Deck
+/**
+ * A deck class for cars with ramps and about 2.5 meters hich
+ *
+ * @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 CarDeck extends BaseDeck implements ItemIsTradeable, ConstructableShipPart {
        // Konstruktor
        private function __construct () {
index b643807..4c26c39 100644 (file)
@@ -1,5 +1,26 @@
 <?php
-// Decks fuer LKWs
+/**
+ * A train deck with rails constructed in it
+ *
+ * @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 TrainDeck extends BaseDeck implements ItemIsTradeable, ConstructableShipPart {
        // Konstruktor
        private function __construct () {
index 73207e5..99c901a 100644 (file)
@@ -1,5 +1,27 @@
 <?php
-// Decks fuer LKWs
+/**
+ * A truck and bus decks. Also other vehicle may be put in here if they don't
+ * match into the car deck.
+ *
+ * @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 TruckDeck extends BaseDeck implements ItemIsTradeable, ConstructableShipPart {
        // Konstruktor
        private function __construct () {
index e72f96f..22da45c 100644 (file)
@@ -1,5 +1,26 @@
 <?php
-// General (base) deck
+/**
+ * A general cabin class
+ *
+ * @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 BaseDeck extends BaseDeckStructure {
        /**
         * Constructor for cargo decks in general
index 80c4370..7f0fce4 100644 (file)
@@ -1,5 +1,26 @@
 <?php
-// Die Aufbauten allgemein
+/**
+ * The control bridge of the ship
+ *
+ * @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 Bridge extends BaseUpperStructure implements ItemIsTradeable, ConstructableShipPart {
        // Constructor
        private function __construct () {
@@ -39,7 +60,7 @@ class Bridge extends BaseUpperStructure implements ItemIsTradeable, Constructabl
                $bridgeInstance->setHeight($height);
                $bridgeInstance->setLength($length);
 
-               //Instanz zurueckgeben
+               // Instanz zurueckgeben
                return $bridgeInstance;
        }
 
index 1e6e523..223ccc0 100644 (file)
@@ -1,4 +1,27 @@
 <?php
+/**
+ * The application launcher
+ *
+ * @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/>.
+ */
+
 // Is there an application helper instance? We need the method main() for
 // maining the application
 $app = ApplicationHelper::getInstance();
index 4ff32f0..2ca8d61 100644 (file)
@@ -25,14 +25,11 @@ class MismatchingCompressorsException extends FrameworkException {
        /**
         * The constructor
         *
-        * @param               $message                Message from the exception
-        * @param               $code           Code number for the exception
+        * @param       $array  Message from the exception
+        * @param       $code   Code number for the exception
         * @return      void
         */
-       public final function __construct ($array, $code) {
-               // Cast the array
-               $array = (array) $array;
-
+       public function __construct (array $array, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:%d] Der Kompressor <u>%s</u> zu den geladenen Daten aus <u>%s</u> und der aktuell verwendete Kompressor <u>%s</u> stimmen nicht &uuml;berein!",
                        $array[0]->__toString(),
index a5e3468..405c39b 100644 (file)
@@ -29,7 +29,7 @@ class ContainerItemIsNoArrayException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:%d] Ein Container-Item ist kein Array.",
                        $class->__toString(),
index bffb9b0..2cfafc4 100644 (file)
@@ -29,7 +29,7 @@ class ContainerItemIsNullException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:%d] Ein Container-Item ist auf <em>null</em> gesetzt.",
                        $class->__toString(),
index 417e49d..5668698 100644 (file)
@@ -29,7 +29,7 @@ class ContainerMaybeDamagedException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:%d] Ein Container ist m&ouml;glicherweise besch&auml;digt.",
                        $class->__toString(),
index ddc60e8..efae626 100644 (file)
@@ -29,7 +29,7 @@ class SavePathIsEmptyException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:%d] Der Speicherpfad ist leer.",
                        $class->__toString(),
index 0eabf4e..964a8d4 100644 (file)
@@ -29,7 +29,7 @@ class SavePathIsNoDirectoryException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($path, $code) {
+       public function __construct ($path, $code) {
                // Add a message around the missing class
                $message = sprintf("Der angegebene Speicherpfad <u>%s</u> ist ung&uuml;tig (kein Pfad).", $path);
 
index 678ecd0..26b86b3 100644 (file)
@@ -29,7 +29,7 @@ class SavePathReadProtectedException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($path, $code) {
+       public function __construct ($path, $code) {
                // Add a message around the missing class
                $message = sprintf("Der Pfad <u>%s</u> ist lese-gesch&uuml;tzt. Bitte Zugriffsrechte (CHMOD) zum Lesen setzen.", $path);
 
index 0e7ca79..4ad2790 100644 (file)
@@ -29,7 +29,7 @@ class SavePathWriteProtectedException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($path, $code) {
+       public function __construct ($path, $code) {
                // Add a message around the missing class
                $message = sprintf("Der angegebene Speicherpfad <u>%s</u> ist schreibgesch&uuml;tzt. Bitte Zugriffsrechte (CHMOD) entsprechend setzen.", $path);
 
index 5c415e1..060b017 100644 (file)
@@ -29,7 +29,7 @@ class DirPointerNotOpenedException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($path, $code) {
+       public function __construct ($path, $code) {
                // Add a message around the missing class
                $message = sprintf("F&uuml;r den Pfad <u>%s</u> konnte kein Pointer initialisiert werden.", $path);
 
index fd4e541..9c7a8a8 100644 (file)
@@ -29,7 +29,7 @@ class FilePointerNotOpenedException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($path, $code) {
+       public function __construct ($path, $code) {
                // Add a message around the missing class
                $message = sprintf("F&uuml;r die Datei <u>%s</u> konnte kein Pointer initialisiert werden. M&ouml;glicherweise ist die Datei nicht lesbar oder fehlt!", $path);
 
index 630d1ca..bc74213 100644 (file)
@@ -7,7 +7,7 @@
  * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.mxchange.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
@@ -25,14 +25,11 @@ class InvalidDataLengthException extends FrameworkException {
        /**
         * The constructor
         *
-        * @param               $message                Message from the exception
-        * @param               $code           Code number for the exception
+        * @param       $array  Message from the exception
+        * @param       $code   Code number for the exception
         * @return      void
         */
-       public final function __construct ($array, $code) {
-               // Cast the array
-               $array = (array) $array;
-
+       public function __construct (array $array, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:%d] Eine unerwartete Datenl&auml;nge von <u>%s</u> Byte ist aufgetreten. <u>%s</u> wurden erwartet!",
                        $array[0]->__toString(),
index fc48beb..668b0f0 100644 (file)
@@ -29,7 +29,7 @@ class InvalidDirectoryResourceException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                if (is_null($class)) {
                        $message = "[???:] Ung&uuml;tige Verzeichnis-Resource.";
index 1044d25..1aabdb4 100644 (file)
@@ -7,7 +7,7 @@
  * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.mxchange.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
@@ -25,14 +25,11 @@ class InvalidMD5ChecksumException extends FrameworkException {
        /**
         * The constructor
         *
-        * @param               $message                Message from the exception
-        * @param               $code           Code number for the exception
+        * @param       $array  Message from the exception
+        * @param       $code   Code number for the exception
         * @return      void
         */
-       public final function __construct ($array, $code) {
-               // Cast the array
-               $array = (array) $array;
-
+       public function __construct (array $array, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:%d] Die MD5-Pr&uuml;fsummen <u>%s</u> und <u>%s</u> stimmen nicht &uuml;berein!",
                        $array[0]->__toString(),
index ffabd5c..4c93d20 100644 (file)
@@ -29,7 +29,7 @@ class PathIsEmptyException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                if (is_null($class)) {
                        $message = "[???:] Der Verzeichnisname ist leer.";
index 6b0a531..2ff79ba 100644 (file)
@@ -29,7 +29,7 @@ class PathIsNoDirectoryException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($path, $code) {
+       public function __construct ($path, $code) {
                // Add a message around the missing class
                $message = sprintf("Der angegebene Pfad <u>%s</u> ist ung&uuml;tig (kein Pfad).", $path);
 
index 530f16f..70ea7c0 100644 (file)
@@ -29,7 +29,7 @@ class PathReadProtectedException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($path, $code) {
+       public function __construct ($path, $code) {
                // Add a message around the missing class
                $message = sprintf("Der Pfad <u>%s</u> ist lese-gesch&uuml;tzt. Bitte Zugriffsrechte (CHMOD) zum Lesen setzen.", $path);
 
index 24674cd..5161c23 100644 (file)
@@ -29,7 +29,7 @@ class InvalidLanguagePathStringException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:%d] <u>%s</u> ist keine Zeichenkette!",
                        $class[0]->__toString(),
index 4e2cbf8..653f4c0 100644 (file)
@@ -29,7 +29,7 @@ class LanguagePathIsEmptyException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:%d] Der Sprachen-Basispfad ist leer.",
                        $class->__toString(),
index 1f0f53d..6a672af 100644 (file)
@@ -29,7 +29,7 @@ class LanguagePathIsNoDirectoryException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:%d] Der Sprach-Basispfad <u>%s</u> existiert nicht oder ist eine Datei!",
                        $class[0]->__toString(),
index 72bf450..ccfd2c3 100644 (file)
@@ -29,7 +29,7 @@ class LanguagePathReadProtectedException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:%d] Der Sprach-Basispfad <u>%s</u> ist lesegesch&uuml;tzt! Bitte Zugriffsrechte (CHMOD) &auml;ndern.",
                        $class[0]->__toString(),
index b8079c1..b482001 100644 (file)
@@ -29,7 +29,7 @@ class ClassMismatchException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($classArray, $code) {
+       public function __construct (array $classArray, $code) {
                // Add a message around the missing class
                $message = sprintf("Die Klasse <u>%s</u> ist ungleich <u>%s</u>.",
                        $classArray[0],
index a91f6e7..b7242e7 100644 (file)
@@ -29,7 +29,7 @@ class ClassNotFoundException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                $message = sprintf("Die interne Script-Klasse <u>%s</u> konnte nicht gefunden werden!", $class);
 
index 2661bf0..df18915 100644 (file)
@@ -29,7 +29,7 @@ class ConfigEntryIsEmptyException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:%d] Leeren Konfigurationseintrag angegeben!",
                        $class,
index b83567f..b753bdf 100644 (file)
@@ -29,7 +29,7 @@ class ConfigEntryNotFoundException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct (array $classArray, $code) {
+       public function __construct (array $classArray, $code) {
                // Cast the array
                $classArray = (array) $classArray;
 
index f65a01a..4e0bcfb 100644 (file)
@@ -29,7 +29,7 @@ class DimNotFoundInArrayException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                if (is_object($class)) {
                        // Add a message around the missing class
                        $message = sprintf("[%s:%d] Abmasse konnten nicht extrahiert werden!",
index d8123eb..af6ae2c 100644 (file)
@@ -30,7 +30,7 @@ class ExceptionNotChangedException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:%d] Exception(s) wurde(n) nicht ge&auml;ndert.",
                        $class,
index 131e732..33867ae 100644 (file)
@@ -29,7 +29,7 @@ class ExceptionNotFoundException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct (array $classArray, $code) {
+       public function __construct (array $classArray, $code) {
                // Cast the array
                $classArray = (array) $classArray;
 
index bb25fdb..64a402b 100644 (file)
@@ -29,7 +29,7 @@ class GetterNotFoundException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($dataArray, $code) {
+       public function __construct ($dataArray, $code) {
                // Cast the array
                $dataArray = (array) $dataArray;
 
index 93f4ff8..215d1ab 100644 (file)
@@ -7,7 +7,7 @@
  * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.mxchange.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
@@ -25,14 +25,11 @@ class InvalidArrayCountException extends FrameworkException {
        /**
         * The constructor
         *
-        * @param               $message                Message from the exception
-        * @param               $code           Code number for the exception
+        * @param       $array  Message from the exception
+        * @param       $code   Code number for the exception
         * @return      void
         */
-       public final function __construct ($array, $code) {
-               // Cast the array
-               $array = (array) $array;
-
+       public function __construct (array $array, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:%d] <u>%s</u> hat <u>%d</u> Elemente, soll aber <u>%d</u> enthalten!",
                        $array[0]->__toString(),
index c74eecb..9dca343 100644 (file)
@@ -29,7 +29,7 @@ class InvalidObjectException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:%d] Objekte sind nicht erlaubt. (Objekt: <u>%s</u>)",
                        $class->__toString(),
index 17e0d05..eed1c9b 100644 (file)
@@ -29,7 +29,7 @@ class MissingArrayElementsException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($classArray, $code) {
+       public function __construct (array $classArray, $code) {
                // Cast the array
                $classArray = (array) $classArray;
 
index c5b28a4..771bf7b 100644 (file)
@@ -29,7 +29,7 @@ class MissingDecimalsThousandsSeperatorException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($instance, $code) {
+       public function __construct ($instance, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:%d] Die Dezimal- und Tausendertrenner fehlen!",
                        $instance->__toString(),
index 4667068..d8bd326 100644 (file)
@@ -29,7 +29,7 @@ class MissingMethodException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($classArray, $code) {
+       public function __construct (array $classArray, $code) {
                // Cast the array
                $classArray = (array) $classArray;
 
index b3a68c7..dd1e7fa 100644 (file)
@@ -7,7 +7,7 @@
  * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.mxchange.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
@@ -25,14 +25,11 @@ class NoArrayCreatedException extends FrameworkException {
        /**
         * The constructor
         *
-        * @param               $message                Message from the exception
-        * @param               $code           Code number for the exception
+        * @param       $array  Message from the exception
+        * @param       $code   Code number for the exception
         * @return      void
         */
-       public final function __construct ($array, $code) {
-               // Cast the array
-               $array = (array) $array;
-
+       public function __construct (array $array, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:%d] <u>%s</u> ist kein erstelltes Objekt.",
                        $array[0]->__toString(),
index 9e5942b..eacfca3 100644 (file)
@@ -27,7 +27,7 @@ class NoArrayException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($string, $code) {
+       public function __construct ($string, $code) {
                // Add a message around the missing class
                $message = sprintf("<u>%s</u> ist kein Array!",
                        $string
index 7f3da77..c169685 100644 (file)
@@ -31,7 +31,7 @@ class NoObjectException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($string, $code) {
+       public function __construct ($string, $code) {
                // Add a message around the missing class
                $message = sprintf("<u>%s</u> ist kein Objekt!",
                        $string
index 45487d5..489465a 100644 (file)
@@ -29,7 +29,7 @@ class NullPointerException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:%d] Eine Instanz/Pointer ist auf <em>null</em> gesetzt.",
                        $class->__toString(),
index 0ec1a4d..9c9a51f 100644 (file)
@@ -7,7 +7,7 @@
  * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.mxchange.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
@@ -25,14 +25,11 @@ class VariableIsNotSetException extends FrameworkException {
        /**
         * The constructor
         *
-        * @param               $message                Message from the exception
-        * @param               $code           Code number for the exception
+        * @param       $array  Message from the exception
+        * @param       $code   Code number for the exception
         * @return      void
         */
-       public final function __construct ($array, $code) {
-               // Cast the array
-               $array = (array) $array;
-
+       public function __construct (array $array, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:%d] Bei der Initialisierung der Applikation <u>%s</u> wurde keine Variable <u>%s</u> erzeugt.",
                        $array[0]->__toString(),
index ed59ac5..e155afe 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * An exception throws when the base path is empty
+ * An exception thrown when the base path is empty
  *
  * @author             Roland Haeder <webmaster@mxchange.org>
  * @version            0.3.0
@@ -29,7 +29,7 @@ class BasePathIsEmptyException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:%d] Der Template-Basispfad ist leer.",
                        $class->__toString(),
index 6d32301..271b447 100644 (file)
@@ -29,7 +29,7 @@ class BasePathIsNoDirectoryException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:%d] Der Template-Basispfad <u>%s</u> existiert nicht oder ist eine Datei!",
                        $class[0]->__toString(),
index b95171d..5350717 100644 (file)
@@ -29,7 +29,7 @@ class BasePathReadProtectedException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:%d] Der Template-Basispfad <u>%s</u> ist lesegesch&uuml;tzt! Bitte Zugriffsrechte (CHMOD) &auml;ndern.",
                        $class[0]->__toString(),
index 7236f6e..08a6d22 100644 (file)
@@ -1,13 +1,13 @@
 <?php
 /**
- * An exception throws hen the base path string is invalid
+ * An exception thrown hen the base path string is invalid
  *
  * @author             Roland Haeder <webmaster@mxchange.org>
  * @version            0.3.0
  * @copyright  Copyright(c) 2007, 2008 Roland Haeder, this is free software
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.mxchange.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
@@ -25,11 +25,11 @@ class InvalidBasePathStringException extends FrameworkException {
        /**
         * The constructor
         *
-        * @param               $class          An array holding our informations
-        * @param               $code           Code number for the exception
+        * @param       $class          An array holding our informations
+        * @param       $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:%d] <u>%s</u> ist keine Zeichenkette!",
                        $class[0]->__toString(),
index 6dc35af..8a3151c 100644 (file)
@@ -29,7 +29,7 @@ class InvalidTemplateVariableNameException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:%d] Die im Template <u>%s</u> gefundene Variable <u>%s</u> ist nicht g&uuml;ltig! G&uuml;ltige Variablennamen sind nur <u>%s</strong>.",
                        $class[0]->__toString(),
index 0612603..b1d0d14 100644 (file)
@@ -1,6 +1,6 @@
 <?php
 /**
- * An exception throws when the template type is not supported
+ * An exception thrown when the template type is not supported
  *
  * @author             Roland Haeder <webmaster@mxchange.org>
  * @version            0.3.0
@@ -29,7 +29,7 @@ class UnexpectedTemplateTypeException extends FrameworkException {
         * @param               $code           Code number for the exception
         * @return      void
         */
-       public final function __construct ($class, $code) {
+       public function __construct (BaseFrameworkSystem $class, $code) {
                // Add a message around the missing class
                $message = sprintf("[%s:%d] Der Template-Typ <u>%s</u> entspricht nicht dem erwartetem Template-Typ <u>%s</u>.",
                        $class[0]->__toString(),