code comments including license information added, type hints added, minor rewrites...
[shipsimu.git] / application / ship-simu / main / parts / class_BaseShipPart.php
1 <?php
2 /**
3  * This is a general ship part which can be used for all other ship parts...
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 BaseShipPart extends BaseSimulator {
25         // Price of this ship part
26         private $price = 0.00;
27
28         // Konstruktor
29         private function __construct($class) {
30                 // Call parent constructor
31                 parent::constructor($class);
32
33                 // Debug message
34                 if (((defined('DEBUG_SHIPPART')) || (defined('DEBUG_ALL'))) && (defined('DEBUG_CONSTRUCT'))) {
35                         $this->getDebugInstance()->output(sprintf("[%s:%d:] Kontruktor erreicht.<br />\n",
36                                 __CLASS__,
37                                 __LINE__
38                         ));
39                 }
40
41                 // Beschreibung
42                 $this->setPartDescr("Schiffsteil");
43
44                 // Clean up a little
45                 $this->removeNumberFormaters();
46         }
47
48         /**
49          * Calls the private constructor
50          *
51          * @param       $class  The class' name
52          * @return      void
53          */
54         public function constructor ($class) {
55                 $this->__construct($class);
56         }
57
58         // Setter for price
59         public final function setPrice ($price) {
60                 $this->price = (float) $price;
61         }
62
63         // Getter for price
64         public final function getPrice () {
65                 return $this->price;
66         }
67
68         // Remove price
69         public function removePrice () {
70                 unset($this->price);
71         }
72 }
73
74 // [EOF]
75 ?>