More renamed
[shipsimu.git] / application / ship-simu / main / class_Merchant.php
1 <?php
2 /**
3  * A class for merchants which can trade items
4  *
5  * @author              Roland Haeder <webmaster@shipsimu.org>
6  * @version             0.0.0
7  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 Ship-Simu Developer Team
8  * @license             GNU GPL 3.0 or any newer version
9  * @link                http://www.shipsimu.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 Merchant extends BaseFrameworkSystem {
25         // Name des Haendlers
26         private $merchantName   = "Namenloser H&auml;ndler";
27
28         // Preislite (Objekte wiedermal!)
29         private $priceList      = null;
30
31         // Zugewiesener Hafen
32         private $harborInstance = null;
33
34         // Konstruktor
35         protected function __construct () {
36                 // Call parent constructor
37                 parent::__construct(__CLASS__);
38         }
39
40         // Haendler mit Namen erzeugen
41         public static final function createMerchant ($merchantName, Harbor $harborInstance) {
42                 // String absichern
43                 $merchantName = (string) $merchantName;
44
45                 // Get new instance
46                 $merchantInstance = new Merchant();
47
48                 // Debug message
49                 if ((defined('DEBUG_MERCHANT')) || (defined('DEBUG_ALL'))) {
50                         $merchantInstance->debugOutput(sprintf("[%s:%d] Ein H&auml;ndler <strong>%s</strong> wird angelegt und soll sich am <strong>%s</strong> niederlassen.",
51                                 __CLASS__,
52                                 __LINE__,
53                                 $merchantName,
54                                 $harborInstance->getHarborName()
55                         ));
56                 }
57
58                 // Haendlernamen setzen
59                 $merchantInstance->setMerchantName($merchantName);
60
61                 // In dem angegebenen Hafen den Haendler ansiedeln
62                 $merchantInstance->setHarborInstance($harborInstance);
63
64                 // Preisliste initialisieren
65                 $merchantInstance->createPriceList();
66
67                 // Instanz zurueckliefern
68                 return $merchantInstance;
69         }
70
71         // Initialize pricing list
72         private function createPriceList () {
73                 $this->priceList = new FrameworkArrayObject("FakedPriceList");
74         }
75
76         // Setter for merchant name
77         public final function setMerchantName ($merchantName) {
78                 // Debug message
79                 $this->merchantName = (string) $merchantName;
80         }
81
82         // Getter for merchant name
83         public final function getMerchantName () {
84                 return $this->merchantName;
85         }
86
87         // Setter for harbor instance
88         public final function setHarborInstance (Harbor $harborInstance) {
89                 $this->harborInstance = $harborInstance;
90         }
91
92         // Getter for harbor instance
93         public final function getHarborInstance () {
94                 return $this->harborInstance;
95         }
96
97         // Add new item to merchant's price list
98         public function addItemToPriceList (TradeableItem $itemInstance, $price) {
99                 $this->makeDeprecated();
100         }
101
102         // Get a price from the merchant's list
103         public final function getPriceFromList (TradeableItem $itemInstance) {
104                 $this->makeDeprecated();
105         }
106 }
107
108 // [EOF]
109 ?>