code comments including license information added, type hints added, minor rewrites...

[shipsimu.git] / application / ship-simu / main / constructions / harbors / class_Harbor.php

diff --git a/application/ship-simu/main/constructions/harbors/class_Harbor.php b/application/ship-simu/main/constructions/harbors/class_Harbor.php
index 1839754f909e5e51bf9477d5fed4e151a39a4747..ce273ad58f3143f9ebfc2e4b5f3ad708130d6f10 100644 (file)
--- a/application/ship-simu/main/constructions/harbors/class_Harbor.php
+++ b/application/ship-simu/main/constructions/harbors/class_Harbor.php
@@ -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
@@ -16,16 +36,16 @@ class Harbor extends BaseConstruction {
 
        // Constructor
        private function __construct () {
-               // Eltern-Konstruktor aufrufen
+               // Call parent constructor
                parent::constructor(__CLASS__);
 
                // Debug message
                if (((defined('DEBUG_HARBOR')) || (defined('DEBUG_ALL'))) && (defined('DEBUG_CONSTRUCT'))) $this->getDebugInstance()->output("[Harbor:] Konstruktor erreicht.<br />\n");
 
-               // Beschreibung setzen
+               // Set description
                $this->setPartDescr("Hafen");
 
-               // Unique-ID erzeugen
+               // Generate unique ID number
                $this->createUniqueID();
 
                // Clean up a little
@@ -63,13 +83,13 @@ class Harbor extends BaseConstruction {
        }
 
        // Setter fuer Hafennamen
-       public function setHarborName ($harborName) {
+       public final function setHarborName ($harborName) {
                if ((defined('DEBUG_HARBOR')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[Harbor:] Der Hafen heisst jetzt <strong>%s</strong>.<br />\n", $harborName));
                $this->harborName = (string) $harborName;
        }
 
        // Getter fuer Hafennamen
-       public function getHarborName () {
+       public final function getHarborName () {
                if ((defined('DEBUG_HARBOR')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[Harbor:] Hafenname <strong>%s</strong> wurde angefordert.<br />\n", $this->harborName));
                return $this->harborName;
        }