code comments including license information added, type hints added, minor rewrites...
[shipsimu.git] / application / ship-simu / main / structures / extended / cabines / ship / class_LowCabin.php
1 <?php
2 /**
3  * Cabins in the lower decks 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 LowCabin 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'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Konstruktor erreicht.<br />\n",
32                         __CLASS__,
33                         __LINE__
34                 ));
35
36                 // Set description
37                 $this->setPartDescr("2Star-Class-Kabine");
38
39                 // Generate unique ID number
40                 $this->createUniqueID();
41
42                 // Clean up a little
43                 $this->removeSystemArray();
44         }
45
46         // 2-Sterne-Klasse erstellen
47         public static function createLowCabin ($numLuxury, $numRooms, $numBeds, $dim) {
48                 // Get new instance
49                 $lowInstance = new LowCabin();
50
51                 // Debug message
52                 if ((defined('DEBUG_CABIN')) || (defined('DEBUG_ALL'))) $lowInstance->getDebugInstance()->output(sprintf("[%s:%d] Eine 2-Sterne-Kabine wird konstruiert...<br />\n",
53                         __CLASS__,
54                         __LINE__
55                 ));
56
57                 // Abmasse extrahieren
58                 $lowInstance->extractDimensions($dim);
59
60                 // Den Rest auch setzen
61                 $lowInstance->setNumCabin($numLuxury);
62                 $lowInstance->setNumRooms($numRooms);
63                 $lowInstance->setNumBeds($numBeds);
64
65                 // Nicht noetig!
66                 $lowInstance->removePartInstance();
67
68                 // Instanz zurueckgeben
69                 return $lowInstance;
70         }
71
72         // Loesch-Methode fuer Anzahl Betten
73         public function removeNumBeds() {
74                 if ((defined('DEBUG_CABIN')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Anzahl Betten gel&ouml;scht.<br />\n",
75                         __CLASS__,
76                         __LINE__
77                 ));
78                 unset($this->numBeds);
79                 parent::removeNumBeds();
80         }
81
82         // Loesch-Methode fuer Anzahl Kabinen
83         public function removeNumCabin() {
84                 if ((defined('DEBUG_CABIN')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Anzahl Kabinen gel&ouml;scht.<br />\n",
85                         __CLASS__,
86                         __LINE__
87                 ));
88                 unset($this->numCabin);
89                 parent::removeNumCabin();
90         }
91
92         // Loesch-Methode fuer Anzahl Raeume
93         public function removeNumRooms() {
94                 if ((defined('DEBUG_CABIN')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Anzahl R&auml;ume gel&ouml;scht.<br />\n",
95                         __CLASS__,
96                         __LINE__
97                 ));
98                 unset($this->numRooms);
99                 parent::removeNumRooms();
100         }
101
102         // Overwritten method for tradeable items
103         public function isTradeable () {
104                 return true;
105         }
106
107         /**
108          * Limits this object with an ObjectLimits instance
109          */
110         public function limitObject (ObjectLimits $limitInstance) {
111                 ApplicationEntryPoint::app_die("".__METHOD__." reached! Stub!");
112         }
113 }
114
115 // [EOF]
116 ?>