inc/classes/main/class_BaseFrameworkSystem.php

   1 <?php
   2 /**
   3  * The simulator system class is the super class of all other classes. This
   4  * class handles saving of games etc.
   5  *
   6  * @author              Roland Haeder <webmaster@ship-simu.org>
   7  * @version             0.3.0
   8  * @copyright   Copyright(c) 2007, 2008 Roland Haeder, this is free software
   9  * @license             GNU GPL 3.0 or any newer version
  10  * @link                http://www.mxchange.org
  11  *
  12  * This program is free software: you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation, either version 3 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  24  */
  25 class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
  26         /**
  27          * The instance to the debug output handler (should be DebugConsoleOutput or DebugWebOutput)
  28          *
  29          * @see         DebugConsoleOutput
  30          * @see         DebugWebOutput
  31          */
  32         private static $debug       = null;
  33
  34         /**
  35          * The instance to the web output handler (should be WebOutput)
  36          *
  37          * @see         WebOutput
  38          */
  39         private static $webOutput   = null;
  40
  41         /**
  42          * The instance to the compression layer which should be CompressorChannel
  43          */
  44         private static $compressor  = null;
  45
  46         /**
  47          * The configuration instance which shall be FrameworkConfiguration
  48          */
  49         private static $cfgInstance = null;
  50
  51         /**
  52          * The instance to the database layer which should be DatabaseConnection
  53          */
  54         private $dbInstance  = null;
  55
  56         /**
  57          * The real class name
  58          */
  59         private $realClass      = "FrameworkSystem";
  60
  61         /**
  62          * A human-readable description for this simulator part
  63          */
  64         private $partDescr      = "Namenlose Framework-Einheit";
  65
  66         /**
  67          * The unique ID string for identifying all type of classes
  68          */
  69         private $uniqueID = "";
  70
  71         /**
  72          * Thousands seperator
  73          */
  74         private $thousands = "."; // German
  75
  76         /**
  77          * Decimal seperator
  78          */
  79         private $decimals  = ","; // German
  80
  81         /***********************
  82          * Exception codes.... *
  83          ***********************/
  84
  85         const EXCEPTION_IS_NULL_POINTER              = 0x001;
  86         const EXCEPTION_IS_NO_OBJECT                 = 0x002;
  87         const EXCEPTION_IS_NO_ARRAY                  = 0x003;
  88         const EXCEPTION_MISSING_METHOD               = 0x004;
  89         const EXCEPTION_CLASSES_NOT_MATCHING         = 0x005;
  90         const EXCEPTION_INDEX_OUT_OF_BOUNDS          = 0x006;
  91         const EXCEPTION_DIMENSION_ARRAY_INVALID      = 0x007;
  92         const EXCEPTION_ITEM_NOT_TRADEABLE           = 0x008;
  93         const EXCEPTION_ITEM_NOT_IN_PRICE_LIST       = 0x009;
  94         const EXCEPTION_GENDER_IS_WRONG              = 0x00a;
  95         const EXCEPTION_BIRTH_DATE_IS_INVALID        = 0x00b;
  96         const EXCEPTION_EMPTY_STRUCTURES_ARRAY       = 0x00c;
  97         const EXCEPTION_HAS_ALREADY_PERSONELL_LIST   = 0x00d;
  98         const EXCEPTION_NOT_ENOUGTH_UNEMPLOYEES      = 0x00e;
  99         const EXCEPTION_TOTAL_PRICE_NOT_CALCULATED   = 0x00f;
 100         const EXCEPTION_HARBOR_HAS_NO_SHIPYARDS      = 0x010;
 101         const EXCEPTION_CONTRACT_PARTNER_INVALID     = 0x011;
 102         const EXCEPTION_CONTRACT_PARTNER_MISMATCH    = 0x012;
 103         const EXCEPTION_CONTRACT_ALREADY_SIGNED      = 0x013;
 104         const EXCEPTION_UNEXPECTED_EMPTY_STRING      = 0x014;
 105         const EXCEPTION_PATH_NOT_FOUND               = 0x015;
 106         const EXCEPTION_INVALID_PATH_NAME            = 0x016;
 107         const EXCEPTION_READ_PROTECED_PATH           = 0x017;
 108         const EXCEPTION_WRITE_PROTECED_PATH          = 0x018;
 109         const EXCEPTION_DIR_POINTER_INVALID          = 0x019;
 110         const EXCEPTION_FILE_POINTER_INVALID         = 0x01a;
 111         const EXCEPTION_INVALID_DIRECTORY_POINTER    = 0x01b;
 112         const EXCEPTION_UNEXPECTED_OBJECT            = 0x01c;
 113         const EXCEPTION_LIMIT_ELEMENT_IS_UNSUPPORTED = 0x01d;
 114         const EXCEPTION_GETTER_IS_MISSING            = 0x01e;
 115         const EXCEPTION_ARRAY_EXPECTED               = 0x01f;
 116         const EXCEPTION_ARRAY_HAS_INVALID_COUNT      = 0x020;
 117         const EXCEPTION_ID_IS_INVALID_FORMAT         = 0x021;
 118         const EXCEPTION_MD5_CHECKSUMS_MISMATCH       = 0x022;
 119         const EXCEPTION_UNEXPECTED_STRING_SIZE       = 0x023;
 120         const EXCEPTION_SIMULATOR_ID_INVALID         = 0x024;
 121         const EXCEPTION_MISMATCHING_COMPRESSORS      = 0x025;
 122         const EXCEPTION_CONTAINER_ITEM_IS_NULL       = 0x026;
 123         const EXCEPTION_ITEM_IS_NO_ARRAY             = 0x027;
 124         const EXCEPTION_CONTAINER_MAYBE_DAMAGED      = 0x028;
 125         const EXCEPTION_INVALID_STRING               = 0x029;
 126         const EXCEPTION_VARIABLE_NOT_SET             = 0x02a;
 127         const EXCEPTION_ATTRIBUTES_ARE_MISSING       = 0x02b;
 128         const EXCEPTION_ARRAY_ELEMENTS_MISSING       = 0x02c;
 129         const EXCEPTION_TEMPLATE_ENGINE_UNSUPPORTED  = 0x02d;
 130
 131         /**
 132          * In the super constructor these system classes shall be ignored or else
 133          * we would get an endless calling loop.
 134          *
 135          *--------------------------------------------------------------------*
 136          * ATTENTION: IF YOU REMOVE ONE OF THEM YOU WILL SHOOT YOUR SERVER!!! *
 137          *--------------------------------------------------------------------*
 138          */
 139         private $systemClasses = array(
 140                 "DebugMiddleware",                      // Debug middleware output sub-system
 141                 "DebugWebOutput",                       // Debug web output sub-system
 142                 "DebugConsoleOutput",           // Debug console output sub-system
 143                 "DebugErrorLogOutput",          // Debug error_log() output sub-system
 144                 "CompressorChannel",            // Compressor sub-system
 145                 "FrameworkDirectoryPointer",    // Directory handler sub-system
 146                 "NullCompressor",                       // Null compressor
 147                 "Bzip2Compressor",                      // BZIP2 compressor
 148                 "GzipCompressor",                       // GZIP compressor
 149                 "WebOutput",                            // Web output sub-system
 150         );
 151
 152         /**
 153          * Private super constructor
 154          *
 155          * @return      void
 156          */
 157         private function __construct ($class) {
 158                 // Set real class
 159                 $this->setRealClass($class);
 160         }
 161
 162         /**
 163          * Destructor reached...
 164          *
 165          * @return      void
 166          */
 167         public function __destruct() {
 168                 // Is this object already destroyed?
 169                 if ($this->__toString() != "DestructedObject") {
 170                         // Debug message
 171                         if ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
 172                                 $this->getDebugInstance()->output(sprintf("[%s:] Das Objekt <strong>%s</strong> wird zerst&ouml;rt.<br />\n",
 173                                         __CLASS__, $this->__toString()
 174                                 ));
 175                         }
 176
 177                         // Destroy all informations about this class but keep some text about it alive
 178                         $this->setPartDescr(sprintf("Entferntes Objekt <em>%s</em>", $this->__toString()));
 179                         $this->setRealClass("DestructedObject");
 180                         $this->resetUniqueID();
 181                 } elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
 182                         // Already destructed object
 183                         $this->getDebugInstance()->output(sprintf("[%s:] Das Objekt <strong>%s</strong> wurde bereits zerst&ouml;rt.<br />\n",
 184                                 __CLASS__, $this->__toString()
 185                         ));
 186                 }
 187         }
 188
 189         /**
 190          * The call method where all non-implemented methods end up
 191          *
 192          * @return      void
 193          */
 194         public final function __call ($methodName, $args) {
 195                 // Implode all given arguments
 196                 $argsString = implode("|", $args);
 197                 if (empty($argsString)) $argsString = "NULL";
 198
 199                 $this->getDebugInstance()->output(sprintf("[%s::%s] Stub! Args: %s",
 200                         $this->__toString(),
 201                         $methodName,
 202                         $argsString
 203                 ));
 204
 205                 // Return nothing
 206                 return null;
 207         }
 208
 209         /**
 210          * Public constructor (for initializing things, etc.)
 211          *
 212          * @return      void
 213          */
 214         public function constructor ($class) {
 215                 // Call constructor
 216                 $this->__construct($class);
 217
 218                 // Get the current (singleton) configuration instance
 219                 $this->setConfigInstance(FrameworkConfiguration::createFrameworkConfiguration());
 220
 221                 // Is the class weather debug nor compressor channel?
 222                 if (!in_array($class, $this->systemClasses)) {
 223                         // Initialize debug instance
 224                         if (is_null($this->getDebugInstance())) {
 225                                 // Set the debug output system if it is not debug class ;)
 226                                 $this->setDebugInstance(DebugMiddleware::createDebugMiddleware($this->getConfigInstance()->readConfig("debug_engine")));
 227                         }
 228
 229                         // Initialize web instance
 230                         if (is_null($this->getWebOutputInstance())) {
 231                                 // Generate the eval() command
 232                                 $eval = sprintf("\$this->setWebOutputInstance(%s::create%s(\"%s\"));",
 233                                         $this->getConfigInstance()->readConfig("web_engine"),
 234                                         $this->getConfigInstance()->readConfig("web_engine"),
 235                                         $this->getConfigInstance()->readConfig("web_content_type")
 236                                 );
 237
 238                                 // Debug message
 239                                 if ((defined('DEBUG_EVAL')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:] Konstruierte PHP-Anweisung: <pre><em>%s</em></pre><br />\n",
 240                                         $this->__toString(),
 241                                         htmlentities($eval)
 242                                 ));
 243
 244                                 // Run the command
 245                                 eval($eval);
 246                         }
 247
 248                         // Initialize compressor channel
 249                         if (is_null($this->getCompressorChannel())) {
 250                                 // Set the compressor channel
 251                                 $this->setCompressorChannel(CompressorChannel::createCompressorChannel(sprintf("%s%s",
 252                                         PATH,
 253                                         $this->getConfigInstance()->readConfig("compressor_base_path")
 254                                 )));
 255                         }
 256
 257                         // Initialize database middleware
 258                         if (is_null($this->getDatabaseInstance())) {
 259                                 // Get the middleware instance
 260                                 $db = DatabaseConnection::getInstance();
 261                                 if (is_object($db)) {
 262                                         // Set the database middleware
 263                                         $this->setDatabaseInstance($db);
 264                                 }
 265                         }
 266
 267                         // Debug output
 268                         if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Alle Sub-Systeme sind initialisiert.<br />\n",
 269                                 $this->__toString()
 270                         ));
 271                 }
 272         }
 273
 274         /**
 275          * Setter for language instance
 276          *
 277          * @param               $configInstance The configuration instance which shall
 278          *                                                      be FrameworkConfiguration
 279          * @return      void
 280          */
 281         public final function setConfigInstance (FrameworkConfiguration $configInstance) {
 282                 $this->cfgInstance = $configInstance;
 283                 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Konfigurations-Handler auf <strong>%s</strong> gesetzt.<br />\n",
 284                         $this->__toString(),
 285                         $configInstance->__toString()
 286                 ));
 287         }
 288
 289         /**
 290          * Getter for configuration instance
 291          *
 292          * @return      $cfhInstance - Configuration instance
 293          */
 294         public final function getConfigInstance () {
 295                 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Konfigurations-Handler <strong>%s</strong> angefordert.<br />\n",
 296                         $this->__toString(),
 297                         $this->cfgInstance->__toString()
 298                 ));
 299                 return $this->cfgInstance;
 300         }
 301
 302         /**
 303          * Setter for debug instance
 304          *
 305          * @param               $debugInstance  The instance for debug output class
 306          * @return      void
 307          */
 308         public final function setDebugInstance (DebugMiddleware $debugInstance) {
 309                 self::$debug = $debugInstance;
 310                 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Debug-Handler auf <strong>%s</strong> gesetzt.<br />\n",
 311                         $this->__toString(),
 312                         $this->getDebugInstance()->__toString()
 313                 ));
 314         }
 315
 316         /**
 317          * Getter for debug instance
 318          *
 319          * @return      $debug - Instance to class DebugConsoleOutput or DebugWebOutput
 320          */
 321         public final function getDebugInstance () {
 322                 return self::$debug;
 323         }
 324
 325         /**
 326          * Setter for web output instance
 327          *
 328          * @param               $webInstance    The instance for web output class
 329          * @return      void
 330          */
 331         public final function setWebOutputInstance (OutputStreamer $webInstance) {
 332                 self::$webOutput = $webInstance;
 333                 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Web-Handler auf <strong>%s</strong> gesetzt.<br />\n",
 334                         $this->__toString(),
 335                         $this->getWebOutputInstance()->__toString()
 336                 ));
 337         }
 338
 339         /**
 340          * Getter for web output instance
 341          *
 342          * @return      $webOutput - Instance to class WebOutput
 343          */
 344         public final function getWebOutputInstance () {
 345                 return self::$webOutput;
 346         }
 347
 348         /**
 349          * Static setter for database instance
 350          *
 351          * @param               $dbInstance     The instance for the database connection
 352          *                                      (forced DatabaseConnection)
 353          * @return      void
 354          */
 355         public final function setDatabaseInstance (DatabaseConnection $dbInstance) {
 356                 if ((defined('DEBUG_SYSTEM')) && (is_object($dbInstance->getDebugInstance()))) $dbInstance->getDebugInstance()->output(sprintf("[%s:] Datenbankschicht gesetzt.<br />\n",
 357                         $dbInstance->__toString()
 358                 ));
 359                 $this->dbInstance = $dbInstance;
 360         }
 361
 362         /**
 363          * Getter for $realClass
 364          *
 365          * @return      $realClass The name of the real class (not BaseFrameworkSystem)
 366          */
 367         public final function __toString () {
 368                 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] __toString() erreicht.<br />\n",
 369                         $this->realClass
 370                 ));
 371                 return $this->realClass;
 372         }
 373
 374         /**
 375          * Setter for the real class name
 376          *
 377          * @param               $realClass      Class name (string)
 378          * @return      void
 379          */
 380         public final function setRealClass ($realClass) {
 381                 // Cast to string
 382                 $realClass = (string) $realClass;
 383
 384                 // Set real class
 385                 $this->realClass = $realClass;
 386         }
 387
 388         /**
 389          * Generate unique ID from a lot entropy
 390          *
 391          * @return      void
 392          */
 393         public final function createUniqueID () {
 394                 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] createUniqueID aufgerufen.<br />\n",
 395                         $this->__toString()
 396                 ));
 397
 398                 // Existiert noch keine?
 399                 if (empty($this->uniqueID)) {
 400                         if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] createUniqueID erzeugt neue Unique-ID.<br />\n",
 401                                 $this->__toString()
 402                         ));
 403
 404                         // Correct missing class name
 405                         $corrected = false;
 406                         if ($this->__toString() == "") {
 407                                 $this->setRealClass(__CLASS__);
 408                                 $corrected = true;
 409                         }
 410
 411                         // Neue ID erstellen
 412                         $tempID = false;
 413                         while (true) {
 414                                 // Generate a unique ID number
 415                                 $tempID = $this->generateIdNumber();
 416                                 $isUsed = false;
 417
 418                                 // Try to figure out if the ID number is not yet used
 419                                 try {
 420                                         if (is_object($this->getDatabaseInstance())) {
 421                                                 $isUsed = $this->getDatabaseInstance()->isUniqueIdUsed($tempID, true);
 422                                         }
 423                                 } catch (FrameworkException $e) {
 424                                         // Catches all and ignores all ;-)
 425                                 }
 426
 427                                 if (
 428                                         (
 429                                                 $tempID !== false
 430                                         ) && (
 431                                                 (
 432                                                         $this->getDatabaseInstance() === null
 433                                                 ) || (
 434                                                         (
 435                                                                 is_object($this->getDatabaseInstance())
 436                                                         ) && (
 437                                                                 !$isUsed
 438                                                         )
 439                                                 )
 440                                         )
 441                                 ) {
 442                                         // Abort the loop
 443                                         break;
 444                                 }
 445                         }
 446
 447                         // Debug message
 448                         if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] uniqueID ist auf <strong>%s</strong> gesetzt.<br />\n",
 449                                 $this->__toString(),
 450                                 $tempID
 451                         ));
 452
 453                         // Apply the new ID
 454                         $this->setUniqueID($tempID);
 455
 456                         // Revert maybe corrected class name
 457                         if ($corrected) {
 458                                 $this->setRealClass("");
 459                         }
 460
 461                         // Remove system classes if we are in a system class
 462                         if ((isset($this->systemClasses)) && (in_array($this->__toString(), $this->systemClasses))) {
 463                                 // This may save some RAM...
 464                                 $this->removeSystemArray();
 465                         }
 466                 }
 467         }
 468
 469         /**
 470          * Generates a new ID number for classes based from the class' real name,
 471          * the description and some random data
 472          *
 473          * @return      $tempID The new (temporary) ID number
 474          */
 475         private final function generateIdNumber () {
 476                 return sprintf("%s@%s",
 477                         $this->__toString(),
 478                         md5(sprintf("%s:%s:%s:%s:%s:%s",
 479                                 $this->__toString(),
 480                                 $this->getPartDescr(),
 481                                 time(),
 482                                 getenv('REMOTE_ADDR'),
 483                                 getenv('SERVER_ADDR'),
 484                                 mt_rand()
 485                         ))
 486                 );
 487         }
 488
 489         /**
 490          * Setter for unique ID
 491          *
 492          * @param               $uniqueID               The newly generated unique ID number
 493          * @return      void
 494          */
 495         private final function setUniqueID ($uniqueID) {
 496                 // Cast to string
 497                 $uniqueID = (string) $uniqueID;
 498
 499                 // Debug message
 500                 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Unique-ID gesetzt auf <u>%s</u>.<br />\n",
 501                         $this->__toString(),
 502                         $uniqueID
 503                 ));
 504
 505                 // Set the ID number
 506                 $this->uniqueID = $uniqueID;
 507         }
 508
 509         /**
 510          * Getter for unique ID
 511          *
 512          * @return      $uniqueID               The unique ID of this class
 513          */
 514         public final function getUniqueID () {
 515                 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Unique-ID angefordert.<br />\n",
 516                         $this->__toString()
 517                 ));
 518                 return $this->uniqueID;
 519         }
 520
 521         /**
 522          * Resets or recreates the unique ID number
 523          *
 524          * @return      void
 525          */
 526         public final function resetUniqueID() {
 527                 // Sweet and simple... ;-)
 528                 $newUniqueID = $this->generateIdNumber();
 529                 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Unique-ID zur&uuml;ckgesetzt auf <u>%s</u>.<br />\n",
 530                         $this->__toString(),
 531                         $newUniqueID
 532                 ));
 533                 $this->setUniqueID($newUniqueID);
 534         }
 535
 536         /**
 537          * Getter for simulator description
 538          *
 539          * @return      $partDescr      The description of this simulation part
 540          */
 541         public final function getPartDescr () {
 542                 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] getPartDescr erreicht.<br />\n",
 543                         $this->__toString()
 544                 ));
 545                 if (isset($this->partDescr)) {
 546                         return $this->partDescr;
 547                 } else {
 548                         return null;
 549                 }
 550         }
 551
 552         /**
 553          * Setter for simulation part description
 554          *
 555          * @param               $partDescr      The description as string for this simulation part
 556          * @return      void
 557          */
 558         public final function setPartDescr ($partDescr) {
 559                 $this->partDescr = (String) $partDescr;
 560                 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Teilbeschreibung wird auf <strong>%s</strong> gesetzt.<br />\n",
 561                         $this->__toString(),
 562                         $this->partDescr
 563                 ));
 564         }
 565
 566         /**
 567          * Validate if given object is the same as current
 568          *
 569          * @param               $object An object instance for comparison with this class
 570          * @return      boolean The result of comparing both's unique ID
 571          */
 572         public final function equals ($object) {
 573                 return ($this->getUniqueID() == $object->getUniqueID());
 574         }
 575
 576         /**
 577          * Compare if both simulation part description and class name matches
 578          * (shall be enougth)
 579          *
 580          * @param               $itemInstance   An object instance to an other class
 581          * @return      boolean         The result of comparing class name simulation part description
 582          */
 583         public function itemMatches ($itemInstance) {
 584                 return (
 585                         (
 586                                 $this->__toString()   == $itemInstance->__toString()
 587                         ) && (
 588                                 $this->getPartDescr() == $itemInstance->getPartDescr()
 589                         )
 590                 );
 591         }
 592
 593         /**
 594          * Compare class name of this and given class name
 595          *
 596          * @param               $class  The class name as string from the other class
 597          * @return      boolean The result of comparing both class names
 598          */
 599         public final function isClass ($class) {
 600                 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] <strong>%s</strong>=<strong>%s</strong>?<br />\n",
 601                         $this->__toString(),
 602                         $this->__toString(),
 603                         $class
 604                 ));
 605                 return ($this->__toString() == $class);
 606         }
 607
 608         /**
 609          * Stub method (only real cabins shall override it)
 610          *
 611          * @return      boolean false = is no cabin, true = is a cabin
 612          */
 613         public function isCabin () {
 614                 return false;
 615         }
 616
 617         /**
 618          * Stub method for tradeable objects
 619          *
 620          * @return      boolean false = is not tradeable by the Merchant class,
 621          *                                      true  = is a tradeable object
 622          */
 623         public function isTradeable () {
 624                 return false;
 625         }
 626
 627         /**
 628          * Formats computer generated price values into human-understandable formats
 629          * with thousand and decimal seperators.
 630          *
 631          * @param               $value  The in computer format value for a price
 632          * @param               $currency       The currency symbol (use HTML-valid characters!)
 633          * @param               $decNum Number of decimals after commata
 634          * @return      $price  The for the current language formated price string
 635          * @throws      MissingDecimalsThousandsSeperatorException      If decimals or
 636          *                                                                                              thousands seperator
 637          *                                                                                              is missing
 638          */
 639         public function formatCurrency ($value, $currency = "&euro;", $decNum = 2) {
 640                 // Are all required attriutes set?
 641                 if ((!isset($this->decimals)) || (!isset($this->thousands))) {
 642                         // Throw an exception
 643                         throw new MissingDecimalsThousandsSeperatorException($this, self::EXCEPTION_ATTRIBUTES_ARE_MISSING);
 644                 }
 645
 646                 // Cast the number
 647                 $value = (float) $value;
 648                 if (defined('DEBUG_CORE') && is_object($this->getDebugInstance())) $this->getDebugInstance()->output(sprintf("[%s:] <strong>%d</strong> wird umformatiert.<br />\n",
 649                         $this->__toString(),
 650                         $value
 651                 ));
 652
 653                 // Reformat the US number
 654                 $price = sprintf("%s %s",
 655                         number_format($value, $decNum, $this->decimals, $this->thousands),
 656                         $currency
 657                 );
 658
 659                 // Return as string...
 660                 return $price;
 661         }
 662
 663         /**
 664          * Removes number formating characters
 665          *
 666          * @return      void
 667          */
 668         public final function removeNumberFormaters () {
 669                 if (defined('DEBUG_CORE') && is_object($this->getDebugInstance())) $this->getDebugInstance()->output(sprintf("[%s:] Zahlenumformatierungszeichen werden entfernt.<br />\n",
 670                         $this->__toString()
 671                 ));
 672                 unset($this->thousands);
 673                 unset($this->decimals);
 674         }
 675
 676         /**
 677          * Getter for database layer
 678          *
 679          * @return      $dbInstance     The database layer instance
 680          */
 681         public final function getDatabaseInstance () {
 682                 if (defined('DEBUG_CORE') && is_object($this->getDebugInstance())) $this->getDebugInstance()->output(sprintf("[%s:] Datenbank-Instanz <u>%s</u> angefordert.<br />\n",
 683                         $this->__toString(),
 684                         $this->dbInstance
 685                 ));
 686                 return $this->dbInstance;
 687         }
 688
 689         /**
 690          * Setter for compressor channel
 691          *
 692          * @param               $compressorChannel      An instance of CompressorChannel
 693          * @return      void
 694          */
 695         public final function setCompressorChannel (CompressorChannel $compressorChannel) {
 696                 self::$compressor = $compressorChannel;
 697         }
 698
 699         /**
 700          * Getter for compressor channel
 701          *
 702          * @return      $compressor     The compressor channel
 703          */
 704         public final function getCompressorChannel () {
 705                 return self::$compressor;
 706         }
 707
 708         /**
 709          * Remove the $systemClasses array from memory
 710          *
 711          * @return      void
 712          */
 713         public final function removeSystemArray () {
 714                 unset($this->systemClasses);
 715         }
 716
 717         /**
 718          * Create a file name and path name from the object's unique ID number.
 719          * The left part of the ID shall always be a valid class name and the
 720          * right part an ID number.
 721          *
 722          * @return      $pfn            The file name with a prepended path name
 723          * @throws      NoArrayCreatedException If explode() fails to create an array
 724          * @throws      InvalidArrayCountException      If the array contains less or
 725          *                                                                      more than two elements
 726          */
 727         public final function getPathFileNameFromObject () {
 728                 // Get the main object's unique ID. We use this as a path/filename combination
 729                 $pathFile = $this->getUniqueID();
 730
 731                 // Split it up in path and file name
 732                 $pathFile = explode("@", $pathFile);
 733
 734                 // Are there two elements? Index 0 is the path, 1 the file name + global extension
 735                 if (!is_array($pathFile)) {
 736                         // No array found
 737                         throw new NoArrayCreatedException(array($this, "pathFile"), self::EXCEPTION_ARRAY_EXPECTED);
 738                 } elseif (count($pathFile) != 2) {
 739                         // Invalid ID returned!
 740                         throw new InvalidArrayCountException(array($this, "pathFile", count($pathFile), 2), self::EXCEPTION_ARRAY_HAS_INVALID_COUNT);
 741                 }
 742
 743                 // Auto-append missing trailing slash
 744                 $pathFile[0] = $this->addMissingTrailingSlash($pathFile[0]);
 745
 746                 // Create the file name and return it
 747                 $pfn = ($pathFile[0] . $pathFile[1]);
 748                 return $pfn;
 749         }
 750
 751         /**
 752          * Appends a trailing slash to a string
 753          *
 754          * @param               $str            A string (maybe) without trailing slash
 755          * @return      $str            A string with an auto-appended trailing slash
 756          */
 757         public final function addMissingTrailingSlash ($str) {
 758                 // Is there a trailing slash?
 759                 if (substr($str, -1, 1) != "/") $str .= "/";
 760                 return $str;
 761         }
 762 }
 763
 764 // [EOF]
 765 ?>