code comments including license information added, type hints added, minor rewrites...
[shipsimu.git] / application / ship-simu / main / structures / extended / cabines / ship / class_EconomyCabin.php
1 <?php
2 /**
3  * Cabins in the economy class may use this class
4  *
5  * @author              Roland Haeder <webmaster@ship-simu.org>
6  * @version             0.0.0
7  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.ship-simu.org
10  *
11  * This program is free software: you can redistribute it and/or modify
12  * it under the terms of the GNU General Public License as published by
13  * the Free Software Foundation, either version 3 of the License, or
14  * (at your option) any later version.
15  *
16  * This program is distributed in the hope that it will be useful,
17  * but WITHOUT ANY WARRANTY; without even the implied warranty of
18  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19  * GNU General Public License for more details.
20  *
21  * You should have received a copy of the GNU General Public License
22  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
23  */
24 class EconomyCabin extends BaseCabin implements ItemIsTradeable, ConstructableShipPart {
25         // Konstruktor
26         private function __construct () {
27                 // Call parent constructor
28                 parent::constructor(__CLASS__);
29
30                 // Debug message
31                 if (((defined('DEBUG_CABIN')) || (defined('DEBUG_ALL'))) && (defined('DEBUG_CONSTRUCT'))) {
32                         $this->getDebugInstance()->output(sprintf("[%s:%d] Konstruktor erreicht.<br />\n",
33                                 __CLASS__,
34                                 __LINE__
35                         ));
36                 }
37
38                 // Set description
39                 $this->setPartDescr("Economy-Class-Kabine");
40
41                 // Generate unique ID number
42                 $this->createUniqueID();
43
44                 // Clean up a little
45                 $this->removeSystemArray();
46         }
47
48         // Economy-Kabine erstellen
49         public static function createEconomyCabin ($numLuxury, $numRooms, $numBeds, $dim) {
50                 // Get new instance
51                 $ecoInstance = new EconomyCabin();
52
53                 // Debug message
54                 if ((defined('DEBUG_CABIN')) || (defined('DEBUG_ALL'))) $ecoInstance->getDebugInstance()->output(sprintf("[%s:%d] Eine Economy-Class-Kabine wird konstruiert...<br />\n",
55                         __CLASS__,
56                         __LINE__
57                 ));
58
59                 // Abmasse extrahieren
60                 $ecoInstance->extractDimensions($dim);
61
62                 // Den Rest auch setzen
63                 $ecoInstance->setNumCabin($numLuxury);
64                 $ecoInstance->setNumRooms($numRooms);
65                 $ecoInstance->setNumBeds($numBeds);
66
67                 // Nicht noetig!
68                 $ecoInstance->removePartInstance();
69
70                 // Instanz zurueckgeben
71                 return $ecoInstance;
72         }
73
74         // Loesch-Methode fuer Anzahl Betten
75         public function removeNumBeds() {
76                 if ((defined('DEBUG_CABIN')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Anzahl Betten gel&ouml;scht.<br />\n",
77                         __CLASS__,
78                         __LINE__
79                 ));
80                 unset($this->numBeds);
81                 parent::removeNumBeds();
82         }
83
84         // Loesch-Methode fuer Anzahl Kabinen
85         public function removeNumCabin() {
86                 if ((defined('DEBUG_CABIN')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Anzahl Kabinen gel&ouml;scht.<br />\n",
87                         __CLASS__,
88                         __LINE__
89                 ));
90                 unset($this->numCabin);
91                 parent::removeNumCabin();
92         }
93
94         // Loesch-Methode fuer Anzahl Raeume
95         public function removeNumRooms() {
96                 if ((defined('DEBUG_CABIN')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Anzahl R&auml;ume gel&ouml;scht.<br />\n",
97                         __CLASS__,
98                         __LINE__
99                 ));
100                 unset($this->numRooms);
101                 parent::removeNumRooms();
102         }
103
104         // Overwritten method for tradeable items
105         public function isTradeable () {
106                 return true;
107         }
108
109         /**
110          * Limits this object with an ObjectLimits instance
111          */
112         public function limitObject (ObjectLimits $limitInstance) {
113                 ApplicationEntryPoint::app_die("".__METHOD__." reached! Stub!");
114         }
115 }
116
117 // [EOF]
118 ?>