Type-hints fixed, header docs fixed, exceptions deprecated
[shipsimu.git] / application / ship-simu / main / structures / extended / class_BaseCabinStructure.php
index 9f80e43511b8a70bebadf3e7fef3c1d5832c04ad..918f66e00b7fac094d7a917bf330c77f66a14d2d 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
@@ -12,30 +33,12 @@ class BaseCabinStructure extends BaseStructure {
        private $numBeds = 0;
 
        // Konstruktor
-       private function __construct ($class) {
+       protected function __construct ($className) {
                // Call parent constructor
-               parent::constructor($class);
-
-               // Debug message
-               if (((defined('DEBUG_STRUCTURE')) || (defined('DEBUG_ALL'))) && (defined('DEBUG_CONSTRUCT'))) {
-                       $this->getDebugInstance()->output(sprintf("[%s:%d] Konstruktor erreicht.<br />\n",
-                               __CLASS__,
-                               __LINE__
-                       ));
-               }
+               parent::__construct($className);
 
                // Set description
-               $this->setPartDescr("Kabinenstruktur");
-       }
-
-       /**
-        * Calls the private constructor
-        *
-        * @param       $class  The class' name
-        * @return      void
-        */
-       public function constructor ($class) {
-               $this->__construct($class);
+               $this->setObjectDescription("Kabinenstruktur");
        }
 
        // Kabine hinzufuegen
@@ -43,7 +46,7 @@ class BaseCabinStructure extends BaseStructure {
                if ((defined('DEBUG_STRUCTURE')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Die Kabine <strong>%s</strong> wird f&uuml;r das Schiff <strong>%s</strong> konstruiert.<br />\n",
                        __CLASS__,
                        __LINE__,
-                       $cabinInstance->getPartDescr(),
+                       $cabinInstance->getObjectDescription(),
                        $shipInstance->getShipName()
                ));
 
@@ -67,7 +70,7 @@ class BaseCabinStructure extends BaseStructure {
                if ((defined('DEBUG_STRUCTURE')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Die Kabine <strong>%s</strong> wurde in das Schiff eingebaut.<br />\n",
                        __CLASS__,
                        __LINE__,
-                       $cabinInstance->getPartDescr(),
+                       $cabinInstance->getObjectDescription(),
                        $shipInstance->getShipName()
                ));
        }
@@ -132,7 +135,7 @@ class BaseCabinStructure extends BaseStructure {
        }
 
        // Loesch-Methode fuer Anzahl Betten
-       public function removeNumBeds() {
+       public final function removeNumBeds() {
                if ((defined('DEBUG_STRUCTURE')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Anzahl Betten gel&ouml;scht.<br />\n",
                        __CLASS__,
                        __LINE__
@@ -141,7 +144,7 @@ class BaseCabinStructure extends BaseStructure {
        }
 
        // Loesch-Methode fuer Anzahl Kabinen
-       public function removeNumCabin() {
+       public final function removeNumCabin() {
                if ((defined('DEBUG_STRUCTURE')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Anzahl Kabinen gel&ouml;scht.<br />\n",
                        __CLASS__,
                        __LINE__
@@ -150,7 +153,7 @@ class BaseCabinStructure extends BaseStructure {
        }
 
        // Loesch-Methode fuer Anzahl Raeume
-       public function removeNumRooms() {
+       public final function removeNumRooms() {
                if ((defined('DEBUG_STRUCTURE')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Anzahl R&auml;ume gel&ouml;scht.<br />\n",
                        __CLASS__,
                        __LINE__