code comments including license information added, type hints added, minor rewrites...
[shipsimu.git] / application / ship-simu / main / structures / extended / cabines / class_BaseCabin.php
1 <?php
2 /**
3  * A general cabin 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 BaseCabin extends BaseCabinStructure {
25         // Konstruktor
26         private function __construct ($class) {
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("Kabine");
40         }
41
42         /**
43          * Calls the private constructor
44          *
45          * @param       $class  The class' name
46          * @return      void
47          */
48         public function constructor ($class) {
49                 $this->__construct($class);
50         }
51
52         // Is this a cabin?
53         public final function isCabin () {
54                 return ($this->isSameClass("BaseCabin"));
55         }
56
57         /**
58          * Stub!
59          */
60         public function saveObjectToDatabase () {
61                 $this->getDebugInstance()->output(sprintf("[%s:] Stub <strong>%s</strong> erreicht.",
62                         $this->__toString(),
63                         __FUNCTION__
64                 ));
65         }
66
67         /**
68          * Limits this object with an ObjectLimits instance
69          */
70         public function limitObject (ObjectLimits $limitInstance) {
71                 ApplicationEntryPoint::app_die("".__METHOD__." reached! Stub!");
72         }
73 }
74
75 // [EOF]
76 ?>