code comments including license information added, type hints added, minor rewrites...
[shipsimu.git] / application / ship-simu / main / structures / extended / class_BaseDeckStructure.php
1 <?php
2 /**
3  * A general deck structure 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 BaseDeckStructure extends BaseStructure {
25         // Anzahl Decks
26         private $numDecks = 0;
27
28         // Konstruktor
29         private function __construct ($class) {
30                 // Call parent constructor
31                 parent::constructor($class);
32
33                 // Debug message
34                 if (((defined('DEBUG_STRUCTURE')) || (defined('DEBUG_ALL'))) && (defined('DEBUG_CONSTRUCT'))) {
35                         $this->getDebugInstance()->output(sprintf("[%s:%d] Konstruktor erreicht.<br />\n",
36                                 __CLASS__,
37                                 __LINE__
38                         ));
39                 }
40
41                 // Set description
42                 $this->setPartDescr("Deckstruktur");
43         }
44
45         /**
46          * Calls the private constructor
47          *
48          * @param       $class  The class' name
49          * @return      void
50          */
51         public function constructor ($class) {
52                 $this->__construct($class);
53         }
54
55         // Deckstruktur dem Schiff hinzufuegen
56         public function addShipPartToShip (ConstructableShip $shipInstance, ConstructableShipPart $deckInstance) {
57                 if ((defined('DEBUG_STRUCTURE')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Das Deck <strong>%s</strong> wird f&uuml;r das Schiff <strong>%s</strong> konstruiert.<br />\n",
58                         __CLASS__,
59                         __LINE__,
60                         $deckInstance->getPartDescr(),
61                         $shipInstance->getShipName()
62                 ));
63
64                 // Eltern-Methode aufrufen
65                 parent::addShipPartToShip($shipInstance, $deckInstance);
66
67                 // Andere Daten uebertragen und von der Quelle loeschen
68                 $this->setNumDecks($deckInstance->getNumDecks());
69                 $deckInstance->removeNumDecks();
70
71                 if ((defined('DEBUG_STRUCTURE')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Das Deck <strong>%s</strong> wurde in das Schiff <strong>%s</strong> eingebaut.<br />\n",
72                         __CLASS__,
73                         __LINE__,
74                         $deckInstance->getPartDescr(),
75                         $shipInstance->getShipName()
76                 ));
77         }
78
79         // Deckanzahl entfernen
80         public function removeNumDecks() {
81                 if ((defined('DEBUG_STRUCTURE')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Anzahl Decks wurde gel&ouml;scht.<br />\n",
82                         __CLASS__,
83                         __LINE__
84                 ));
85                 unset($this->numDecks);
86         }
87
88         // Setter-Methode fuer Anzahl Decks
89         public final function setNumDecks($numDecks) {
90                 $this->numDecks = (int) $numDecks;
91         }
92
93         // Getter-Methode fuer Anzahl Decks
94         public final function getNumDecks() {
95                 return $this->numDecks;
96         }
97 }
98
99 // [EOF]
100 ?>