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.0.0
   8  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2011 Core Developer Team
   9  * @license             GNU GPL 3.0 or any newer version
  10  * @link                http://www.ship-simu.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          * Instance of a request class
  28          */
  29         private $requestInstance = NULL;
  30
  31         /**
  32          * Instance of a response class
  33          */
  34         private $responseInstance = NULL;
  35
  36         /**
  37          * Search criteria instance
  38          */
  39         private $searchInstance = NULL;
  40
  41         /**
  42          * Update criteria instance
  43          */
  44         private $updateInstance = NULL;
  45
  46         /**
  47          * The file I/O instance for the template loader
  48          */
  49         private $fileIoInstance = NULL;
  50
  51         /**
  52          * Resolver instance
  53          */
  54         private $resolverInstance = NULL;
  55
  56         /**
  57          * Template engine instance
  58          */
  59         private $templateInstance = NULL;
  60
  61         /**
  62          * Database result instance
  63          */
  64         private $resultInstance = NULL;
  65
  66         /**
  67          * Instance for user class
  68          */
  69         private $userInstance = NULL;
  70
  71         /**
  72          * A controller instance
  73          */
  74         private $controllerInstance = NULL;
  75
  76         /**
  77          * Instance of a RNG
  78          */
  79         private $rngInstance = NULL;
  80
  81         /**
  82          * Instance of a crypto helper
  83          */
  84         private $cryptoInstance = NULL;
  85
  86         /**
  87          * Instance of an Iterator class
  88          */
  89         private $iteratorInstance = NULL;
  90
  91         /**
  92          * Instance of the list
  93          */
  94         private $listInstance = NULL;
  95
  96         /**
  97          * Instance of a menu
  98          */
  99         private $menuInstance = NULL;
 100
 101         /**
 102          * Instance of the image
 103          */
 104         private $imageInstance = NULL;
 105
 106         /**
 107          * Instance of the stacker
 108          */
 109         private $stackerInstance = NULL;
 110
 111         /**
 112          * A Compressor instance
 113          */
 114         private $compressorInstance = NULL;
 115
 116         /**
 117          * A Parseable instance
 118          */
 119         private $parserInstance = NULL;
 120
 121         /**
 122          * A ProtocolHandler instance
 123          */
 124         private $protocolInstance = NULL;
 125
 126         /**
 127          * A database wrapper instance
 128          */
 129         private $databaseInstance = NULL;
 130
 131         /**
 132          * A helper instance for the form
 133          */
 134         private $helperInstance = NULL;
 135
 136         /**
 137          * An instance of a Sourceable class
 138          */
 139         private $sourceInstance = NULL;
 140
 141         /**
 142          * An instance of a InputStreamable class
 143          */
 144         private $inputStreamInstance = NULL;
 145
 146         /**
 147          * An instance of a OutputStreamable class
 148          */
 149         private $outputStreamInstance = NULL;
 150
 151         /**
 152          * Networkable handler instance
 153          */
 154         private $handlerInstance = NULL;
 155
 156         /**
 157          * Visitor handler instance
 158          */
 159         private $visitorInstance = NULL;
 160
 161         /**
 162          * The real class name
 163          */
 164         private $realClass = 'BaseFrameworkSystem';
 165
 166         /**
 167          * An instance of a database wrapper class
 168          */
 169         private $wrapperInstance = NULL;
 170
 171         /**
 172          * Thousands seperator
 173          */
 174         private $thousands = '.'; // German
 175
 176         /**
 177          * Decimal seperator
 178          */
 179         private $decimals  = ','; // German
 180
 181         /**
 182          * Socket resource
 183          */
 184         private $socketResource = false;
 185
 186         /**
 187          * Package data
 188          */
 189         private $packageData = array();
 190
 191         /***********************
 192          * Exception codes.... *
 193          ***********************/
 194
 195         // @todo Try to clean these constants up
 196         const EXCEPTION_IS_NULL_POINTER              = 0x001;
 197         const EXCEPTION_IS_NO_OBJECT                 = 0x002;
 198         const EXCEPTION_IS_NO_ARRAY                  = 0x003;
 199         const EXCEPTION_MISSING_METHOD               = 0x004;
 200         const EXCEPTION_CLASSES_NOT_MATCHING         = 0x005;
 201         const EXCEPTION_INDEX_OUT_OF_BOUNDS          = 0x006;
 202         const EXCEPTION_DIMENSION_ARRAY_INVALID      = 0x007;
 203         const EXCEPTION_ITEM_NOT_TRADEABLE           = 0x008;
 204         const EXCEPTION_ITEM_NOT_IN_PRICE_LIST       = 0x009;
 205         const EXCEPTION_GENDER_IS_WRONG              = 0x00a;
 206         const EXCEPTION_BIRTH_DATE_IS_INVALID        = 0x00b;
 207         const EXCEPTION_EMPTY_STRUCTURES_ARRAY       = 0x00c;
 208         const EXCEPTION_HAS_ALREADY_PERSONELL_LIST   = 0x00d;
 209         const EXCEPTION_NOT_ENOUGTH_UNEMPLOYEES      = 0x00e;
 210         const EXCEPTION_TOTAL_PRICE_NOT_CALCULATED   = 0x00f;
 211         const EXCEPTION_HARBOR_HAS_NO_SHIPYARDS      = 0x010;
 212         const EXCEPTION_CONTRACT_PARTNER_INVALID     = 0x011;
 213         const EXCEPTION_CONTRACT_PARTNER_MISMATCH    = 0x012;
 214         const EXCEPTION_CONTRACT_ALREADY_SIGNED      = 0x013;
 215         const EXCEPTION_UNEXPECTED_EMPTY_STRING      = 0x014;
 216         const EXCEPTION_PATH_NOT_FOUND               = 0x015;
 217         const EXCEPTION_INVALID_PATH_NAME            = 0x016;
 218         const EXCEPTION_READ_PROTECED_PATH           = 0x017;
 219         const EXCEPTION_WRITE_PROTECED_PATH          = 0x018;
 220         const EXCEPTION_DIR_POINTER_INVALID          = 0x019;
 221         const EXCEPTION_FILE_POINTER_INVALID         = 0x01a;
 222         const EXCEPTION_INVALID_RESOURCE             = 0x01b;
 223         const EXCEPTION_UNEXPECTED_OBJECT            = 0x01c;
 224         const EXCEPTION_LIMIT_ELEMENT_IS_UNSUPPORTED = 0x01d;
 225         const EXCEPTION_GETTER_IS_MISSING            = 0x01e;
 226         const EXCEPTION_ARRAY_EXPECTED               = 0x01f;
 227         const EXCEPTION_ARRAY_HAS_INVALID_COUNT      = 0x020;
 228         const EXCEPTION_ID_IS_INVALID_FORMAT         = 0x021;
 229         const EXCEPTION_MD5_CHECKSUMS_MISMATCH       = 0x022;
 230         const EXCEPTION_UNEXPECTED_STRING_SIZE       = 0x023;
 231         const EXCEPTION_SIMULATOR_ID_INVALID         = 0x024;
 232         const EXCEPTION_MISMATCHING_COMPRESSORS      = 0x025;
 233         const EXCEPTION_CONTAINER_ITEM_IS_NULL       = 0x026;
 234         const EXCEPTION_ITEM_IS_NO_ARRAY             = 0x027;
 235         const EXCEPTION_CONTAINER_MAYBE_DAMAGED      = 0x028;
 236         const EXCEPTION_INVALID_STRING               = 0x029;
 237         const EXCEPTION_VARIABLE_NOT_SET             = 0x02a;
 238         const EXCEPTION_ATTRIBUTES_ARE_MISSING       = 0x02b;
 239         const EXCEPTION_ARRAY_ELEMENTS_MISSING       = 0x02c;
 240         const EXCEPTION_TEMPLATE_ENGINE_UNSUPPORTED  = 0x02d;
 241         const EXCEPTION_UNSPPORTED_OPERATION         = 0x02e;
 242         const EXCEPTION_MISSING_ELEMENT              = 0x030;
 243         const EXCEPTION_HEADERS_ALREADY_SENT         = 0x031;
 244         const EXCEPTION_DEFAULT_CONTROLLER_GONE      = 0x032;
 245         const EXCEPTION_CLASS_NOT_FOUND              = 0x033;
 246         const EXCEPTION_REQUIRED_INTERFACE_MISSING   = 0x034;
 247         const EXCEPTION_FATAL_ERROR                  = 0x035;
 248         const EXCEPTION_FILE_NOT_FOUND               = 0x036;
 249         const EXCEPTION_ASSERTION_FAILED             = 0x037;
 250         const EXCEPTION_FILE_CANNOT_BE_READ          = 0x038;
 251         const EXCEPTION_DATABASE_UPDATED_NOT_ALLOWED = 0x039;
 252         const EXCEPTION_FILTER_CHAIN_INTERCEPTED     = 0x040;
 253
 254         /**
 255          * Hexadecimal->Decimal translation array
 256          */
 257         private static $hexdec = array(
 258                 '0' => 0,
 259                 '1' => 1,
 260                 '2' => 2,
 261                 '3' => 3,
 262                 '4' => 4,
 263                 '5' => 5,
 264                 '6' => 6,
 265                 '7' => 7,
 266                 '8' => 8,
 267                 '9' => 9,
 268                 'a' => 10,
 269                 'b' => 11,
 270                 'c' => 12,
 271                 'd' => 13,
 272                 'e' => 14,
 273                 'f' => 15
 274         );
 275
 276         /**
 277          * Decimal->hexadecimal translation array
 278          */
 279         private static $dechex = array(
 280                  0 => '0',
 281                  1 => '1',
 282                  2 => '2',
 283                  3 => '3',
 284                  4 => '4',
 285                  5 => '5',
 286                  6 => '6',
 287                  7 => '7',
 288                  8 => '8',
 289                  9 => '9',
 290                 10 => 'a',
 291                 11 => 'b',
 292                 12 => 'c',
 293                 13 => 'd',
 294                 14 => 'e',
 295                 15 => 'f'
 296         );
 297
 298         /**
 299          * Startup time in miliseconds
 300          */
 301         private static $startupTime = 0;
 302
 303         /**
 304          * Protected super constructor
 305          *
 306          * @param       $className      Name of the class
 307          * @return      void
 308          */
 309         protected function __construct ($className) {
 310                 // Set real class
 311                 $this->setRealClass($className);
 312
 313                 // Set configuration instance if no registry ...
 314                 if (!$this instanceof Register) {
 315                         // ... because registries doesn't need to be configured
 316                         $this->setConfigInstance(FrameworkConfiguration::getSelfInstance());
 317                 } // END - if
 318
 319                 // Is the startup time set? (0 cannot be true anymore)
 320                 if (self::$startupTime == 0) {
 321                         // Then set it
 322                         self::$startupTime = microtime(true);
 323                 } // END - if
 324         }
 325
 326         /**
 327          * Destructor for all classes
 328          *
 329          * @return      void
 330          */
 331         public function __destruct() {
 332                 // Flush any updated entries to the database
 333                 $this->flushPendingUpdates();
 334
 335                 // Is this object already destroyed?
 336                 if ($this->__toString() != 'DestructedObject') {
 337                         // Destroy all informations about this class but keep some text about it alive
 338                         $this->setRealClass('DestructedObject');
 339                 } elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
 340                         // Already destructed object
 341                         $this->debugOutput(sprintf("[%s:] The object <span class=\"object_name\">%s</span> is already destroyed.",
 342                                 __CLASS__,
 343                                 $this->__toString()
 344                         ));
 345                 }
 346         }
 347
 348         /**
 349          * The __call() method where all non-implemented methods end up
 350          *
 351          * @param       $methodName             Name of the missing method
 352          * @args        $args                   Arguments passed to the method
 353          * @return      void
 354          */
 355         public final function __call ($methodName, $args) {
 356                 // Implode all given arguments
 357                 $argsString = '';
 358                 if (empty($args)) {
 359                         // No arguments
 360                         $argsString = 'NULL';
 361                 } elseif (is_array($args)) {
 362                         // Some arguments are there
 363                         foreach ($args as $arg) {
 364                                 // Add the type
 365                                 $argsString .= $this->replaceControlCharacters($arg) . ' (' . gettype($arg);
 366
 367                                 if (is_string($arg)) {
 368                                         // Add length for strings
 369                                         $argsString .= ', '.strlen($arg);
 370                                 } elseif (is_array($arg)) {
 371                                         // .. or size if array
 372                                         $argsString .= ', '.count($arg);
 373                                 } elseif ($arg === true) {
 374                                         // ... is boolean 'true'
 375                                         $argsString .= ', true';
 376                                 } elseif ($arg === false) {
 377                                         // ... is boolean 'true'
 378                                         $argsString .= ', false';
 379                                 }
 380
 381                                 // Closing bracket
 382                                 $argsString .= '), ';
 383                         } // END - foreach
 384
 385                         // Remove last comma
 386                         if (substr($argsString, -2, 1) == ',') {
 387                                 $argsString = substr($argsString, 0, -2);
 388                         } // END - if
 389                 } else {
 390                         // Invalid arguments!
 391                         $argsString = '!INVALID:' . gettype($args) . '!';
 392                 }
 393
 394                 // Output stub message
 395                 $this->debugOutput(sprintf("[%s-&gt;%s] Stub! Args: %s",
 396                         $this->__toString(),
 397                         $methodName,
 398                         $argsString
 399                 ));
 400
 401                 // Return nothing
 402                 return null;
 403         }
 404
 405         /**
 406          * Getter for $realClass
 407          *
 408          * @return      $realClass The name of the real class (not BaseFrameworkSystem)
 409          */
 410         public function __toString () {
 411                 return $this->realClass;
 412         }
 413
 414         /**
 415          * Magic function to catch setting of missing but set class fields/attributes
 416          *
 417          * @param       $name   Name of the field/attribute
 418          * @param       $value  Value to store
 419          * @return      void
 420          */
 421         public final function __set ($name, $value) {
 422                 $this->debugBackTrace(sprintf("Tried to set a missing field. name=%s, value[%s]=%s",
 423                         $name,
 424                         gettype($value),
 425                         $value
 426                 ));
 427         }
 428
 429         /**
 430          * Magic function to catch getting of missing fields/attributes
 431          *
 432          * @param       $name   Name of the field/attribute
 433          * @return      void
 434          */
 435         public final function __get ($name) {
 436                 $this->debugBackTrace(sprintf("Tried to get a missing field. name=%s",
 437                         $name
 438                 ));
 439         }
 440
 441         /**
 442          * Magic function to catch unsetting of missing fields/attributes
 443          *
 444          * @param       $name   Name of the field/attribute
 445          * @return      void
 446          */
 447         public final function __unset ($name) {
 448                 $this->debugBackTrace(sprintf("Tried to unset a missing field. name=%s",
 449                         $name
 450                 ));
 451         }
 452
 453         /**
 454          * Setter for database result instance
 455          *
 456          * @param       $resultInstance         An instance of a database result class
 457          * @return      void
 458          * @todo        SearchableResult and UpdateableResult shall have a super interface to use here
 459          */
 460         protected final function setResultInstance (SearchableResult $resultInstance) {
 461                 $this->resultInstance =  $resultInstance;
 462         }
 463
 464         /**
 465          * Getter for database result instance
 466          *
 467          * @return      $resultInstance         An instance of a database result class
 468          */
 469         public final function getResultInstance () {
 470                 return $this->resultInstance;
 471         }
 472
 473         /**
 474          * Setter for template engine instances
 475          *
 476          * @param       $templateInstance       An instance of a template engine class
 477          * @return      void
 478          */
 479         protected final function setTemplateInstance (CompileableTemplate $templateInstance) {
 480                 $this->templateInstance = $templateInstance;
 481         }
 482
 483         /**
 484          * Getter for template engine instances
 485          *
 486          * @return      $templateInstance       An instance of a template engine class
 487          */
 488         protected final function getTemplateInstance () {
 489                 return $this->templateInstance;
 490         }
 491
 492         /**
 493          * Setter for search instance
 494          *
 495          * @param       $searchInstance         Searchable criteria instance
 496          * @return      void
 497          */
 498         public final function setSearchInstance (LocalSearchCriteria $searchInstance) {
 499                 $this->searchInstance = $searchInstance;
 500         }
 501
 502         /**
 503          * Getter for search instance
 504          *
 505          * @return      $searchInstance         Searchable criteria instance
 506          */
 507         public final function getSearchInstance () {
 508                 return $this->searchInstance;
 509         }
 510
 511         /**
 512          * Setter for update instance
 513          *
 514          * @param       $updateInstance         Searchable criteria instance
 515          * @return      void
 516          */
 517         public final function setUpdateInstance (LocalUpdateCriteria $updateInstance) {
 518                 $this->updateInstance = $updateInstance;
 519         }
 520
 521         /**
 522          * Getter for update instance
 523          *
 524          * @return      $updateInstance         Updateable criteria instance
 525          */
 526         public final function getUpdateInstance () {
 527                 return $this->updateInstance;
 528         }
 529
 530         /**
 531          * Setter for resolver instance
 532          *
 533          * @param       $resolverInstance       Instance of a command resolver class
 534          * @return      void
 535          */
 536         public final function setResolverInstance (Resolver $resolverInstance) {
 537                 $this->resolverInstance = $resolverInstance;
 538         }
 539
 540         /**
 541          * Getter for resolver instance
 542          *
 543          * @return      $resolverInstance       Instance of a command resolver class
 544          */
 545         public final function getResolverInstance () {
 546                 return $this->resolverInstance;
 547         }
 548
 549         /**
 550          * Setter for language instance
 551          *
 552          * @param       $configInstance         The configuration instance which shall
 553          *                                                              be FrameworkConfiguration
 554          * @return      void
 555          */
 556         public final function setConfigInstance (FrameworkConfiguration $configInstance) {
 557                 Registry::getRegistry()->addInstance('config', $configInstance);
 558         }
 559
 560         /**
 561          * Getter for configuration instance
 562          *
 563          * @return      $configInstance         Configuration instance
 564          */
 565         public final function getConfigInstance () {
 566                 $configInstance = Registry::getRegistry()->getInstance('config');
 567                 return $configInstance;
 568         }
 569
 570         /**
 571          * Setter for debug instance
 572          *
 573          * @param       $debugInstance  The instance for debug output class
 574          * @return      void
 575          */
 576         public final function setDebugInstance (DebugMiddleware $debugInstance) {
 577                 Registry::getRegistry()->addInstance('debug', $debugInstance);
 578         }
 579
 580         /**
 581          * Getter for debug instance
 582          *
 583          * @return      $debugInstance  Instance to class DebugConsoleOutput or DebugWebOutput
 584          */
 585         public final function getDebugInstance () {
 586                 // Get debug instance
 587                 $debugInstance = Registry::getRegistry()->getInstance('debug');
 588
 589                 // Return it
 590                 return $debugInstance;
 591         }
 592
 593         /**
 594          * Setter for web output instance
 595          *
 596          * @param               $webInstance    The instance for web output class
 597          * @return      void
 598          */
 599         public final function setWebOutputInstance (OutputStreamer $webInstance) {
 600                 Registry::getRegistry()->addInstance('web_output', $webInstance);
 601         }
 602
 603         /**
 604          * Getter for web output instance
 605          *
 606          * @return      $webOutputInstance - Instance to class WebOutput
 607          */
 608         public final function getWebOutputInstance () {
 609                 $webOutputInstance = Registry::getRegistry()->getInstance('web_output');
 610                 return $webOutputInstance;
 611         }
 612
 613         /**
 614          * Setter for database instance
 615          *
 616          * @param               $databaseInstance       The instance for the database connection (forced DatabaseConnection)
 617          * @return      void
 618          */
 619         public final function setDatabaseInstance (DatabaseConnection $databaseInstance) {
 620                 Registry::getRegistry()->addInstance('db_instance', $databaseInstance);
 621         }
 622
 623         /**
 624          * Getter for database layer
 625          *
 626          * @return      $databaseInstance       The database layer instance
 627          */
 628         public final function getDatabaseInstance () {
 629                 // Get instance
 630                 $databaseInstance = Registry::getRegistry()->getInstance('db_instance');
 631
 632                 // Return instance
 633                 return $databaseInstance;
 634         }
 635
 636         /**
 637          * Setter for compressor channel
 638          *
 639          * @param               $compressorInstance             An instance of CompressorChannel
 640          * @return      void
 641          */
 642         public final function setCompressorChannel (CompressorChannel $compressorInstance) {
 643                 Registry::getRegistry()->addInstance('compressor', $compressorInstance);
 644         }
 645
 646         /**
 647          * Getter for compressor channel
 648          *
 649          * @return      $compressorInstance             The compressor channel
 650          */
 651         public final function getCompressorChannel () {
 652                 $compressorInstance = Registry::getRegistry()->getInstance('compressor');
 653                 return $compressorInstance;
 654         }
 655
 656         /**
 657          * Protected getter for a manageable application helper class
 658          *
 659          * @return      $applicationInstance    An instance of a manageable application helper class
 660          */
 661         protected final function getApplicationInstance () {
 662                 $applicationInstance = Registry::getRegistry()->getInstance('application');
 663                 return $applicationInstance;
 664         }
 665
 666         /**
 667          * Setter for a manageable application helper class
 668          *
 669          * @param       $applicationInstance    An instance of a manageable application helper class
 670          * @return      void
 671          */
 672         public final function setApplicationInstance (ManageableApplication $applicationInstance) {
 673                 Registry::getRegistry()->addInstance('application', $applicationInstance);
 674         }
 675
 676         /**
 677          * Setter for request instance
 678          *
 679          * @param       $requestInstance        An instance of a Requestable class
 680          * @return      void
 681          */
 682         public final function setRequestInstance (Requestable $requestInstance) {
 683                 $this->requestInstance = $requestInstance;
 684         }
 685
 686         /**
 687          * Getter for request instance
 688          *
 689          * @return      $requestInstance        An instance of a Requestable class
 690          */
 691         public final function getRequestInstance () {
 692                 return $this->requestInstance;
 693         }
 694
 695         /**
 696          * Setter for response instance
 697          *
 698          * @param       $responseInstance       An instance of a Responseable class
 699          * @return      void
 700          */
 701         public final function setResponseInstance (Responseable $responseInstance) {
 702                 $this->responseInstance = $responseInstance;
 703         }
 704
 705         /**
 706          * Getter for response instance
 707          *
 708          * @return      $responseInstance       An instance of a Responseable class
 709          */
 710         public final function getResponseInstance () {
 711                 return $this->responseInstance;
 712         }
 713
 714         /**
 715          * Setter for the real class name
 716          *
 717          * @param               $realClass      Class name (string)
 718          * @return      void
 719          */
 720         public final function setRealClass ($realClass) {
 721                 // Cast to string
 722                 $realClass = (string) $realClass;
 723
 724                 // Set real class
 725                 $this->realClass = $realClass;
 726         }
 727
 728         /**
 729          * Checks wether an object equals this object. You should overwrite this
 730          * method to implement own equality checks
 731          *
 732          * @param       $objectInstance         An instance of a FrameworkInterface object
 733          * @return      $equals                         Wether both objects equals
 734          */
 735         public function equals (FrameworkInterface $objectInstance) {
 736                 // Now test it
 737                 $equals = ((
 738                         $this->__toString() == $objectInstance->__toString()
 739                 ) && (
 740                         $this->hashCode() == $objectInstance->hashCode()
 741                 ));
 742
 743                 // Return the result
 744                 return $equals;
 745         }
 746
 747         /**
 748          * Generates a generic hash code of this class. You should really overwrite
 749          * this method with your own hash code generator code. But keep KISS in mind.
 750          *
 751          * @return      $hashCode       A generic hash code respresenting this whole class
 752          */
 753         public function hashCode () {
 754                 // Simple hash code
 755                 return crc32($this->__toString());
 756         }
 757
 758         /**
 759          * Formats computer generated price values into human-understandable formats
 760          * with thousand and decimal seperators.
 761          *
 762          * @param       $value          The in computer format value for a price
 763          * @param       $currency       The currency symbol (use HTML-valid characters!)
 764          * @param       $decNum         Number of decimals after commata
 765          * @return      $price          The for the current language formated price string
 766          * @throws      MissingDecimalsThousandsSeperatorException      If decimals or
 767          *                                                                                              thousands seperator
 768          *                                                                                              is missing
 769          */
 770         public function formatCurrency ($value, $currency = '&euro;', $decNum = 2) {
 771                 // Are all required attriutes set?
 772                 if ((!isset($this->decimals)) || (!isset($this->thousands))) {
 773                         // Throw an exception
 774                         throw new MissingDecimalsThousandsSeperatorException($this, self::EXCEPTION_ATTRIBUTES_ARE_MISSING);
 775                 } // END - if
 776
 777                 // Cast the number
 778                 $value = (float) $value;
 779
 780                 // Reformat the US number
 781                 $price = number_format($value, $decNum, $this->decimals, $this->thousands) . $currency;
 782
 783                 // Return as string...
 784                 return $price;
 785         }
 786
 787         /**
 788          * Private getter for language instance
 789          *
 790          * @return      $langInstance   An instance to the language sub-system
 791          */
 792         protected final function getLanguageInstance () {
 793                 $langInstance = Registry::getRegistry()->getInstance('language');
 794                 return $langInstance;
 795         }
 796
 797         /**
 798          * Setter for language instance
 799          *
 800          * @param       $langInstance   An instance to the language sub-system
 801          * @return      void
 802          * @see         LanguageSystem
 803          */
 804         public final function setLanguageInstance (ManageableLanguage $langInstance) {
 805                 Registry::getRegistry()->addInstance('language', $langInstance);
 806         }
 807
 808         /**
 809          * Appends a trailing slash to a string
 810          *
 811          * @param       $str            A string (maybe) without trailing slash
 812          * @return      $str            A string with an auto-appended trailing slash
 813          */
 814         public final function addMissingTrailingSlash ($str) {
 815                 // Is there a trailing slash?
 816                 if (substr($str, -1, 1) != '/') {
 817                         $str .= '/';
 818                 } // END - if
 819
 820                 // Return string with trailing slash
 821                 return $str;
 822         }
 823
 824         /**
 825          * Private getter for file IO instance
 826          *
 827          * @return      $fileIoInstance An instance to the file I/O sub-system
 828          */
 829         protected final function getFileIoInstance () {
 830                 return $this->fileIoInstance;
 831         }
 832
 833         /**
 834          * Setter for file I/O instance
 835          *
 836          * @param       $fileIoInstance An instance to the file I/O sub-system
 837          * @return      void
 838          */
 839         public final function setFileIoInstance (FileIoHandler $fileIoInstance) {
 840                 $this->fileIoInstance = $fileIoInstance;
 841         }
 842
 843         /**
 844          * Prepare the template engine (WebTemplateEngine by default) for a given
 845          * application helper instance (ApplicationHelper by default).
 846          *
 847          * @param               $applicationInstance    An application helper instance or
 848          *                                                                              null if we shall use the default
 849          * @return              $templateInstance               The template engine instance
 850          * @throws              NullPointerException    If the discovered application
 851          *                                                                              instance is still null
 852          */
 853         protected function prepareTemplateInstance (ManageableApplication $applicationInstance = NULL) {
 854                 // Is the application instance set?
 855                 if (is_null($applicationInstance)) {
 856                         // Get the current instance
 857                         $applicationInstance = $this->getApplicationInstance();
 858
 859                         // Still null?
 860                         if (is_null($applicationInstance)) {
 861                                 // Thrown an exception
 862                                 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
 863                         } // END - if
 864                 } // END - if
 865
 866                 // Initialize the template engine
 867                 $templateInstance = ObjectFactory::createObjectByConfiguredName('web_template_class');
 868
 869                 // Return the prepared instance
 870                 return $templateInstance;
 871         }
 872
 873         /**
 874          * Debugs this instance by putting out it's full content
 875          *
 876          * @param       $message        Optional message to show in debug output
 877          * @return      void
 878          */
 879         public final function debugInstance ($message = '') {
 880                 // Restore the error handler to avoid trouble with missing array elements or undeclared variables
 881                 restore_error_handler();
 882
 883                 // Init content
 884                 $content = '';
 885
 886                 // Is a message set?
 887                 if (!empty($message)) {
 888                         // Construct message
 889                         $content = sprintf("<div class=\"debug_message\">Message: %s</div>\n", $message);
 890                 } // END - if
 891
 892                 // Generate the output
 893                 $content .= sprintf("<pre>%s</pre>",
 894                         trim(
 895                                 htmlentities(
 896                                         print_r($this, true)
 897                                 )
 898                         )
 899                 );
 900
 901                 // Output it
 902                 ApplicationEntryPoint::app_die(sprintf("<div class=\"debug_header\">%s debug output:</div><div class=\"debug_content\">%s</div>\nLoaded includes: <div class=\"debug_include_list\">%s</div>",
 903                         $this->__toString(),
 904                         $content,
 905                         ClassLoader::getSelfInstance()->getPrintableIncludeList()
 906                 ));
 907         }
 908
 909         /**
 910          * Replaces control characters with printable output
 911          *
 912          * @param       $str    String with control characters
 913          * @return      $str    Replaced string
 914          */
 915         protected function replaceControlCharacters ($str) {
 916                 // Replace them
 917                 $str = str_replace(
 918                         chr(13), '[r]', str_replace(
 919                         chr(10), '[n]', str_replace(
 920                         chr(9) , '[t]',
 921                         $str
 922                 )));
 923
 924                 // Return it
 925                 return $str;
 926         }
 927
 928         /**
 929          * Output a partial stub message for the caller method
 930          *
 931          * @param       $message        An optional message to display
 932          * @return      void
 933          */
 934         protected function partialStub ($message = '') {
 935                 // Get the backtrace
 936                 $backtrace = debug_backtrace();
 937
 938                 // Generate the class::method string
 939                 $methodName = 'UnknownClass-&gt;unknownMethod';
 940                 if ((isset($backtrace[1]['class'])) && (isset($backtrace[1]['function']))) {
 941                         $methodName = $backtrace[1]['class'] . '-&gt;' . $backtrace[1]['function'];
 942                 } // END - if
 943
 944                 // Construct the full message
 945                 $stubMessage = sprintf("[%s:] Partial stub!",
 946                         $methodName
 947                 );
 948
 949                 // Is the extra message given?
 950                 if (!empty($message)) {
 951                         // Then add it as well
 952                         $stubMessage .= sprintf(" Message: <span id=\"stub_message\">%s</span>", $message);
 953                 } // END - if
 954
 955                 // Debug instance is there?
 956                 if (!is_null($this->getDebugInstance())) {
 957                         // Output stub message
 958                         $this->debugOutput($stubMessage);
 959                 } else {
 960                         // Trigger an error
 961                         trigger_error($stubMessage . "<br />\n");
 962                 }
 963         }
 964
 965         /**
 966          * Outputs a debug backtrace and stops further script execution
 967          *
 968          * @param       $message        An optional message to output
 969          * @return      void
 970          */
 971         public function debugBackTrace ($message = '') {
 972                 // Sorry, there is no other way getting this nice backtrace
 973                 if (!empty($message)) {
 974                         // Output message
 975                         printf("Message: %s<br />\n", $message);
 976                 } // END - if
 977
 978                 print("<pre>\n");
 979                 debug_print_backtrace();
 980                 print("</pre>");
 981                 exit();
 982         }
 983
 984         /**
 985          * Outputs a debug message wether to debug instance (should be set!) or dies with or pints the message
 986          *
 987          * @param       $message        Message we shall send out...
 988          * @param       $doPrint        Wether we shall print or die here which first is the default
 989          * @return      void
 990          */
 991         public function debugOutput ($message, $doPrint = true) {
 992                 // Get debug instance
 993                 $debugInstance = $this->getDebugInstance();
 994
 995                 // Is the debug instance there?
 996                 if (is_object($debugInstance)) {
 997                         // Use debug output handler
 998                         $debugInstance->output($message);
 999
1000                         if ($doPrint === false) {
1001                                 // Die here if not printed
1002                                 die();
1003                         } // END - if
1004                 } else {
1005                         // Put directly out
1006                         if ($doPrint === true) {
1007                                 // Are debug times enabled?
1008                                 if ($this->getConfigInstance()->getConfigEntry('debug_output_timings') == 'Y') {
1009                                         // Output it first
1010                                         print($this->getPrintableExecutionTime());
1011                                 } // END - if
1012
1013                                 // Print message
1014                                 print($message . chr(10));
1015                         } else {
1016                                 // DO NOT REWRITE THIS TO app_die() !!!
1017                                 die($message);
1018                         }
1019                 }
1020         }
1021
1022         /**
1023          * Converts e.g. a command from URL to a valid class by keeping out bad characters
1024          *
1025          * @param       $str            The string, what ever it is needs to be converted
1026          * @return      $className      Generated class name
1027          */
1028         public function convertToClassName ($str) {
1029                 // Init class name
1030                 $className = '';
1031
1032                 // Convert all dashes in underscores
1033                 $str = $this->convertDashesToUnderscores($str);
1034
1035                 // Now use that underscores to get classname parts for hungarian style
1036                 foreach (explode('_', $str) as $strPart) {
1037                         // Make the class name part lower case and first upper case
1038                         $className .= ucfirst(strtolower($strPart));
1039                 } // END - foreach
1040
1041                 // Return class name
1042                 return $className;
1043         }
1044
1045         /**
1046          * Converts dashes to underscores, e.g. useable for configuration entries
1047          *
1048          * @param       $str    The string with maybe dashes inside
1049          * @return      $str    The converted string with no dashed, but underscores
1050          */
1051         public final function convertDashesToUnderscores ($str) {
1052                 // Convert them all
1053                 $str = str_replace('-', '_', $str);
1054
1055                 // Return converted string
1056                 return $str;
1057         }
1058
1059         /**
1060          * Marks up the code by adding e.g. line numbers
1061          *
1062          * @param       $phpCode                Unmarked PHP code
1063          * @return      $markedCode             Marked PHP code
1064          */
1065         public function markupCode ($phpCode) {
1066                 // Init marked code
1067                 $markedCode = '';
1068
1069                 // Get last error
1070                 $errorArray = error_get_last();
1071
1072                 // Init the code with error message
1073                 if (is_array($errorArray)) {
1074                         // Get error infos
1075                         $markedCode = sprintf("<div id=\"error_header\">File: <span id=\"error_data\">%s</span>, Line: <span id=\"error_data\">%s</span>, Message: <span id=\"error_data\">%s</span>, Type: <span id=\"error_data\">%s</span></div>",
1076                                 basename($errorArray['file']),
1077                                 $errorArray['line'],
1078                                 $errorArray['message'],
1079                                 $errorArray['type']
1080                         );
1081                 } // END - if
1082
1083                 // Add line number to the code
1084                 foreach (explode(chr(10), $phpCode) as $lineNo => $code) {
1085                         // Add line numbers
1086                         $markedCode .= sprintf("<span id=\"code_line\">%s</span>: %s\n",
1087                                 ($lineNo + 1),
1088                                 htmlentities($code, ENT_QUOTES)
1089                         );
1090                 } // END - foreach
1091
1092                 // Return the code
1093                 return $markedCode;
1094         }
1095
1096         /**
1097          * Filter a given GMT timestamp (non Uni* stamp!) to make it look more
1098          * beatiful for web-based front-ends. If null is given a message id
1099          * null_timestamp will be resolved and returned.
1100          *
1101          * @param       $timestamp      Timestamp to prepare (filter) for display
1102          * @return      $readable       A readable timestamp
1103          */
1104         public function doFilterFormatTimestamp ($timestamp) {
1105                 // Default value to return
1106                 $readable = '???';
1107
1108                 // Is the timestamp null?
1109                 if (is_null($timestamp)) {
1110                         // Get a message string
1111                         $readable = $this->getLanguageInstance()->getMessage('null_timestamp');
1112                 } else {
1113                         switch ($this->getLanguageInstance()->getLanguageCode()) {
1114                                 case 'de': // German format is a bit different to default
1115                                         // Split the GMT stamp up
1116                                         $dateTime  = explode(' ', $timestamp  );
1117                                         $dateArray = explode('-', $dateTime[0]);
1118                                         $timeArray = explode(':', $dateTime[1]);
1119
1120                                         // Construct the timestamp
1121                                         $readable = sprintf($this->getConfigInstance()->getConfigEntry('german_date_time'),
1122                                                 $dateArray[0],
1123                                                 $dateArray[1],
1124                                                 $dateArray[2],
1125                                                 $timeArray[0],
1126                                                 $timeArray[1],
1127                                                 $timeArray[2]
1128                                         );
1129                                         break;
1130
1131                                 default: // Default is pass-through
1132                                         $readable = $timestamp;
1133                                         break;
1134                         } // END - switch
1135                 }
1136
1137                 // Return the stamp
1138                 return $readable;
1139         }
1140
1141         /**
1142          * Filter a given number into a localized number
1143          *
1144          * @param       $value          The raw value from e.g. database
1145          * @return      $localized      Localized value
1146          */
1147         public function doFilterFormatNumber ($value) {
1148                 // Generate it from config and localize dependencies
1149                 switch ($this->getLanguageInstance()->getLanguageCode()) {
1150                         case 'de': // German format is a bit different to default
1151                                 $localized = number_format($value, $this->getConfigInstance()->getConfigEntry('decimals'), ',', '.');
1152                                 break;
1153
1154                         default: // US, etc.
1155                                 $localized = number_format($value, $this->getConfigInstance()->getConfigEntry('decimals'), '.', ',');
1156                                 break;
1157                 } // END - switch
1158
1159                 // Return it
1160                 return $localized;
1161         }
1162
1163         /**
1164          * "Getter" for databse entry
1165          *
1166          * @return      $entry  An array with database entries
1167          * @throws      NullPointerException    If the database result is not found
1168          * @throws      InvalidDatabaseResultException  If the database result is invalid
1169          */
1170         protected final function getDatabaseEntry () {
1171                 // Is there an instance?
1172                 if (is_null($this->getResultInstance())) {
1173                         // Throw an exception here
1174                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
1175                 } // END - if
1176
1177                 // Rewind it
1178                 $this->getResultInstance()->rewind();
1179
1180                 // Do we have an entry?
1181                 if ($this->getResultInstance()->valid() === false) {
1182                         throw new InvalidDatabaseResultException(array($this, $this->getResultInstance()), DatabaseResult::EXCEPTION_INVALID_DATABASE_RESULT);
1183                 } // END - if
1184
1185                 // Get next entry
1186                 $this->getResultInstance()->next();
1187
1188                 // Fetch it
1189                 $entry = $this->getResultInstance()->current();
1190
1191                 // And return it
1192                 return $entry;
1193         }
1194
1195         /**
1196          * Getter for field name
1197          *
1198          * @param       $fieldName              Field name which we shall get
1199          * @return      $fieldValue             Field value from the user
1200          * @throws      NullPointerException    If the result instance is null
1201          */
1202         public final function getField ($fieldName) {
1203                 // Default field value
1204                 $fieldValue = NULL;
1205
1206                 // Get result instance
1207                 $resultInstance = $this->getResultInstance();
1208
1209                 // Is this instance null?
1210                 if (is_null($resultInstance)) {
1211                         // Then the user instance is no longer valid (expired cookies?)
1212                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
1213                 } // END - if
1214
1215                 // Get current array
1216                 $fieldArray = $resultInstance->current();
1217                 //* DEBUG: */ $this->debugOutput($fieldName.':<pre>'.print_r($fieldArray, true).'</pre>');
1218
1219                 // Does the field exist?
1220                 if (isset($fieldArray[$fieldName])) {
1221                         // Get it
1222                         $fieldValue = $fieldArray[$fieldName];
1223                 } // END - if
1224
1225                 // Return it
1226                 return $fieldValue;
1227         }
1228
1229         /**
1230          * Protected setter for user instance
1231          *
1232          * @param       $userInstance   An instance of a user class
1233          * @return      void
1234          */
1235         protected final function setUserInstance (ManageableAccount $userInstance) {
1236                 $this->userInstance = $userInstance;
1237         }
1238
1239         /**
1240          * Getter for user instance
1241          *
1242          * @return      $userInstance   An instance of a user class
1243          */
1244         public final function getUserInstance () {
1245                 return $this->userInstance;
1246         }
1247
1248         /**
1249          * Setter for controller instance (this surely breaks a bit the MVC patterm)
1250          *
1251          * @param       $controllerInstance             An instance of the controller
1252          * @return      void
1253          */
1254         public final function setControllerInstance (Controller $controllerInstance) {
1255                 $this->controllerInstance = $controllerInstance;
1256         }
1257
1258         /**
1259          * Getter for controller instance (this surely breaks a bit the MVC patterm)
1260          *
1261          * @return      $controllerInstance             An instance of the controller
1262          */
1263         public final function getControllerInstance () {
1264                 return $this->controllerInstance;
1265         }
1266
1267         /**
1268          * Flushs all pending updates to the database layer
1269          *
1270          * @return      void
1271          */
1272         public function flushPendingUpdates () {
1273                 // Get result instance
1274                 $resultInstance = $this->getResultInstance();
1275
1276                 // Do we have data to update?
1277                 if ((is_object($resultInstance)) && ($resultInstance->ifDataNeedsFlush())) {
1278                         // Get wrapper class name config entry
1279                         $configEntry = $resultInstance->getUpdateInstance()->getWrapperConfigEntry();
1280
1281                         // Create object instance
1282                         $wrapperInstance = ObjectFactory::createObjectByConfiguredName($configEntry);
1283
1284                         // Yes, then send the whole result to the database layer
1285                         $wrapperInstance->doUpdateByResult($this->getResultInstance());
1286                 } // END - if
1287         }
1288
1289         /**
1290          * Outputs a deprecation warning to the developer.
1291          *
1292          * @param       $message        The message we shall output to the developer
1293          * @return      void
1294          * @todo        Write a logging mechanism for productive mode
1295          */
1296         public function deprecationWarning ($message) {
1297                 // Is developer mode active?
1298                 if (defined('DEVELOPER')) {
1299                         // Debug instance is there?
1300                         if (!is_null($this->getDebugInstance())) {
1301                                 // Output stub message
1302                                 $this->debugOutput($message);
1303                         } else {
1304                                 // Trigger an error
1305                                 trigger_error($message . "<br />\n");
1306                         }
1307                 } else {
1308                         // @TODO Finish this part!
1309                         $this->partialStub('Developer mode inactive. Message:' . $message);
1310                 }
1311         }
1312
1313         /**
1314          * Checks wether the given PHP extension is loaded
1315          *
1316          * @param       $phpExtension   The PHP extension we shall check
1317          * @return      $isLoaded       Wether the PHP extension is loaded
1318          */
1319         public final function isPhpExtensionLoaded ($phpExtension) {
1320                 // Is it loaded?
1321                 $isLoaded = in_array($phpExtension, get_loaded_extensions());
1322
1323                 // Return result
1324                 return $isLoaded;
1325         }
1326
1327         /**
1328          * Setter for RNG instance
1329          *
1330          * @param       $rngInstance    An instance of a random number generator (RNG)
1331          * @return      void
1332          */
1333         protected final function setRngInstance (RandomNumberGenerator $rngInstance) {
1334                 $this->rngInstance = $rngInstance;
1335         }
1336
1337         /**
1338          * Getter for RNG instance
1339          *
1340          * @return      $rngInstance    An instance of a random number generator (RNG)
1341          */
1342         public final function getRngInstance () {
1343                 return $this->rngInstance;
1344         }
1345
1346         /**
1347          * Setter for Cryptable instance
1348          *
1349          * @param       $cryptoInstance An instance of a Cryptable class
1350          * @return      void
1351          */
1352         protected final function setCryptoInstance (Cryptable $cryptoInstance) {
1353                 $this->cryptoInstance = $cryptoInstance;
1354         }
1355
1356         /**
1357          * Getter for Cryptable instance
1358          *
1359          * @return      $cryptoInstance An instance of a Cryptable class
1360          */
1361         public final function getCryptoInstance () {
1362                 return $this->cryptoInstance;
1363         }
1364
1365         /**
1366          * Setter for Iterator instance
1367          *
1368          * @param       $iteratorInstance       An instance of an Iterator
1369          * @return      void
1370          */
1371         protected final function setIteratorInstance (Iterator $iteratorInstance) {
1372                 $this->iteratorInstance = $iteratorInstance;
1373         }
1374
1375         /**
1376          * Getter for Iterator instance
1377          *
1378          * @return      $iteratorInstance       An instance of an Iterator
1379          */
1380         public final function getIteratorInstance () {
1381                 return $this->iteratorInstance;
1382         }
1383
1384         /**
1385          * "Getter" as a time() replacement but with milliseconds. You should use this
1386          * method instead of the encapsulated getimeofday() function.
1387          *
1388          * @return      $milliTime      Timestamp with milliseconds
1389          */
1390         public function getMilliTime () {
1391                 // Get the time of day as float
1392                 $milliTime = gettimeofday(true);
1393
1394                 // Return it
1395                 return $milliTime;
1396         }
1397
1398         /**
1399          * Idles (sleeps) for given milliseconds
1400          *
1401          * @return      $hasSlept       Wether it goes fine
1402          */
1403         public function idle ($milliSeconds) {
1404                 // Sleep is fine by default
1405                 $hasSlept = true;
1406
1407                 // Idle so long with found function
1408                 if (function_exists('time_sleep_until')) {
1409                         // Get current time and add idle time
1410                         $sleepUntil = $this->getMilliTime() + abs($milliSeconds) / 1000;
1411
1412                         // New PHP 5.1.0 function found, ignore errors
1413                         $hasSlept = @time_sleep_until($sleepUntil);
1414                 } else {
1415                         // My Sun Station doesn't have that function even with latest PHP
1416                         // package. :(
1417                         usleep($milliSeconds * 1000);
1418                 }
1419
1420                 // Return result
1421                 return $hasSlept;
1422         }
1423
1424         /**
1425          * Setter for the list instance
1426          *
1427          * @param       $listInstance   A list of Listable
1428          * @return      void
1429          */
1430         protected final function setListInstance (Listable $listInstance) {
1431                 $this->listInstance = $listInstance;
1432         }
1433
1434         /**
1435          * Getter for the list instance
1436          *
1437          * @return      $listInstance   A list of Listable
1438          */
1439         protected final function getListInstance () {
1440                 return $this->listInstance;
1441         }
1442
1443         /**
1444          * Setter for the menu instance
1445          *
1446          * @param       $menuInstance   A RenderableMenu instance
1447          * @return      void
1448          */
1449         protected final function setMenuInstance (RenderableMenu $menuInstance) {
1450                 $this->menuInstance = $menuInstance;
1451         }
1452
1453         /**
1454          * Getter for the menu instance
1455          *
1456          * @return      $menuInstance   A RenderableMenu instance
1457          */
1458         protected final function getMenuInstance () {
1459                 return $this->menuInstance;
1460         }
1461
1462         /**
1463          * Setter for image instance
1464          *
1465          * @param       $imageInstance  An instance of an image
1466          * @return      void
1467          */
1468         public final function setImageInstance (BaseImage $imageInstance) {
1469                 $this->imageInstance = $imageInstance;
1470         }
1471
1472         /**
1473          * Getter for image instance
1474          *
1475          * @return      $imageInstance  An instance of an image
1476          */
1477         public final function getImageInstance () {
1478                 return $this->imageInstance;
1479         }
1480
1481         /**
1482          * Setter for stacker instance
1483          *
1484          * @param       $stackerInstance        An instance of an stacker
1485          * @return      void
1486          */
1487         public final function setStackerInstance (Stackable $stackerInstance) {
1488                 $this->stackerInstance = $stackerInstance;
1489         }
1490
1491         /**
1492          * Getter for stacker instance
1493          *
1494          * @return      $stackerInstance        An instance of an stacker
1495          */
1496         public final function getStackerInstance () {
1497                 return $this->stackerInstance;
1498         }
1499
1500         /**
1501          * Setter for compressor instance
1502          *
1503          * @param       $compressorInstance     An instance of an compressor
1504          * @return      void
1505          */
1506         public final function setCompressorInstance (Compressor $compressorInstance) {
1507                 $this->compressorInstance = $compressorInstance;
1508         }
1509
1510         /**
1511          * Getter for compressor instance
1512          *
1513          * @return      $compressorInstance     An instance of an compressor
1514          */
1515         public final function getCompressorInstance () {
1516                 return $this->compressorInstance;
1517         }
1518
1519         /**
1520          * Setter for Parseable instance
1521          *
1522          * @param       $parserInstance An instance of an Parseable
1523          * @return      void
1524          */
1525         public final function setParserInstance (Parseable $parserInstance) {
1526                 $this->parserInstance = $parserInstance;
1527         }
1528
1529         /**
1530          * Getter for Parseable instance
1531          *
1532          * @return      $parserInstance An instance of an Parseable
1533          */
1534         public final function getParserInstance () {
1535                 return $this->parserInstance;
1536         }
1537
1538         /**
1539          * Setter for ProtocolHandler instance
1540          *
1541          * @param       $protocolInstance       An instance of an ProtocolHandler
1542          * @return      void
1543          */
1544         public final function setProtocolInstance (ProtocolHandler $protocolInstance = NULL) {
1545                 $this->protocolInstance = $protocolInstance;
1546         }
1547
1548         /**
1549          * Getter for ProtocolHandler instance
1550          *
1551          * @return      $protocolInstance       An instance of an ProtocolHandler
1552          */
1553         public final function getProtocolInstance () {
1554                 return $this->protocolInstance;
1555         }
1556
1557         /**
1558          * Setter for BaseDatabaseWrapper instance
1559          *
1560          * @param       $wrapperInstance        An instance of an BaseDatabaseWrapper
1561          * @return      void
1562          */
1563         public final function setWrapperInstance (BaseDatabaseWrapper $wrapperInstance) {
1564                 $this->wrapperInstance = $wrapperInstance;
1565         }
1566
1567         /**
1568          * Getter for BaseDatabaseWrapper instance
1569          *
1570          * @return      $wrapperInstance        An instance of an BaseDatabaseWrapper
1571          */
1572         public final function getWrapperInstance () {
1573                 return $this->wrapperInstance;
1574         }
1575
1576         /**
1577          * Setter for socket resource
1578          *
1579          * @param       $socketResource         A valid socket resource
1580          * @return      void
1581          */
1582         public final function setSocketResource ($socketResource) {
1583                 $this->socketResource = $socketResource;
1584         }
1585
1586         /**
1587          * Getter for socket resource
1588          *
1589          * @return      $socketResource         A valid socket resource
1590          */
1591         public function getSocketResource () {
1592                 return $this->socketResource;
1593         }
1594
1595         /**
1596          * Setter for helper instance
1597          *
1598          * @param       $helperInstance         An instance of a helper class
1599          * @return      void
1600          */
1601         protected final function setHelperInstance (Helper $helperInstance) {
1602                 $this->helperInstance = $helperInstance;
1603         }
1604
1605         /**
1606          * Getter for helper instance
1607          *
1608          * @return      $helperInstance         An instance of a helper class
1609          */
1610         public final function getHelperInstance () {
1611                 return $this->helperInstance;
1612         }
1613
1614         /**
1615          * Setter for a Sourceable instance
1616          *
1617          * @param       $sourceInstance The Sourceable instance
1618          * @return      void
1619          */
1620         protected final function setSourceInstance (Sourceable $sourceInstance) {
1621                 $this->sourceInstance = $sourceInstance;
1622         }
1623
1624         /**
1625          * Getter for a Sourceable instance
1626          *
1627          * @return      $sourceInstance The Sourceable instance
1628          */
1629         protected final function getSourceInstance () {
1630                 return $this->sourceInstance;
1631         }
1632
1633         /**
1634          * Getter for a InputStreamable instance
1635          *
1636          * @param       $inputStreamInstance    The InputStreamable instance
1637          */
1638         protected final function getInputStreamInstance () {
1639                 return $this->inputStreamInstance;
1640         }
1641
1642         /**
1643          * Setter for a InputStreamable instance
1644          *
1645          * @param       $inputStreamInstance    The InputStreamable instance
1646          * @return      void
1647          */
1648         protected final function setInputStreamInstance (InputStreamable $inputStreamInstance) {
1649                 $this->inputStreamInstance = $inputStreamInstance;
1650         }
1651
1652         /**
1653          * Getter for a OutputStreamable instance
1654          *
1655          * @param       $outputStreamInstance   The OutputStreamable instance
1656          */
1657         protected final function getOutputStreamInstance () {
1658                 return $this->outputStreamInstance;
1659         }
1660
1661         /**
1662          * Setter for a OutputStreamable instance
1663          *
1664          * @param       $outputStreamInstance   The OutputStreamable instance
1665          * @return      void
1666          */
1667         protected final function setOutputStreamInstance (OutputStreamable $outputStreamInstance) {
1668                 $this->outputStreamInstance = $outputStreamInstance;
1669         }
1670
1671         /**
1672          * Setter for handler instance
1673          *
1674          * @param       $handlerInstance        A Networkable instance
1675          * @return      void
1676          */
1677         protected final function setHandlerInstance (Networkable $handlerInstance) {
1678                 $this->handlerInstance = $handlerInstance;
1679         }
1680
1681         /**
1682          * Getter for handler instance
1683          *
1684          * @return      $handlerInstance        A Networkable instance
1685          */
1686         protected final function getHandlerInstance () {
1687                 return $this->handlerInstance;
1688         }
1689
1690         /**
1691          * Setter for visitor instance
1692          *
1693          * @param       $visitorInstance        A Visitor instance
1694          * @return      void
1695          */
1696         protected final function setVisitorInstance (Visitor $visitorInstance) {
1697                 $this->visitorInstance = $visitorInstance;
1698         }
1699
1700         /**
1701          * Getter for visitor instance
1702          *
1703          * @return      $visitorInstance        A Visitor instance
1704          */
1705         protected final function getVisitorInstance () {
1706                 return $this->visitorInstance;
1707         }
1708
1709         /**
1710          * Setter for raw package Data
1711          *
1712          * @param       $packageData    Raw package Data
1713          * @return      void
1714          */
1715         public final function setPackageData (array $packageData) {
1716                 $this->packageData = $packageData;
1717         }
1718
1719         /**
1720          * Getter for raw package Data
1721          *
1722          * @return      $packageData    Raw package Data
1723          */
1724         public function getPackageData () {
1725                 return $this->packageData;
1726         }
1727
1728         /**
1729          * Converts a hexadecimal string, even with negative sign as first string to
1730          * a decimal number using BC functions.
1731          *
1732          * This work is based on comment #86673 on php.net documentation page at:
1733          * <http://de.php.net/manual/en/function.dechex.php#86673>
1734          *
1735          * @param       $hex    Hexadecimal string
1736          * @return      $dec    Decimal number
1737          */
1738         protected function hex2dec ($hex) {
1739                 // Convert to all lower-case
1740                 $hex = strtolower($hex);
1741
1742                 // Detect sign (negative/positive numbers)
1743                 $sign = '';
1744                 if (substr($hex, 0, 1) == '-') {
1745                         $sign = '-';
1746                         $hex = substr($hex, 1);
1747                 } // END - if
1748
1749                 // Decode the hexadecimal string into a decimal number
1750                 $dec = 0;
1751                 for ($i = strlen($hex) - 1, $e = 1; $i >= 0; $i--, $e = bcmul($e, 16)) {
1752                         $factor = self::$hexdec[substr($hex, $i, 1)];
1753                         $dec = bcadd($dec, bcmul($factor, $e));
1754                 } // END - for
1755
1756                 // Return the decimal number
1757                 return $sign . $dec;
1758         }
1759
1760         /**
1761          * Converts even very large decimal numbers, also with negative sign, to a
1762          * hexadecimal string.
1763          *
1764          * This work is based on comment #97756 on php.net documentation page at:
1765          * <http://de.php.net/manual/en/function.hexdec.php#97756>
1766          *
1767          * @param       $dec            Decimal number, even with negative sign
1768          * @param       $maxLength      Optional maximum length of the string
1769          * @return      $hex    Hexadecimal string
1770          */
1771         protected function dec2hex ($dec, $maxLength = 0) {
1772                 // maxLength can be zero or devideable by 2
1773                 assert(($maxLength == 0) || (($maxLength % 2) == 0));
1774
1775                 // Detect sign (negative/positive numbers)
1776                 $sign = '';
1777                 if ($dec < 0) {
1778                         $sign = '-';
1779                         $dec = abs($dec);
1780                 } // END - if
1781
1782                 // Encode the decimal number into a hexadecimal string
1783                 $hex = '';
1784                 do {
1785                         $hex = self::$dechex[($dec % 16)] . $hex;
1786                         $dec /= 16;
1787                 } while ($dec >= 1);
1788
1789                 /*
1790                  * We need hexadecimal strings with leading zeros if the length cannot
1791                  * be divided by 2
1792                  */
1793                 if ($maxLength > 0) {
1794                         // Prepend more zeros
1795                         $hex = $this->prependStringToString($hex, '0', $maxLength);
1796                 } elseif ((strlen($hex) % 2) != 0) {
1797                         $hex = '0' . $hex;
1798                 }
1799
1800                 // Return the hexadecimal string
1801                 return $sign . $hex;
1802         }
1803
1804         /**
1805          * Converts a ASCII string (0 to 255) into a decimal number.
1806          *
1807          * @param       $asc    The ASCII string to be converted
1808          * @return      $dec    Decimal number
1809          */
1810         protected function asc2dec ($asc) {
1811                 // Convert it into a hexadecimal number
1812                 $hex = bin2hex($asc);
1813
1814                 // And back into a decimal number
1815                 $dec = $this->hex2dec($hex);
1816
1817                 // Return it
1818                 return $dec;
1819         }
1820
1821         /**
1822          * Converts a decimal number into an ASCII string.
1823          *
1824          * @param       $dec            Decimal number
1825          * @return      $asc    An ASCII string
1826          */
1827         protected function dec2asc ($dec) {
1828                 // First convert the number into a hexadecimal string
1829                 $hex = $this->dec2hex($dec);
1830
1831                 // Then convert it into the ASCII string
1832                 $asc = $this->hex2asc($hex);
1833
1834                 // Return it
1835                 return $asc;
1836         }
1837
1838         /**
1839          * Converts a hexadecimal number into an ASCII string. Negative numbers
1840          * are not allowed.
1841          *
1842          * @param       $hex    Hexadecimal string
1843          * @return      $asc    An ASCII string
1844          */
1845         protected function hex2asc ($hex) {
1846                 // Check for length, it must be devideable by 2
1847                 //* DEBUG: */ $this->debugOutput('hex='.$hex);
1848                 assert((strlen($hex) % 2) == 0);
1849
1850                 // Walk the string
1851                 $asc = '';
1852                 for ($idx = 0; $idx < strlen($hex); $idx+=2) {
1853                         // Get the decimal number of the chunk
1854                         $part = hexdec(substr($hex, $idx, 2));
1855
1856                         // Add it to the final string
1857                         $asc .= chr($part);
1858                 } // END - for
1859
1860                 // Return the final string
1861                 return $asc;
1862         }
1863
1864         /**
1865          * Prepends a given string $prepend to $str with a given total length
1866          *
1867          * @param       $str            Given original string which should be prepended
1868          * @param       $prepend        The string to prepend
1869          * @param       $length         Total length of the final string
1870          * @return      $strFinal       Final prepended string
1871          */
1872         protected function prependStringToString ($str, $prepend, $length) {
1873                 // Set final string to original string by default
1874                 $strFinal = $str;
1875
1876                 // Can it devided
1877                 if (strlen($str) < $length) {
1878                         // Difference between total length and length of original string
1879                         $diff = $length - strlen($str);
1880
1881                         // Prepend the string
1882                         $prepend = str_repeat($prepend, ($diff / strlen($prepend) + 1));
1883
1884                         // Make sure it will definedly fit
1885                         assert(strlen($prepend) >= $diff);
1886
1887                         // Cut it a little down
1888                         $prepend = substr($prepend, 0, $diff);
1889                         //* DEBUG: */ $this->debugOutput('prepend('.strlen($prepend).')='.$prepend.',diff='.$diff.',length='.$length);
1890
1891                         // Construct the final prepended string
1892                         $strFinal = $prepend . $str;
1893                 } // END - if
1894
1895                 // Return it
1896                 return $strFinal;
1897         }
1898
1899         /**
1900          * Checks wether the given encoded data was encoded with Base64
1901          *
1902          * @param       $encodedData    Encoded data we shall check
1903          * @return      $isBase64               Wether the encoded data is Base64
1904          */
1905         protected function isBase64Encoded ($encodedData) {
1906                 // Determine it
1907                 $isBase64 = (@base64_decode($encodedData, true) !== false);
1908
1909                 // Return it
1910                 return $isBase64;
1911         }
1912
1913         /**
1914          * "Getter" to get response/request type from analysis of the system.
1915          *
1916          * @return      $responseType   Analyzed response type
1917          */
1918         protected function getResponseTypeFromSystem () {
1919                 // Default is console
1920                 $responseType = 'console';
1921
1922                 // Is 'HTTP_HOST' set?
1923                 if (isset($_SERVER['HTTP_HOST'])) {
1924                         // Then it is a HTTP response/request
1925                         $responseType = 'http';
1926                 } // END - if
1927
1928                 // Return it
1929                 return $responseType;
1930         }
1931
1932         /**
1933          * Gets a cache key from Criteria instance
1934          *
1935          * @param       $criteriaInstance       An instance of a Criteria class
1936          * @param       $onlyKeys                       Only use these keys for a cache key
1937          * @return      $cacheKey                       A cache key suitable for lookup/storage purposes
1938          */
1939         protected function getCacheKeyByCriteria (Criteria $criteriaInstance, $onlyKeys = array()) {
1940                 // Generate it
1941                 $cacheKey = sprintf("%s@%s",
1942                         $this->__toString(),
1943                         $criteriaInstance->getCacheKey($onlyKeys)
1944                 );
1945
1946                 // And return it
1947                 //* NOISY-DEBUG: */ $this->debugOutput($this->__toString() . ': cacheKey=' . $cacheKey);
1948                 return $cacheKey;
1949         }
1950
1951         /**
1952          * Getter for startup time in miliseconds
1953          *
1954          * @return      $startupTime    Startup time in miliseconds
1955          */
1956         protected function getStartupTime () {
1957                 return self::$startupTime;
1958         }
1959
1960         /**
1961          * "Getter" for a printable currently execution time in nice braces
1962          *
1963          * @return      $executionTime  Current execution time in nice braces
1964          */
1965         protected function getPrintableExecutionTime () {
1966                 // Caculate the execution time
1967                 $executionTime = microtime(true) - $this->getStartupTime();
1968
1969                 // Pack it in nice braces
1970                 $executionTime = sprintf('[ %01.5f ] ', $executionTime);
1971
1972                 // And return it
1973                 return $executionTime;
1974         }
1975 }
1976
1977 // [EOF]
1978 ?>