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 source
 138          */
 139         private $sourceInstance = null;
 140
 141         /**
 142          * The real class name
 143          */
 144         private $realClass = 'BaseFrameworkSystem';
 145
 146         /**
 147          * Thousands seperator
 148          */
 149         private $thousands = '.'; // German
 150
 151         /**
 152          * Decimal seperator
 153          */
 154         private $decimals  = ','; // German
 155
 156         /**
 157          * Socket resource
 158          */
 159         private $socketResource = false;
 160
 161         /**
 162          * Package data
 163          */
 164         private $packageData = array();
 165
 166         /***********************
 167          * Exception codes.... *
 168          ***********************/
 169         // @todo Try to clean these constants up
 170         const EXCEPTION_IS_NULL_POINTER              = 0x001;
 171         const EXCEPTION_IS_NO_OBJECT                 = 0x002;
 172         const EXCEPTION_IS_NO_ARRAY                  = 0x003;
 173         const EXCEPTION_MISSING_METHOD               = 0x004;
 174         const EXCEPTION_CLASSES_NOT_MATCHING         = 0x005;
 175         const EXCEPTION_INDEX_OUT_OF_BOUNDS          = 0x006;
 176         const EXCEPTION_DIMENSION_ARRAY_INVALID      = 0x007;
 177         const EXCEPTION_ITEM_NOT_TRADEABLE           = 0x008;
 178         const EXCEPTION_ITEM_NOT_IN_PRICE_LIST       = 0x009;
 179         const EXCEPTION_GENDER_IS_WRONG              = 0x00a;
 180         const EXCEPTION_BIRTH_DATE_IS_INVALID        = 0x00b;
 181         const EXCEPTION_EMPTY_STRUCTURES_ARRAY       = 0x00c;
 182         const EXCEPTION_HAS_ALREADY_PERSONELL_LIST   = 0x00d;
 183         const EXCEPTION_NOT_ENOUGTH_UNEMPLOYEES      = 0x00e;
 184         const EXCEPTION_TOTAL_PRICE_NOT_CALCULATED   = 0x00f;
 185         const EXCEPTION_HARBOR_HAS_NO_SHIPYARDS      = 0x010;
 186         const EXCEPTION_CONTRACT_PARTNER_INVALID     = 0x011;
 187         const EXCEPTION_CONTRACT_PARTNER_MISMATCH    = 0x012;
 188         const EXCEPTION_CONTRACT_ALREADY_SIGNED      = 0x013;
 189         const EXCEPTION_UNEXPECTED_EMPTY_STRING      = 0x014;
 190         const EXCEPTION_PATH_NOT_FOUND               = 0x015;
 191         const EXCEPTION_INVALID_PATH_NAME            = 0x016;
 192         const EXCEPTION_READ_PROTECED_PATH           = 0x017;
 193         const EXCEPTION_WRITE_PROTECED_PATH          = 0x018;
 194         const EXCEPTION_DIR_POINTER_INVALID          = 0x019;
 195         const EXCEPTION_FILE_POINTER_INVALID         = 0x01a;
 196         const EXCEPTION_INVALID_RESOURCE             = 0x01b;
 197         const EXCEPTION_UNEXPECTED_OBJECT            = 0x01c;
 198         const EXCEPTION_LIMIT_ELEMENT_IS_UNSUPPORTED = 0x01d;
 199         const EXCEPTION_GETTER_IS_MISSING            = 0x01e;
 200         const EXCEPTION_ARRAY_EXPECTED               = 0x01f;
 201         const EXCEPTION_ARRAY_HAS_INVALID_COUNT      = 0x020;
 202         const EXCEPTION_ID_IS_INVALID_FORMAT         = 0x021;
 203         const EXCEPTION_MD5_CHECKSUMS_MISMATCH       = 0x022;
 204         const EXCEPTION_UNEXPECTED_STRING_SIZE       = 0x023;
 205         const EXCEPTION_SIMULATOR_ID_INVALID         = 0x024;
 206         const EXCEPTION_MISMATCHING_COMPRESSORS      = 0x025;
 207         const EXCEPTION_CONTAINER_ITEM_IS_NULL       = 0x026;
 208         const EXCEPTION_ITEM_IS_NO_ARRAY             = 0x027;
 209         const EXCEPTION_CONTAINER_MAYBE_DAMAGED      = 0x028;
 210         const EXCEPTION_INVALID_STRING               = 0x029;
 211         const EXCEPTION_VARIABLE_NOT_SET             = 0x02a;
 212         const EXCEPTION_ATTRIBUTES_ARE_MISSING       = 0x02b;
 213         const EXCEPTION_ARRAY_ELEMENTS_MISSING       = 0x02c;
 214         const EXCEPTION_TEMPLATE_ENGINE_UNSUPPORTED  = 0x02d;
 215         const EXCEPTION_MISSING_ELEMENT              = 0x030;
 216         const EXCEPTION_HEADERS_ALREADY_SENT         = 0x031;
 217         const EXCEPTION_DEFAULT_CONTROLLER_GONE      = 0x032;
 218         const EXCEPTION_CLASS_NOT_FOUND              = 0x033;
 219         const EXCEPTION_REQUIRED_INTERFACE_MISSING   = 0x034;
 220         const EXCEPTION_FATAL_ERROR                  = 0x035;
 221         const EXCEPTION_FILE_NOT_FOUND               = 0x036;
 222         const EXCEPTION_ASSERTION_FAILED             = 0x037;
 223         const EXCEPTION_FILE_CANNOT_BE_READ          = 0x038;
 224         const EXCEPTION_DATABASE_UPDATED_NOT_ALLOWED = 0x039;
 225         const EXCEPTION_FILTER_CHAIN_INTERCEPTED     = 0x040;
 226
 227         /**
 228          * Protected super constructor
 229          *
 230          * @param       $className      Name of the class
 231          * @return      void
 232          */
 233         protected function __construct ($className) {
 234                 // Set real class
 235                 $this->setRealClass($className);
 236
 237                 // Set configuration instance if no registry ...
 238                 if (!$this instanceof Register) {
 239                         // ... because registries doesn't need to be configured
 240                         $this->setConfigInstance(FrameworkConfiguration::getInstance());
 241                 } // END - if
 242         }
 243
 244         /**
 245          * Destructor reached...
 246          *
 247          * @return      void
 248          */
 249         public function __destruct() {
 250                 // Flush any updated entries to the database
 251                 $this->flushPendingUpdates();
 252
 253                 // Is this object already destroyed?
 254                 if ($this->__toString() != 'DestructedObject') {
 255                         // Destroy all informations about this class but keep some text about it alive
 256                         $this->setRealClass('DestructedObject');
 257                 } elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
 258                         // Already destructed object
 259                         $this->debugOutput(sprintf("[%s:] The object <span class=\"object_name\">%s</span> is already destroyed.",
 260                                 __CLASS__,
 261                                 $this->__toString()
 262                         ));
 263                 }
 264         }
 265
 266         /**
 267          * The __call() method where all non-implemented methods end up
 268          *
 269          * @param       $methodName             Name of the missing method
 270          * @args        $args                   Arguments passed to the method
 271          * @return      void
 272          */
 273         public final function __call ($methodName, $args) {
 274                 // Implode all given arguments
 275                 $argsString = '';
 276                 if (empty($args)) {
 277                         // No arguments
 278                         $argsString = 'NULL';
 279                 } elseif (is_array($args)) {
 280                         // Some arguments are there
 281                         foreach ($args as $arg) {
 282                                 // Add the type
 283                                 $argsString .= $this->replaceControlCharacters($arg) . ' (' . gettype($arg);
 284
 285                                 // Add length if type is string
 286                                 if (is_string($arg)) {
 287                                         $argsString .= ', '.strlen($arg);
 288                                 } // END - if
 289
 290                                 // Closing bracket
 291                                 $argsString .= '), ';
 292                         } // END - foreach
 293
 294                         // Remove last comma
 295                         if (substr($argsString, -2, 1) == ',') {
 296                                 $argsString = substr($argsString, 0, -2);
 297                         } // END - if
 298                 } else {
 299                         // Invalid arguments!
 300                         $argsString = '!INVALID:' . gettype($args) . '!';
 301                 }
 302
 303                 // Output stub message
 304                 $this->debugOutput(sprintf("[%s-&gt;%s] Stub! Args: %s",
 305                         $this->__toString(),
 306                         $methodName,
 307                         $argsString
 308                 ));
 309
 310                 // Return nothing
 311                 return null;
 312         }
 313
 314         /**
 315          * Getter for $realClass
 316          *
 317          * @return      $realClass The name of the real class (not BaseFrameworkSystem)
 318          */
 319         public function __toString () {
 320                 return $this->realClass;
 321         }
 322
 323         /**
 324          * Magic function to catch setting of missing but set class fields/attributes
 325          *
 326          * @param       $name   Name of the field/attribute
 327          * @param       $value  Value to store
 328          * @return      void
 329          */
 330         public final function __set ($name, $value) {
 331                 $this->debugBackTrace(sprintf("Tried to set a missing field. name=%s, value[%s]=%s",
 332                         $name,
 333                         gettype($value),
 334                         $value
 335                 ));
 336         }
 337
 338         /**
 339          * Magic function to catch getting of missing fields/attributes
 340          *
 341          * @param       $name   Name of the field/attribute
 342          * @return      void
 343          */
 344         public final function __get ($name) {
 345                 $this->debugBackTrace(sprintf("Tried to get a missing field. name=%s",
 346                         $name
 347                 ));
 348         }
 349
 350         /**
 351          * Setter for database result instance
 352          *
 353          * @param       $resultInstance         An instance of a database result class
 354          * @return      void
 355          * @todo        SearchableResult and UpdateableResult shall have a super interface to use here
 356          */
 357         protected final function setResultInstance (SearchableResult $resultInstance) {
 358                 $this->resultInstance =  $resultInstance;
 359         }
 360
 361         /**
 362          * Getter for database result instance
 363          *
 364          * @return      $resultInstance         An instance of a database result class
 365          */
 366         public final function getResultInstance () {
 367                 return $this->resultInstance;
 368         }
 369
 370         /**
 371          * Setter for template engine instances
 372          *
 373          * @param       $templateInstance       An instance of a template engine class
 374          * @return      void
 375          */
 376         protected final function setTemplateInstance (CompileableTemplate $templateInstance) {
 377                 $this->templateInstance = $templateInstance;
 378         }
 379
 380         /**
 381          * Getter for template engine instances
 382          *
 383          * @return      $templateInstance       An instance of a template engine class
 384          */
 385         protected final function getTemplateInstance () {
 386                 return $this->templateInstance;
 387         }
 388
 389         /**
 390          * Setter for search instance
 391          *
 392          * @param       $searchInstance         Searchable criteria instance
 393          * @return      void
 394          */
 395         public final function setSearchInstance (LocalSearchCriteria $searchInstance) {
 396                 $this->searchInstance = $searchInstance;
 397         }
 398
 399         /**
 400          * Getter for search instance
 401          *
 402          * @return      $searchInstance         Searchable criteria instance
 403          */
 404         public final function getSearchInstance () {
 405                 return $this->searchInstance;
 406         }
 407
 408         /**
 409          * Setter for update instance
 410          *
 411          * @param       $updateInstance         Searchable criteria instance
 412          * @return      void
 413          */
 414         public final function setUpdateInstance (LocalUpdateCriteria $updateInstance) {
 415                 $this->updateInstance = $updateInstance;
 416         }
 417
 418         /**
 419          * Getter for update instance
 420          *
 421          * @return      $updateInstance         Updateable criteria instance
 422          */
 423         public final function getUpdateInstance () {
 424                 return $this->updateInstance;
 425         }
 426
 427         /**
 428          * Setter for resolver instance
 429          *
 430          * @param       $resolverInstance       Instance of a command resolver class
 431          * @return      void
 432          */
 433         public final function setResolverInstance (Resolver $resolverInstance) {
 434                 $this->resolverInstance = $resolverInstance;
 435         }
 436
 437         /**
 438          * Getter for resolver instance
 439          *
 440          * @return      $resolverInstance       Instance of a command resolver class
 441          */
 442         public final function getResolverInstance () {
 443                 return $this->resolverInstance;
 444         }
 445
 446         /**
 447          * Setter for language instance
 448          *
 449          * @param       $configInstance         The configuration instance which shall
 450          *                                                              be FrameworkConfiguration
 451          * @return      void
 452          */
 453         public final function setConfigInstance (FrameworkConfiguration $configInstance) {
 454                 Registry::getRegistry()->addInstance('config', $configInstance);
 455         }
 456
 457         /**
 458          * Getter for configuration instance
 459          *
 460          * @return      $configInstance         Configuration instance
 461          */
 462         public final function getConfigInstance () {
 463                 $configInstance = Registry::getRegistry()->getInstance('config');
 464                 return $configInstance;
 465         }
 466
 467         /**
 468          * Setter for debug instance
 469          *
 470          * @param       $debugInstance  The instance for debug output class
 471          * @return      void
 472          */
 473         public final function setDebugInstance (DebugMiddleware $debugInstance) {
 474                 Registry::getRegistry()->addInstance('debug', $debugInstance);
 475         }
 476
 477         /**
 478          * Getter for debug instance
 479          *
 480          * @return      $debugInstance  Instance to class DebugConsoleOutput or DebugWebOutput
 481          */
 482         public final function getDebugInstance () {
 483                 // Get debug instance
 484                 $debugInstance = Registry::getRegistry()->getInstance('debug');
 485
 486                 // Return it
 487                 return $debugInstance;
 488         }
 489
 490         /**
 491          * Setter for web output instance
 492          *
 493          * @param               $webInstance    The instance for web output class
 494          * @return      void
 495          */
 496         public final function setWebOutputInstance (OutputStreamer $webInstance) {
 497                 Registry::getRegistry()->addInstance('web_output', $webInstance);
 498         }
 499
 500         /**
 501          * Getter for web output instance
 502          *
 503          * @return      $webOutputInstance - Instance to class WebOutput
 504          */
 505         public final function getWebOutputInstance () {
 506                 $webOutputInstance = Registry::getRegistry()->getInstance('web_output');
 507                 return $webOutputInstance;
 508         }
 509
 510         /**
 511          * Setter for database instance
 512          *
 513          * @param               $dbInstance     The instance for the database connection (forced DatabaseConnection)
 514          * @return      void
 515          */
 516         public final function setDatabaseInstance (DatabaseConnection $dbInstance) {
 517                 Registry::getRegistry()->addInstance('db_instance', $dbInstance);
 518         }
 519
 520         /**
 521          * Getter for database layer
 522          *
 523          * @return      $dbInstance     The database layer instance
 524          */
 525         public final function getDatabaseInstance () {
 526                 // Get instance
 527                 $dbInstance = Registry::getRegistry()->getInstance('db_instance');
 528
 529                 // Return instance
 530                 return $dbInstance;
 531         }
 532
 533         /**
 534          * Setter for compressor channel
 535          *
 536          * @param               $compressorInstance             An instance of CompressorChannel
 537          * @return      void
 538          */
 539         public final function setCompressorChannel (CompressorChannel $compressorInstance) {
 540                 Registry::getRegistry()->addInstance('compressor', $compressorInstance);
 541         }
 542
 543         /**
 544          * Getter for compressor channel
 545          *
 546          * @return      $compressorInstance             The compressor channel
 547          */
 548         public final function getCompressorChannel () {
 549                 $compressorInstance = Registry::getRegistry()->getInstance('compressor');
 550                 return $compressorInstance;
 551         }
 552
 553         /**
 554          * Protected getter for a manageable application helper class
 555          *
 556          * @return      $applicationInstance    An instance of a manageable application helper class
 557          */
 558         protected final function getApplicationInstance () {
 559                 $applicationInstance = Registry::getRegistry()->getInstance('application');
 560                 return $applicationInstance;
 561         }
 562
 563         /**
 564          * Setter for a manageable application helper class
 565          *
 566          * @param       $applicationInstance    An instance of a manageable application helper class
 567          * @return      void
 568          */
 569         public final function setApplicationInstance (ManageableApplication $applicationInstance) {
 570                 Registry::getRegistry()->addInstance('application', $applicationInstance);
 571         }
 572
 573         /**
 574          * Setter for request instance
 575          *
 576          * @param       $requestInstance        An instance of a Requestable class
 577          * @return      void
 578          */
 579         public final function setRequestInstance (Requestable $requestInstance) {
 580                 $this->requestInstance = $requestInstance;
 581         }
 582
 583         /**
 584          * Getter for request instance
 585          *
 586          * @return      $requestInstance        An instance of a Requestable class
 587          */
 588         public final function getRequestInstance () {
 589                 return $this->requestInstance;
 590         }
 591
 592         /**
 593          * Setter for response instance
 594          *
 595          * @param       $responseInstance       An instance of a Responseable class
 596          * @return      void
 597          */
 598         public final function setResponseInstance (Responseable $responseInstance) {
 599                 $this->responseInstance = $responseInstance;
 600         }
 601
 602         /**
 603          * Getter for response instance
 604          *
 605          * @return      $responseInstance       An instance of a Responseable class
 606          */
 607         public final function getResponseInstance () {
 608                 return $this->responseInstance;
 609         }
 610
 611         /**
 612          * Setter for the real class name
 613          *
 614          * @param               $realClass      Class name (string)
 615          * @return      void
 616          */
 617         public final function setRealClass ($realClass) {
 618                 // Cast to string
 619                 $realClass = (string) $realClass;
 620
 621                 // Set real class
 622                 $this->realClass = $realClass;
 623         }
 624
 625         /**
 626          * Checks wether an object equals this object. You should overwrite this
 627          * method to implement own equality checks
 628          *
 629          * @param       $objectInstance         An instance of a FrameworkInterface object
 630          * @return      $equals                         Wether both objects equals
 631          */
 632         public function equals (FrameworkInterface $objectInstance) {
 633                 // Now test it
 634                 $equals = ((
 635                         $this->__toString() == $objectInstance->__toString()
 636                 ) && (
 637                         $this->hashCode() == $objectInstance->hashCode()
 638                 ));
 639
 640                 // Return the result
 641                 return $equals;
 642         }
 643
 644         /**
 645          * Generates a generic hash code of this class. You should really overwrite
 646          * this method with your own hash code generator code. But keep KISS in mind.
 647          *
 648          * @return      $hashCode       A generic hash code respresenting this whole class
 649          */
 650         public function hashCode () {
 651                 // Simple hash code
 652                 return crc32($this->__toString());
 653         }
 654
 655         /**
 656          * Formats computer generated price values into human-understandable formats
 657          * with thousand and decimal seperators.
 658          *
 659          * @param       $value          The in computer format value for a price
 660          * @param       $currency       The currency symbol (use HTML-valid characters!)
 661          * @param       $decNum         Number of decimals after commata
 662          * @return      $price          The for the current language formated price string
 663          * @throws      MissingDecimalsThousandsSeperatorException      If decimals or
 664          *                                                                                              thousands seperator
 665          *                                                                                              is missing
 666          */
 667         public function formatCurrency ($value, $currency = '&euro;', $decNum = 2) {
 668                 // Are all required attriutes set?
 669                 if ((!isset($this->decimals)) || (!isset($this->thousands))) {
 670                         // Throw an exception
 671                         throw new MissingDecimalsThousandsSeperatorException($this, self::EXCEPTION_ATTRIBUTES_ARE_MISSING);
 672                 } // END - if
 673
 674                 // Cast the number
 675                 $value = (float) $value;
 676
 677                 // Reformat the US number
 678                 $price = number_format($value, $decNum, $this->decimals, $this->thousands) . $currency;
 679
 680                 // Return as string...
 681                 return $price;
 682         }
 683
 684         /**
 685          * Private getter for language instance
 686          *
 687          * @return      $langInstance   An instance to the language sub-system
 688          */
 689         protected final function getLanguageInstance () {
 690                 $langInstance = Registry::getRegistry()->getInstance('language');
 691                 return $langInstance;
 692         }
 693
 694         /**
 695          * Setter for language instance
 696          *
 697          * @param       $langInstance   An instance to the language sub-system
 698          * @return      void
 699          * @see         LanguageSystem
 700          */
 701         public final function setLanguageInstance (ManageableLanguage $langInstance) {
 702                 Registry::getRegistry()->addInstance('language', $langInstance);
 703         }
 704
 705         /**
 706          * Appends a trailing slash to a string
 707          *
 708          * @param       $str            A string (maybe) without trailing slash
 709          * @return      $str            A string with an auto-appended trailing slash
 710          */
 711         public final function addMissingTrailingSlash ($str) {
 712                 // Is there a trailing slash?
 713                 if (substr($str, -1, 1) != '/') {
 714                         $str .= '/';
 715                 } // END - if
 716
 717                 // Return string with trailing slash
 718                 return $str;
 719         }
 720
 721         /**
 722          * Private getter for file IO instance
 723          *
 724          * @return      $fileIoInstance An instance to the file I/O sub-system
 725          */
 726         protected final function getFileIoInstance () {
 727                 return $this->fileIoInstance;
 728         }
 729
 730         /**
 731          * Setter for file I/O instance
 732          *
 733          * @param       $fileIoInstance An instance to the file I/O sub-system
 734          * @return      void
 735          */
 736         public final function setFileIoInstance (FileIoHandler $fileIoInstance) {
 737                 $this->fileIoInstance = $fileIoInstance;
 738         }
 739
 740         /**
 741          * Prepare the template engine (WebTemplateEngine by default) for a given
 742          * application helper instance (ApplicationHelper by default).
 743          *
 744          * @param               $applicationInstance    An application helper instance or
 745          *                                                                              null if we shall use the default
 746          * @return              $templateInstance               The template engine instance
 747          * @throws              NullPointerException    If the discovered application
 748          *                                                                              instance is still null
 749          */
 750         protected function prepareTemplateInstance (ManageableApplication $applicationInstance = null) {
 751                 // Is the application instance set?
 752                 if (is_null($applicationInstance)) {
 753                         // Get the current instance
 754                         $applicationInstance = $this->getApplicationInstance();
 755
 756                         // Still null?
 757                         if (is_null($applicationInstance)) {
 758                                 // Thrown an exception
 759                                 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
 760                         } // END - if
 761                 } // END - if
 762
 763                 // Initialize the template engine
 764                 $templateInstance = ObjectFactory::createObjectByConfiguredName('web_template_class');
 765
 766                 // Return the prepared instance
 767                 return $templateInstance;
 768         }
 769
 770         /**
 771          * Debugs this instance by putting out it's full content
 772          *
 773          * @param       $message        Optional message to show in debug output
 774          * @return      void
 775          */
 776         public final function debugInstance ($message = '') {
 777                 // Restore the error handler to avoid trouble with missing array elements or undeclared variables
 778                 restore_error_handler();
 779
 780                 // Init content
 781                 $content = '';
 782
 783                 // Is a message set?
 784                 if (!empty($message)) {
 785                         // Construct message
 786                         $content = sprintf("<div class=\"debug_message\">Message: %s</div>\n", $message);
 787                 } // END - if
 788
 789                 // Generate the output
 790                 $content .= sprintf("<pre>%s</pre>",
 791                         trim(
 792                                 htmlentities(
 793                                         print_r($this, true)
 794                                 )
 795                         )
 796                 );
 797
 798                 // Output it
 799                 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>",
 800                         $this->__toString(),
 801                         $content,
 802                         ClassLoader::getInstance()->getPrintableIncludeList()
 803                 ));
 804         }
 805
 806         /**
 807          * Replaces control characters with printable output
 808          *
 809          * @param       $str    String with control characters
 810          * @return      $str    Replaced string
 811          */
 812         protected function replaceControlCharacters ($str) {
 813                 // Replace them
 814                 $str = str_replace(
 815                         "\r", '[r]', str_replace(
 816                         "\n", '[n]', str_replace(
 817                         "\t", '[t]',
 818                         $str
 819                 )));
 820
 821                 // Return it
 822                 return $str;
 823         }
 824
 825         /**
 826          * Output a partial stub message for the caller method
 827          *
 828          * @param       $message        An optional message to display
 829          * @return      void
 830          */
 831         protected function partialStub ($message = '') {
 832                 // Get the backtrace
 833                 $backtrace = debug_backtrace();
 834
 835                 // Generate the class::method string
 836                 $methodName = 'UnknownClass-&gt;unknownMethod';
 837                 if ((isset($backtrace[1]['class'])) && (isset($backtrace[1]['function']))) {
 838                         $methodName = $backtrace[1]['class'] . '-&gt;' . $backtrace[1]['function'];
 839                 } // END - if
 840
 841                 // Construct the full message
 842                 $stubMessage = sprintf("[%s:] Partial stub!",
 843                         $methodName
 844                 );
 845
 846                 // Is the extra message given?
 847                 if (!empty($message)) {
 848                         // Then add it as well
 849                         $stubMessage .= sprintf(" Message: <span id=\"stub_message\">%s</span>", $message);
 850                 } // END - if
 851
 852                 // Debug instance is there?
 853                 if (!is_null($this->getDebugInstance())) {
 854                         // Output stub message
 855                         $this->debugOutput($stubMessage);
 856                 } else {
 857                         // Trigger an error
 858                         trigger_error($stubMessage . "<br />\n");
 859                 }
 860         }
 861
 862         /**
 863          * Outputs a debug backtrace and stops further script execution
 864          *
 865          * @param       $message        An optional message to output
 866          * @return      void
 867          */
 868         public function debugBackTrace ($message = '') {
 869                 // Sorry, there is no other way getting this nice backtrace
 870                 if (!empty($message)) {
 871                         // Output message
 872                         printf("Message: %s<br />\n", $message);
 873                 } // END - if
 874
 875                 print("<pre>\n");
 876                 debug_print_backtrace();
 877                 print("</pre>");
 878                 exit();
 879         }
 880
 881         /**
 882          * Outputs a debug message wether to debug instance (should be set!) or dies with or pints the message
 883          *
 884          * @param       $message        Message we shall send out...
 885          * @param       $doPrint        Wether we shall print or die here which first is the default
 886          * @return      void
 887          */
 888         public function debugOutput ($message, $doPrint = true) {
 889                 // Get debug instance
 890                 $debugInstance = $this->getDebugInstance();
 891
 892                 // Is the debug instance there?
 893                 if (is_object($debugInstance)) {
 894                         // Use debug output handler
 895                         $debugInstance->output($message);
 896
 897                         if ($doPrint === false) {
 898                                 // Die here if not printed
 899                                 die();
 900                         } // END - if
 901                 } else {
 902                         // Put directly out
 903                         if ($doPrint === true) {
 904                                 print($message);
 905                         } else {
 906                                 // DO NOT REWRITE THIS TO app_die() !!!
 907                                 die($message);
 908                         }
 909                 }
 910         }
 911
 912         /**
 913          * Converts e.g. a command from URL to a valid class by keeping out bad characters
 914          *
 915          * @param       $str            The string, what ever it is needs to be converted
 916          * @return      $className      Generated class name
 917          */
 918         public function convertToClassName ($str) {
 919                 // Init class name
 920                 $className = '';
 921
 922                 // Convert all dashes in underscores
 923                 $str = $this->convertDashesToUnderscores($str);
 924
 925                 // Now use that underscores to get classname parts for hungarian style
 926                 foreach (explode('_', $str) as $strPart) {
 927                         // Make the class name part lower case and first upper case
 928                         $className .= ucfirst(strtolower($strPart));
 929                 } // END - foreach
 930
 931                 // Return class name
 932                 return $className;
 933         }
 934
 935         /**
 936          * Converts dashes to underscores, e.g. useable for configuration entries
 937          *
 938          * @param       $str    The string with maybe dashes inside
 939          * @return      $str    The converted string with no dashed, but underscores
 940          */
 941         public final function convertDashesToUnderscores ($str) {
 942                 // Convert them all
 943                 $str = str_replace('-', '_', $str);
 944
 945                 // Return converted string
 946                 return $str;
 947         }
 948
 949         /**
 950          * Marks up the code by adding e.g. line numbers
 951          *
 952          * @param       $phpCode                Unmarked PHP code
 953          * @return      $markedCode             Marked PHP code
 954          */
 955         public function markupCode ($phpCode) {
 956                 // Init marked code
 957                 $markedCode = '';
 958
 959                 // Get last error
 960                 $errorArray = error_get_last();
 961
 962                 // Init the code with error message
 963                 if (is_array($errorArray)) {
 964                         // Get error infos
 965                         $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>",
 966                                 basename($errorArray['file']),
 967                                 $errorArray['line'],
 968                                 $errorArray['message'],
 969                                 $errorArray['type']
 970                         );
 971                 } // END - if
 972
 973                 // Add line number to the code
 974                 foreach (explode("\n", $phpCode) as $lineNo => $code) {
 975                         // Add line numbers
 976                         $markedCode .= sprintf("<span id=\"code_line\">%s</span>: %s\n",
 977                                 ($lineNo + 1),
 978                                 htmlentities($code, ENT_QUOTES)
 979                         );
 980                 } // END - foreach
 981
 982                 // Return the code
 983                 return $markedCode;
 984         }
 985
 986         /**
 987          * Filter a given GMT timestamp (non Uni* stamp!) to make it look more
 988          * beatiful for web-based front-ends. If null is given a message id
 989          * null_timestamp will be resolved and returned.
 990          *
 991          * @param       $timestamp      Timestamp to prepare (filter) for display
 992          * @return      $readable       A readable timestamp
 993          */
 994         public function doFilterFormatTimestamp ($timestamp) {
 995                 // Default value to return
 996                 $readable = '???';
 997
 998                 // Is the timestamp null?
 999                 if (is_null($timestamp)) {
1000                         // Get a message string
1001                         $readable = $this->getLanguageInstance()->getMessage('null_timestamp');
1002                 } else {
1003                         switch ($this->getLanguageInstance()->getLanguageCode()) {
1004                                 case 'de': // German format is a bit different to default
1005                                         // Split the GMT stamp up
1006                                         $dateTime  = explode(' ', $timestamp  );
1007                                         $dateArray = explode('-', $dateTime[0]);
1008                                         $timeArray = explode(':', $dateTime[1]);
1009
1010                                         // Construct the timestamp
1011                                         $readable = sprintf($this->getConfigInstance()->getConfigEntry('german_date_time'),
1012                                                 $dateArray[0],
1013                                                 $dateArray[1],
1014                                                 $dateArray[2],
1015                                                 $timeArray[0],
1016                                                 $timeArray[1],
1017                                                 $timeArray[2]
1018                                         );
1019                                         break;
1020
1021                                 default: // Default is pass-through
1022                                         $readable = $timestamp;
1023                                         break;
1024                         } // END - switch
1025                 }
1026
1027                 // Return the stamp
1028                 return $readable;
1029         }
1030
1031         /**
1032          * Filter a given number into a localized number
1033          *
1034          * @param       $value          The raw value from e.g. database
1035          * @return      $localized      Localized value
1036          */
1037         public function doFilterFormatNumber ($value) {
1038                 // Generate it from config and localize dependencies
1039                 switch ($this->getLanguageInstance()->getLanguageCode()) {
1040                         case 'de': // German format is a bit different to default
1041                                 $localized = number_format($value, $this->getConfigInstance()->getConfigEntry('decimals'), ',', '.');
1042                                 break;
1043
1044                         default: // US, etc.
1045                                 $localized = number_format($value, $this->getConfigInstance()->getConfigEntry('decimals'), '.', ',');
1046                                 break;
1047                 } // END - switch
1048
1049                 // Return it
1050                 return $localized;
1051         }
1052
1053         /**
1054          * "Getter" for databse entry
1055          *
1056          * @return      $entry  An array with database entries
1057          * @throws      NullPointerException    If the database result is not found
1058          * @throws      InvalidDatabaseResultException  If the database result is invalid
1059          */
1060         protected final function getDatabaseEntry () {
1061                 // Is there an instance?
1062                 if (is_null($this->getResultInstance())) {
1063                         // Throw an exception here
1064                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
1065                 } // END - if
1066
1067                 // Rewind it
1068                 $this->getResultInstance()->rewind();
1069
1070                 // Do we have an entry?
1071                 if ($this->getResultInstance()->valid() === false) {
1072                         throw new InvalidDatabaseResultException(array($this, $this->getResultInstance()), DatabaseResult::EXCEPTION_INVALID_DATABASE_RESULT);
1073                 } // END - if
1074
1075                 // Get next entry
1076                 $this->getResultInstance()->next();
1077
1078                 // Fetch it
1079                 $entry = $this->getResultInstance()->current();
1080
1081                 // And return it
1082                 return $entry;
1083         }
1084
1085         /**
1086          * Getter for field name
1087          *
1088          * @param       $fieldName              Field name which we shall get
1089          * @return      $fieldValue             Field value from the user
1090          * @throws      NullPointerException    If the result instance is null
1091          */
1092         public final function getField ($fieldName) {
1093                 // Default field value
1094                 $fieldValue = null;
1095
1096                 // Get result instance
1097                 $resultInstance = $this->getResultInstance();
1098
1099                 // Is this instance null?
1100                 if (is_null($resultInstance)) {
1101                         // Then the user instance is no longer valid (expired cookies?)
1102                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
1103                 } // END - if
1104
1105                 // Get current array
1106                 $fieldArray = $resultInstance->current();
1107                 //* DEBUG: */ $this->debugOutput($fieldName.':<pre>'.print_r($fieldArray, true).'</pre>');
1108
1109                 // Does the field exist?
1110                 if (isset($fieldArray[$fieldName])) {
1111                         // Get it
1112                         $fieldValue = $fieldArray[$fieldName];
1113                 } // END - if
1114
1115                 // Return it
1116                 return $fieldValue;
1117         }
1118
1119         /**
1120          * Protected setter for user instance
1121          *
1122          * @param       $userInstance   An instance of a user class
1123          * @return      void
1124          */
1125         protected final function setUserInstance (ManageableAccount $userInstance) {
1126                 $this->userInstance = $userInstance;
1127         }
1128
1129         /**
1130          * Getter for user instance
1131          *
1132          * @return      $userInstance   An instance of a user class
1133          */
1134         public final function getUserInstance () {
1135                 return $this->userInstance;
1136         }
1137
1138         /**
1139          * Setter for controller instance (this surely breaks a bit the MVC patterm)
1140          *
1141          * @param       $controllerInstance             An instance of the controller
1142          * @return      void
1143          */
1144         public final function setControllerInstance (Controller $controllerInstance) {
1145                 $this->controllerInstance = $controllerInstance;
1146         }
1147
1148         /**
1149          * Getter for controller instance (this surely breaks a bit the MVC patterm)
1150          *
1151          * @return      $controllerInstance             An instance of the controller
1152          */
1153         public final function getControllerInstance () {
1154                 return $this->controllerInstance;
1155         }
1156
1157         /**
1158          * Flushs all pending updates to the database layer
1159          *
1160          * @return      void
1161          */
1162         public function flushPendingUpdates () {
1163                 // Get result instance
1164                 $resultInstance = $this->getResultInstance();
1165
1166                 // Do we have data to update?
1167                 if ((is_object($resultInstance)) && ($resultInstance->ifDataNeedsFlush())) {
1168                         // Get wrapper class name config entry
1169                         $configEntry = $resultInstance->getUpdateInstance()->getWrapperConfigEntry();
1170
1171                         // Create object instance
1172                         $wrapperInstance = ObjectFactory::createObjectByConfiguredName($configEntry);
1173
1174                         // Yes, then send the whole result to the database layer
1175                         $wrapperInstance->doUpdateByResult($this->getResultInstance());
1176                 } // END - if
1177         }
1178
1179         /**
1180          * Outputs a deprecation warning to the developer.
1181          *
1182          * @param       $message        The message we shall output to the developer
1183          * @return      void
1184          * @todo        Write a logging mechanism for productive mode
1185          */
1186         public function deprecationWarning ($message) {
1187                 // Is developer mode active?
1188                 if (defined('DEVELOPER')) {
1189                         // Debug instance is there?
1190                         if (!is_null($this->getDebugInstance())) {
1191                                 // Output stub message
1192                                 $this->debugOutput($message);
1193                         } else {
1194                                 // Trigger an error
1195                                 trigger_error($message . "<br />\n");
1196                         }
1197                 } else {
1198                         // @TODO Finish this part!
1199                         $this->partialStub('Developer mode inactive. Message:' . $message);
1200                 }
1201         }
1202
1203         /**
1204          * Checks wether the given PHP extension is loaded
1205          *
1206          * @param       $phpExtension   The PHP extension we shall check
1207          * @return      $isLoaded       Wether the PHP extension is loaded
1208          */
1209         public final function isPhpExtensionLoaded ($phpExtension) {
1210                 // Is it loaded?
1211                 $isLoaded = in_array($phpExtension, get_loaded_extensions());
1212
1213                 // Return result
1214                 return $isLoaded;
1215         }
1216
1217         /**
1218          * Setter for RNG instance
1219          *
1220          * @param       $rngInstance    An instance of a random number generator (RNG)
1221          * @return      void
1222          */
1223         protected final function setRngInstance (RandomNumberGenerator $rngInstance) {
1224                 $this->rngInstance = $rngInstance;
1225         }
1226
1227         /**
1228          * Getter for RNG instance
1229          *
1230          * @return      $rngInstance    An instance of a random number generator (RNG)
1231          */
1232         public final function getRngInstance () {
1233                 return $this->rngInstance;
1234         }
1235
1236         /**
1237          * Setter for Cryptable instance
1238          *
1239          * @param       $cryptoInstance An instance of a Cryptable class
1240          * @return      void
1241          */
1242         protected final function setCryptoInstance (Cryptable $cryptoInstance) {
1243                 $this->cryptoInstance = $cryptoInstance;
1244         }
1245
1246         /**
1247          * Getter for Cryptable instance
1248          *
1249          * @return      $cryptoInstance An instance of a Cryptable class
1250          */
1251         public final function getCryptoInstance () {
1252                 return $this->cryptoInstance;
1253         }
1254
1255         /**
1256          * Setter for Iterator instance
1257          *
1258          * @param       $iteratorInstance       An instance of an Iterator
1259          * @return      void
1260          */
1261         protected final function setIteratorInstance (Iterator $iteratorInstance) {
1262                 $this->iteratorInstance = $iteratorInstance;
1263         }
1264
1265         /**
1266          * Getter for Iterator instance
1267          *
1268          * @return      $iteratorInstance       An instance of an Iterator
1269          */
1270         public final function getIteratorInstance () {
1271                 return $this->iteratorInstance;
1272         }
1273
1274         /**
1275          * "Getter" as a time() replacement but with milliseconds. You should use this
1276          * method instead of the encapsulated getimeofday() function.
1277          *
1278          * @return      $milliTime      Timestamp with milliseconds
1279          */
1280         public function getMilliTime () {
1281                 // Get the time of day as float
1282                 $milliTime = gettimeofday(true);
1283
1284                 // Return it
1285                 return $milliTime;
1286         }
1287
1288         /**
1289          * Idles (sleeps) for given milliseconds
1290          *
1291          * @return      $hasSlept       Wether it goes fine
1292          */
1293         public function idle ($milliSeconds) {
1294                 // Sleep is fine by default
1295                 $hasSlept = true;
1296
1297                 // Idle so long with found function
1298                 if (function_exists('time_sleep_until')) {
1299                         // Get current time and add idle time
1300                         $sleepUntil = $this->getMilliTime() + abs($milliSeconds) / 1000;
1301
1302                         // New PHP 5.1.0 function found
1303                         $hasSlept = time_sleep_until($sleepUntil);
1304                 } else {
1305                         // My Sun Station doesn't have that function even with latest PHP
1306                         // package. :(
1307                         usleep($milliSeconds * 1000);
1308                 }
1309
1310                 // Return result
1311                 return $hasSlept;
1312         }
1313
1314         /**
1315          * Setter for the list instance
1316          *
1317          * @param       $listInstance   A list of Listable
1318          * @return      void
1319          */
1320         protected final function setListInstance (Listable $listInstance) {
1321                 $this->listInstance = $listInstance;
1322         }
1323
1324         /**
1325          * Getter for the list instance
1326          *
1327          * @return      $listInstance   A list of Listable
1328          */
1329         protected final function getListInstance () {
1330                 return $this->listInstance;
1331         }
1332
1333         /**
1334          * Setter for the menu instance
1335          *
1336          * @param       $menuInstance   A RenderableMenu instance
1337          * @return      void
1338          */
1339         protected final function setMenuInstance (RenderableMenu $menuInstance) {
1340                 $this->menuInstance = $menuInstance;
1341         }
1342
1343         /**
1344          * Getter for the menu instance
1345          *
1346          * @return      $menuInstance   A RenderableMenu instance
1347          */
1348         protected final function getMenuInstance () {
1349                 return $this->menuInstance;
1350         }
1351
1352         /**
1353          * Setter for image instance
1354          *
1355          * @param       $imageInstance  An instance of an image
1356          * @return      void
1357          */
1358         public final function setImageInstance (BaseImage $imageInstance) {
1359                 $this->imageInstance = $imageInstance;
1360         }
1361
1362         /**
1363          * Getter for image instance
1364          *
1365          * @return      $imageInstance  An instance of an image
1366          */
1367         public final function getImageInstance () {
1368                 return $this->imageInstance;
1369         }
1370
1371         /**
1372          * Setter for stacker instance
1373          *
1374          * @param       $stackerInstance        An instance of an stacker
1375          * @return      void
1376          */
1377         public final function setStackerInstance (Stackable $stackerInstance) {
1378                 $this->stackerInstance = $stackerInstance;
1379         }
1380
1381         /**
1382          * Getter for stacker instance
1383          *
1384          * @return      $stackerInstance        An instance of an stacker
1385          */
1386         public final function getStackerInstance () {
1387                 return $this->stackerInstance;
1388         }
1389
1390         /**
1391          * Setter for compressor instance
1392          *
1393          * @param       $compressorInstance     An instance of an compressor
1394          * @return      void
1395          */
1396         public final function setCompressorInstance (Compressor $compressorInstance) {
1397                 $this->compressorInstance = $compressorInstance;
1398         }
1399
1400         /**
1401          * Getter for compressor instance
1402          *
1403          * @return      $compressorInstance     An instance of an compressor
1404          */
1405         public final function getCompressorInstance () {
1406                 return $this->compressorInstance;
1407         }
1408
1409         /**
1410          * Setter for Parseable instance
1411          *
1412          * @param       $parserInstance An instance of an Parseable
1413          * @return      void
1414          */
1415         public final function setParserInstance (Parseable $parserInstance) {
1416                 $this->parserInstance = $parserInstance;
1417         }
1418
1419         /**
1420          * Getter for Parseable instance
1421          *
1422          * @return      $parserInstance An instance of an Parseable
1423          */
1424         public final function getParserInstance () {
1425                 return $this->parserInstance;
1426         }
1427
1428         /**
1429          * Setter for ProtocolHandler instance
1430          *
1431          * @param       $protocolInstance       An instance of an ProtocolHandler
1432          * @return      void
1433          */
1434         public final function setProtocolInstance (ProtocolHandler $protocolInstance) {
1435                 $this->protocolInstance = $protocolInstance;
1436         }
1437
1438         /**
1439          * Getter for ProtocolHandler instance
1440          *
1441          * @return      $protocolInstance       An instance of an ProtocolHandler
1442          */
1443         public final function getProtocolInstance () {
1444                 return $this->protocolInstance;
1445         }
1446
1447         /**
1448          * Setter for BaseDatabaseWrapper instance
1449          *
1450          * @param       $wrapperInstance        An instance of an BaseDatabaseWrapper
1451          * @return      void
1452          */
1453         public final function setWrapperInstance (BaseDatabaseWrapper $wrapperInstance) {
1454                 $this->wrapperInstance = $wrapperInstance;
1455         }
1456
1457         /**
1458          * Getter for BaseDatabaseWrapper instance
1459          *
1460          * @return      $wrapperInstance        An instance of an BaseDatabaseWrapper
1461          */
1462         public final function getWrapperInstance () {
1463                 return $this->wrapperInstance;
1464         }
1465
1466         /**
1467          * Setter for socket resource
1468          *
1469          * @param       $socketResource         A valid socket resource
1470          * @return      void
1471          */
1472         public final function setSocketResource ($socketResource) {
1473                 $this->socketResource = $socketResource;
1474         }
1475
1476         /**
1477          * Getter for socket resource
1478          *
1479          * @return      $socketResource         A valid socket resource
1480          */
1481         public function getSocketResource () {
1482                 return $this->socketResource;
1483         }
1484
1485         /**
1486          * Setter for helper instance
1487          *
1488          * @param       $helperInstance         An instance of a helper class
1489          * @return      void
1490          */
1491         protected final function setHelperInstance (Helper $helperInstance) {
1492                 $this->helperInstance = $helperInstance;
1493         }
1494
1495         /**
1496          * Getter for helper instance
1497          *
1498          * @return      $helperInstance         An instance of a helper class
1499          */
1500         public final function getHelperInstance () {
1501                 return $this->helperInstance;
1502         }
1503
1504         /**
1505          * Setter for a Sourceable instance
1506          *
1507          * @param       $sourceInstance The Sourceable instance
1508          * @return      void
1509          */
1510         protected final function setSourceInstance (Sourceable $sourceInstance) {
1511                 $this->sourceInstance = $sourceInstance;
1512         }
1513
1514         /**
1515          * Getter for a Sourceable instance
1516          *
1517          * @param       $sourceInstance The Sourceable instance
1518          */
1519         protected final function getSourceInstance () {
1520                 return $this->sourceInstance;
1521         }
1522
1523         /**
1524          * Setter for raw package Data
1525          *
1526          * @param       $packageData    Raw package Data
1527          * @return      void
1528          */
1529         public final function setPackageData (array $packageData) {
1530                 $this->packageData = $packageData;
1531         }
1532
1533         /**
1534          * Getter for raw package Data
1535          *
1536          * @return      $packageData    Raw package Data
1537          */
1538         public function getPackageData () {
1539                 return $this->packageData;
1540         }
1541 }
1542
1543 // [EOF]
1544 ?>