3 * A class for merchants which can trade items
5 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
24 class Merchant extends BaseFrameworkSystem {
26 private $merchantName = "Namenloser Händler";
28 // Preislite (Objekte wiedermal!)
29 private $priceList = null;
32 private $harborInstance = null;
35 protected function __construct () {
36 // Call parent constructor
37 parent::__construct(__CLASS__);
40 $this->setObjectDescription("Händler");
42 // Generate unique ID number
43 $this->createUniqueID();
46 $this->removeSystemArray();
49 // Haendler mit Namen erzeugen
50 public final static function createMerchant ($merchantName, Harbor $harborInstance) {
52 $merchantName = (string) $merchantName;
55 $merchantInstance = new Merchant();
58 if ((defined('DEBUG_MERCHANT')) || (defined('DEBUG_ALL'))) {
59 $merchantInstance->getDebugInstance()->output(sprintf("[%s:%d] Ein Händler <strong>%s</strong> wird angelegt und soll sich am <strong>%s</strong> niederlassen.<br />\n",
63 $harborInstance->getHarborName()
67 // Haendlernamen setzen
68 $merchantInstance->setMerchantName($merchantName);
70 // In dem angegebenen Hafen den Haendler ansiedeln
71 $merchantInstance->setHarborInstance($harborInstance);
73 // Preisliste initialisieren
74 $merchantInstance->createPriceList();
76 // Instanz zurueckliefern
77 return $merchantInstance;
80 // Initialize pricing list
81 private function createPriceList () {
82 if ((defined('DEBUG_MERCHANT')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Der Händler <strong>%s</strong> erhält eine leere Preisliste.<br />\n",
85 $this->getMerchantName()
87 $this->priceList = new FrameworkArrayObject();
90 // Setter for merchant name
91 public final function setMerchantName ($merchantName) {
93 $merchantName = (string) $merchantName;
96 if ((defined('DEBUG_MERCHANT')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Der Händlername <strong>%s</strong> ist nun bekannt.<br />\n",
101 $this->merchantName = $merchantName;
104 // Getter for merchant name
105 public final function getMerchantName () {
106 if ((defined('DEBUG_MERCHANT')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Der Händlername <strong>%s</strong> wird verlangt.<br />\n",
111 return $this->merchantName;
114 // Setter for harbor instance
115 public final function setHarborInstance (Harbor $harborInstance) {
116 if ((defined('DEBUG_MERCHANT')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Der Händler <strong>%s</strong> lässt sich am <strong>%s</strong> nieder.<br />\n",
119 $this->getMerchantName(),
120 $harborInstance->getHarborName()
122 $this->harborInstance = $harborInstance;
125 // Getter for harbor instance
126 public final function getHarborInstance () {
127 if ((defined('DEBUG_MERCHANT')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Der Händler <strong>%s</strong> hat sich am <strong>%s</strong> niedergelassen.<br />\n",
130 $this->getMerchantName(),
131 $harborInstance->getHarborName()
133 return $this->harborInstance;
136 // Add new item to merchant's price list
137 public function addItemToPriceList (TradeableItem $itemInstance, $price) {
139 $price = (float) $price;
142 if ((defined('DEBUG_MERCHANT')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:%d] Der Händler <strong>%s</strong> kann nun das Schiffsteil <strong>%s</strong> "<strong>%s</strong>" zu <strong>%s</strong> verkaufen.<br />\n",
145 $this->getMerchantName(),
146 $itemInstance->__toString(),
147 $itemInstance->getObjectDescription(),
148 $this->formatCurrency($price)
151 // Construct pricing item and add it to the list
152 $this->priceList->append(array(
153 'item' => $itemInstance,
157 // Remove price attribute
158 $itemInstance->removePrice();
161 // Get a price from the merchant's list
162 public final function getPriceFromList (TradeableItem $itemInstance) {
165 // Iterate throw whole list
166 for ($iter = $this->priceList->getIterator(); $iter->valid(); $iter->next()) {
168 $item = $iter->current();
170 // Does this item match? The unique ID may not work...
171 if ($item['item']->itemMatches($itemInstance)) {
172 // Extract price and stop searching
173 $price = $item['price'];
178 // Was the item found?
181 throw new ItemNotInPriceListException($itemInstance, self::EXCEPTION_ITEM_NOT_IN_PRICE_LIST);
191 public function saveObjectToDatabase () {
192 $this->getDebugInstance()->output(sprintf("[%s:] Stub <strong>%s</strong> erreicht.",