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@shipsimu.org>
   7  * @version             0.0.0
   8  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
   9  * @license             GNU GPL 3.0 or any newer version
  10  * @link                http://www.shipsimu.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          * Length of output from hash()
  28          */
  29         private static $hashLength = NULL;
  30
  31         /**
  32          * The real class name
  33          */
  34         private $realClass = 'BaseFrameworkSystem';
  35
  36         /**
  37          * Instance of a request class
  38          */
  39         private $requestInstance = NULL;
  40
  41         /**
  42          * Instance of a response class
  43          */
  44         private $responseInstance = NULL;
  45
  46         /**
  47          * Search criteria instance
  48          */
  49         private $searchInstance = NULL;
  50
  51         /**
  52          * Update criteria instance
  53          */
  54         private $updateInstance = NULL;
  55
  56         /**
  57          * The file I/O instance for the template loader
  58          */
  59         private $fileIoInstance = NULL;
  60
  61         /**
  62          * Resolver instance
  63          */
  64         private $resolverInstance = NULL;
  65
  66         /**
  67          * Template engine instance
  68          */
  69         private $templateInstance = NULL;
  70
  71         /**
  72          * Database result instance
  73          */
  74         private $resultInstance = NULL;
  75
  76         /**
  77          * Instance for user class
  78          */
  79         private $userInstance = NULL;
  80
  81         /**
  82          * A controller instance
  83          */
  84         private $controllerInstance = NULL;
  85
  86         /**
  87          * Instance of a RNG
  88          */
  89         private $rngInstance = NULL;
  90
  91         /**
  92          * Instance of a crypto helper
  93          */
  94         private $cryptoInstance = NULL;
  95
  96         /**
  97          * Instance of an Iterator class
  98          */
  99         private $iteratorInstance = NULL;
 100
 101         /**
 102          * Instance of the list
 103          */
 104         private $listInstance = NULL;
 105
 106         /**
 107          * Instance of a menu
 108          */
 109         private $menuInstance = NULL;
 110
 111         /**
 112          * Instance of the image
 113          */
 114         private $imageInstance = NULL;
 115
 116         /**
 117          * Instance of the stacker
 118          */
 119         private $stackInstance = NULL;
 120
 121         /**
 122          * A Compressor instance
 123          */
 124         private $compressorInstance = NULL;
 125
 126         /**
 127          * A Parseable instance
 128          */
 129         private $parserInstance = NULL;
 130
 131         /**
 132          * A HandleableProtocol instance
 133          */
 134         private $protocolInstance = NULL;
 135
 136         /**
 137          * A database wrapper instance
 138          */
 139         private $databaseInstance = NULL;
 140
 141         /**
 142          * A helper instance for the form
 143          */
 144         private $helperInstance = NULL;
 145
 146         /**
 147          * An instance of a Sourceable class
 148          */
 149         private $sourceInstance = NULL;
 150
 151         /**
 152          * An instance of a UrlSource class
 153          */
 154         private $urlSourceInstance = NULL;
 155
 156         /**
 157          * An instance of a InputStream class
 158          */
 159         private $inputStreamInstance = NULL;
 160
 161         /**
 162          * An instance of a OutputStream class
 163          */
 164         private $outputStreamInstance = NULL;
 165
 166         /**
 167          * Networkable handler instance
 168          */
 169         private $handlerInstance = NULL;
 170
 171         /**
 172          * Visitor handler instance
 173          */
 174         private $visitorInstance = NULL;
 175
 176         /**
 177          * DHT instance
 178          */
 179         private $dhtInstance = NULL;
 180
 181         /**
 182          * An instance of a database wrapper class
 183          */
 184         private $wrapperInstance = NULL;
 185
 186         /**
 187          * An instance of a file I/O pointer class (not handler)
 188          */
 189         private $pointerInstance = NULL;
 190
 191         /**
 192          * An instance of an Indexable class
 193          */
 194         private $indexInstance = NULL;
 195
 196         /**
 197          * An instance of a Block class
 198          */
 199         private $blockInstance = NULL;
 200
 201         /**
 202          * A Minable instance
 203          */
 204         private $minableInstance = NULL;
 205
 206         /**
 207          * A FrameworkDirectory instance
 208          */
 209         private $directoryInstance = NULL;
 210
 211         /**
 212          * Listener instance
 213          */
 214         private $listenerInstance = NULL;
 215
 216         /**
 217          * Thousands separator
 218          */
 219         private $thousands = '.'; // German
 220
 221         /**
 222          * Decimal separator
 223          */
 224         private $decimals  = ','; // German
 225
 226         /**
 227          * Socket resource
 228          */
 229         private $socketResource = FALSE;
 230
 231         /**
 232          * Regular expression to use for validation
 233          */
 234         private $regularExpression = '';
 235
 236         /**
 237          * Package data
 238          */
 239         private $packageData = array();
 240
 241         /**
 242          * Generic array
 243          */
 244         private $genericArray = array();
 245
 246         /***********************
 247          * Exception codes.... *
 248          ***********************/
 249
 250         // @todo Try to clean these constants up
 251         const EXCEPTION_IS_NULL_POINTER              = 0x001;
 252         const EXCEPTION_IS_NO_OBJECT                 = 0x002;
 253         const EXCEPTION_IS_NO_ARRAY                  = 0x003;
 254         const EXCEPTION_MISSING_METHOD               = 0x004;
 255         const EXCEPTION_CLASSES_NOT_MATCHING         = 0x005;
 256         const EXCEPTION_INDEX_OUT_OF_BOUNDS          = 0x006;
 257         const EXCEPTION_DIMENSION_ARRAY_INVALID      = 0x007;
 258         const EXCEPTION_ITEM_NOT_TRADEABLE           = 0x008;
 259         const EXCEPTION_ITEM_NOT_IN_PRICE_LIST       = 0x009;
 260         const EXCEPTION_GENDER_IS_WRONG              = 0x00a;
 261         const EXCEPTION_BIRTH_DATE_IS_INVALID        = 0x00b;
 262         const EXCEPTION_EMPTY_STRUCTURES_ARRAY       = 0x00c;
 263         const EXCEPTION_HAS_ALREADY_PERSONELL_LIST   = 0x00d;
 264         const EXCEPTION_NOT_ENOUGTH_UNEMPLOYEES      = 0x00e;
 265         const EXCEPTION_TOTAL_PRICE_NOT_CALCULATED   = 0x00f;
 266         const EXCEPTION_HARBOR_HAS_NO_SHIPYARDS      = 0x010;
 267         const EXCEPTION_CONTRACT_PARTNER_INVALID     = 0x011;
 268         const EXCEPTION_CONTRACT_PARTNER_MISMATCH    = 0x012;
 269         const EXCEPTION_CONTRACT_ALREADY_SIGNED      = 0x013;
 270         const EXCEPTION_UNEXPECTED_EMPTY_STRING      = 0x014;
 271         const EXCEPTION_PATH_NOT_FOUND               = 0x015;
 272         const EXCEPTION_INVALID_PATH_NAME            = 0x016;
 273         const EXCEPTION_READ_PROTECED_PATH           = 0x017;
 274         const EXCEPTION_WRITE_PROTECED_PATH          = 0x018;
 275         const EXCEPTION_DIR_POINTER_INVALID          = 0x019;
 276         const EXCEPTION_FILE_POINTER_INVALID         = 0x01a;
 277         const EXCEPTION_INVALID_RESOURCE             = 0x01b;
 278         const EXCEPTION_UNEXPECTED_OBJECT            = 0x01c;
 279         const EXCEPTION_LIMIT_ELEMENT_IS_UNSUPPORTED = 0x01d;
 280         const EXCEPTION_GETTER_IS_MISSING            = 0x01e;
 281         const EXCEPTION_ARRAY_EXPECTED               = 0x01f;
 282         const EXCEPTION_ARRAY_HAS_INVALID_COUNT      = 0x020;
 283         const EXCEPTION_ID_IS_INVALID_FORMAT         = 0x021;
 284         const EXCEPTION_MD5_CHECKSUMS_MISMATCH       = 0x022;
 285         const EXCEPTION_UNEXPECTED_STRING_SIZE       = 0x023;
 286         const EXCEPTION_SIMULATOR_ID_INVALID         = 0x024;
 287         const EXCEPTION_MISMATCHING_COMPRESSORS      = 0x025;
 288         const EXCEPTION_CONTAINER_ITEM_IS_NULL       = 0x026;
 289         const EXCEPTION_ITEM_IS_NO_ARRAY             = 0x027;
 290         const EXCEPTION_CONTAINER_MAYBE_DAMAGED      = 0x028;
 291         const EXCEPTION_INVALID_STRING               = 0x029;
 292         const EXCEPTION_VARIABLE_NOT_SET             = 0x02a;
 293         const EXCEPTION_ATTRIBUTES_ARE_MISSING       = 0x02b;
 294         const EXCEPTION_ARRAY_ELEMENTS_MISSING       = 0x02c;
 295         const EXCEPTION_TEMPLATE_ENGINE_UNSUPPORTED  = 0x02d;
 296         const EXCEPTION_UNSPPORTED_OPERATION         = 0x02e;
 297         const EXCEPTION_FACTORY_REQUIRE_PARAMETER    = 0x02f;
 298         const EXCEPTION_MISSING_ELEMENT              = 0x030;
 299         const EXCEPTION_HEADERS_ALREADY_SENT         = 0x031;
 300         const EXCEPTION_DEFAULT_CONTROLLER_GONE      = 0x032;
 301         const EXCEPTION_CLASS_NOT_FOUND              = 0x033;
 302         const EXCEPTION_REQUIRED_INTERFACE_MISSING   = 0x034;
 303         const EXCEPTION_FATAL_ERROR                  = 0x035;
 304         const EXCEPTION_FILE_NOT_FOUND               = 0x036;
 305         const EXCEPTION_ASSERTION_FAILED             = 0x037;
 306         const EXCEPTION_FILE_CANNOT_BE_READ          = 0x038;
 307         const EXCEPTION_DATABASE_UPDATED_NOT_ALLOWED = 0x039;
 308         const EXCEPTION_FILTER_CHAIN_INTERCEPTED     = 0x03a;
 309
 310         /**
 311          * Hexadecimal->Decimal translation array
 312          */
 313         private static $hexdec = array(
 314                 '0' => 0,
 315                 '1' => 1,
 316                 '2' => 2,
 317                 '3' => 3,
 318                 '4' => 4,
 319                 '5' => 5,
 320                 '6' => 6,
 321                 '7' => 7,
 322                 '8' => 8,
 323                 '9' => 9,
 324                 'a' => 10,
 325                 'b' => 11,
 326                 'c' => 12,
 327                 'd' => 13,
 328                 'e' => 14,
 329                 'f' => 15
 330         );
 331
 332         /**
 333          * Decimal->hexadecimal translation array
 334          */
 335         private static $dechex = array(
 336                  0 => '0',
 337                  1 => '1',
 338                  2 => '2',
 339                  3 => '3',
 340                  4 => '4',
 341                  5 => '5',
 342                  6 => '6',
 343                  7 => '7',
 344                  8 => '8',
 345                  9 => '9',
 346                 10 => 'a',
 347                 11 => 'b',
 348                 12 => 'c',
 349                 13 => 'd',
 350                 14 => 'e',
 351                 15 => 'f'
 352         );
 353
 354         /**
 355          * Startup time in miliseconds
 356          */
 357         private static $startupTime = 0;
 358
 359         /**
 360          * Protected super constructor
 361          *
 362          * @param       $className      Name of the class
 363          * @return      void
 364          */
 365         protected function __construct ($className) {
 366                 // Set real class
 367                 $this->setRealClass($className);
 368
 369                 // Set configuration instance if no registry ...
 370                 if (!$this instanceof Register) {
 371                         // ... because registries doesn't need to be configured
 372                         $this->setConfigInstance(FrameworkConfiguration::getSelfInstance());
 373                 } // END - if
 374
 375                 // Is the startup time set? (0 cannot be TRUE anymore)
 376                 if (self::$startupTime == 0) {
 377                         // Then set it
 378                         self::$startupTime = microtime(TRUE);
 379                 } // END - if
 380         }
 381
 382         /**
 383          * Destructor for all classes
 384          *
 385          * @return      void
 386          */
 387         public function __destruct () {
 388                 // Flush any updated entries to the database
 389                 $this->flushPendingUpdates();
 390
 391                 // Is this object already destroyed?
 392                 if ($this->__toString() != 'DestructedObject') {
 393                         // Destroy all informations about this class but keep some text about it alive
 394                         $this->setRealClass('DestructedObject');
 395                 } elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
 396                         // Already destructed object
 397                         self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[%s:] The object <span class="object_name">%s</span> is already destroyed.',
 398                                 __CLASS__,
 399                                 $this->__toString()
 400                         ));
 401                 } else {
 402                         // Do not call this twice
 403                         trigger_error(__METHOD__ . ': Called twice.');
 404                         exit;
 405                 }
 406         }
 407
 408         /**
 409          * The __call() method where all non-implemented methods end up
 410          *
 411          * @param       $methodName             Name of the missing method
 412          * @args        $args                   Arguments passed to the method
 413          * @return      void
 414          */
 415         public final function __call ($methodName, $args) {
 416                 return self::__callStatic($methodName, $args);
 417         }
 418
 419         /**
 420          * The __callStatic() method where all non-implemented static methods end up
 421          *
 422          * @param       $methodName             Name of the missing method
 423          * @args        $args                   Arguments passed to the method
 424          * @return      void
 425          */
 426         public static final function __callStatic ($methodName, $args) {
 427                 // Init argument string
 428                 $argsString = '';
 429
 430                 // Is it empty or an array?
 431                 if (empty($args)) {
 432                         // No arguments
 433                         $argsString = 'NULL';
 434                 } elseif (is_array($args)) {
 435                         // Some arguments are there
 436                         foreach ($args as $arg) {
 437                                 // Add the value itself if not array. This prevents 'array to string conversion' message
 438                                 if (is_array($arg)) {
 439                                         $argsString .= 'Array';
 440                                 } else {
 441                                         $argsString .= $arg;
 442                                 }
 443
 444                                 // Add data about the argument
 445                                 $argsString .= ' (' . gettype($arg);
 446
 447                                 if (is_string($arg)) {
 448                                         // Add length for strings
 449                                         $argsString .= ', ' . strlen($arg);
 450                                 } elseif (is_array($arg)) {
 451                                         // .. or size if array
 452                                         $argsString .= ', ' . count($arg);
 453                                 } elseif ($arg === TRUE) {
 454                                         // ... is boolean 'TRUE'
 455                                         $argsString .= ', TRUE';
 456                                 } elseif ($arg === FALSE) {
 457                                         // ... is boolean 'FALSE'
 458                                         $argsString .= ', FALSE';
 459                                 }
 460
 461                                 // Closing bracket
 462                                 $argsString .= '), ';
 463                         } // END - foreach
 464
 465                         // Remove last comma
 466                         if (substr($argsString, -2, 1) == ',') {
 467                                 $argsString = substr($argsString, 0, -2);
 468                         } // END - if
 469                 } else {
 470                         // Invalid arguments!
 471                         $argsString = '!INVALID:' . gettype($args) . '!';
 472                 }
 473
 474                 // Output stub message
 475                 // @TODO __CLASS__ does always return BaseFrameworkSystem but not the extending (=child) class
 476                 self::createDebugInstance(__CLASS__)->debugOutput(sprintf('[unknown::%s:] Stub! Args: %s',
 477                         $methodName,
 478                         $argsString
 479                 ));
 480
 481                 // Return nothing
 482                 return NULL;
 483         }
 484
 485         /**
 486          * Getter for $realClass
 487          *
 488          * @return      $realClass The name of the real class (not BaseFrameworkSystem)
 489          */
 490         public function __toString () {
 491                 return $this->realClass;
 492         }
 493
 494         /**
 495          * Magic function to catch setting of missing but set class fields/attributes
 496          *
 497          * @param       $name   Name of the field/attribute
 498          * @param       $value  Value to store
 499          * @return      void
 500          */
 501         public final function __set ($name, $value) {
 502                 $this->debugBackTrace(sprintf('Tried to set a missing field. name=%s, value[%s]=%s',
 503                         $name,
 504                         gettype($value),
 505                         print_r($value, TRUE)
 506                 ));
 507         }
 508
 509         /**
 510          * Magic function to catch getting of missing fields/attributes
 511          *
 512          * @param       $name   Name of the field/attribute
 513          * @return      void
 514          */
 515         public final function __get ($name) {
 516                 $this->debugBackTrace(sprintf('Tried to get a missing field. name=%s',
 517                         $name
 518                 ));
 519         }
 520
 521         /**
 522          * Magic function to catch unsetting of missing fields/attributes
 523          *
 524          * @param       $name   Name of the field/attribute
 525          * @return      void
 526          */
 527         public final function __unset ($name) {
 528                 $this->debugBackTrace(sprintf('Tried to unset a missing field. name=%s',
 529                         $name
 530                 ));
 531         }
 532
 533         /**
 534          * Setter for the real class name
 535          *
 536          * @param       $realClass      Class name (string)
 537          * @return      void
 538          */
 539         public final function setRealClass ($realClass) {
 540                 // Set real class
 541                 $this->realClass = (string) $realClass;
 542         }
 543
 544         /**
 545          * Setter for database result instance
 546          *
 547          * @param       $resultInstance         An instance of a database result class
 548          * @return      void
 549          * @todo        SearchableResult and UpdateableResult shall have a super interface to use here
 550          */
 551         protected final function setResultInstance (SearchableResult $resultInstance) {
 552                 $this->resultInstance =  $resultInstance;
 553         }
 554
 555         /**
 556          * Getter for database result instance
 557          *
 558          * @return      $resultInstance         An instance of a database result class
 559          */
 560         public final function getResultInstance () {
 561                 return $this->resultInstance;
 562         }
 563
 564         /**
 565          * Setter for template engine instances
 566          *
 567          * @param       $templateInstance       An instance of a template engine class
 568          * @return      void
 569          */
 570         protected final function setTemplateInstance (CompileableTemplate $templateInstance) {
 571                 $this->templateInstance = $templateInstance;
 572         }
 573
 574         /**
 575          * Getter for template engine instances
 576          *
 577          * @return      $templateInstance       An instance of a template engine class
 578          */
 579         protected final function getTemplateInstance () {
 580                 return $this->templateInstance;
 581         }
 582
 583         /**
 584          * Setter for search instance
 585          *
 586          * @param       $searchInstance         Searchable criteria instance
 587          * @return      void
 588          */
 589         public final function setSearchInstance (LocalSearchCriteria $searchInstance) {
 590                 $this->searchInstance = $searchInstance;
 591         }
 592
 593         /**
 594          * Getter for search instance
 595          *
 596          * @return      $searchInstance         Searchable criteria instance
 597          */
 598         public final function getSearchInstance () {
 599                 return $this->searchInstance;
 600         }
 601
 602         /**
 603          * Setter for update instance
 604          *
 605          * @param       $updateInstance         Searchable criteria instance
 606          * @return      void
 607          */
 608         public final function setUpdateInstance (LocalUpdateCriteria $updateInstance) {
 609                 $this->updateInstance = $updateInstance;
 610         }
 611
 612         /**
 613          * Getter for update instance
 614          *
 615          * @return      $updateInstance         Updateable criteria instance
 616          */
 617         public final function getUpdateInstance () {
 618                 return $this->updateInstance;
 619         }
 620
 621         /**
 622          * Setter for resolver instance
 623          *
 624          * @param       $resolverInstance       Instance of a command resolver class
 625          * @return      void
 626          */
 627         public final function setResolverInstance (Resolver $resolverInstance) {
 628                 $this->resolverInstance = $resolverInstance;
 629         }
 630
 631         /**
 632          * Getter for resolver instance
 633          *
 634          * @return      $resolverInstance       Instance of a command resolver class
 635          */
 636         public final function getResolverInstance () {
 637                 return $this->resolverInstance;
 638         }
 639
 640         /**
 641          * Setter for language instance
 642          *
 643          * @param       $configInstance         The configuration instance which shall
 644          *                                                              be FrameworkConfiguration
 645          * @return      void
 646          */
 647         public final function setConfigInstance (FrameworkConfiguration $configInstance) {
 648                 Registry::getRegistry()->addInstance('config', $configInstance);
 649         }
 650
 651         /**
 652          * Getter for configuration instance
 653          *
 654          * @return      $configInstance         Configuration instance
 655          */
 656         public final function getConfigInstance () {
 657                 $configInstance = Registry::getRegistry()->getInstance('config');
 658                 return $configInstance;
 659         }
 660
 661         /**
 662          * Setter for debug instance
 663          *
 664          * @param       $debugInstance  The instance for debug output class
 665          * @return      void
 666          */
 667         public final function setDebugInstance (DebugMiddleware $debugInstance) {
 668                 Registry::getRegistry()->addInstance('debug', $debugInstance);
 669         }
 670
 671         /**
 672          * Getter for debug instance
 673          *
 674          * @return      $debugInstance  Instance to class DebugConsoleOutput or DebugWebOutput
 675          */
 676         public final function getDebugInstance () {
 677                 // Get debug instance
 678                 $debugInstance = Registry::getRegistry()->getInstance('debug');
 679
 680                 // Return it
 681                 return $debugInstance;
 682         }
 683
 684         /**
 685          * Setter for web output instance
 686          *
 687          * @param       $webInstance    The instance for web output class
 688          * @return      void
 689          */
 690         public final function setWebOutputInstance (OutputStreamer $webInstance) {
 691                 Registry::getRegistry()->addInstance('web_output', $webInstance);
 692         }
 693
 694         /**
 695          * Getter for web output instance
 696          *
 697          * @return      $webOutputInstance - Instance to class WebOutput
 698          */
 699         public final function getWebOutputInstance () {
 700                 $webOutputInstance = Registry::getRegistry()->getInstance('web_output');
 701                 return $webOutputInstance;
 702         }
 703
 704         /**
 705          * Setter for database instance
 706          *
 707          * @param       $databaseInstance       The instance for the database connection (forced DatabaseConnection)
 708          * @return      void
 709          */
 710         public final function setDatabaseInstance (DatabaseConnection $databaseInstance) {
 711                 Registry::getRegistry()->addInstance('db_instance', $databaseInstance);
 712         }
 713
 714         /**
 715          * Getter for database layer
 716          *
 717          * @return      $databaseInstance       The database layer instance
 718          */
 719         public final function getDatabaseInstance () {
 720                 // Get instance
 721                 $databaseInstance = Registry::getRegistry()->getInstance('db_instance');
 722
 723                 // Return instance
 724                 return $databaseInstance;
 725         }
 726
 727         /**
 728          * Setter for compressor channel
 729          *
 730          * @param       $compressorInstance             An instance of CompressorChannel
 731          * @return      void
 732          */
 733         public final function setCompressorChannel (CompressorChannel $compressorInstance) {
 734                 Registry::getRegistry()->addInstance('compressor', $compressorInstance);
 735         }
 736
 737         /**
 738          * Getter for compressor channel
 739          *
 740          * @return      $compressorInstance             The compressor channel
 741          */
 742         public final function getCompressorChannel () {
 743                 $compressorInstance = Registry::getRegistry()->getInstance('compressor');
 744                 return $compressorInstance;
 745         }
 746
 747         /**
 748          * Protected getter for a manageable application helper class
 749          *
 750          * @return      $applicationInstance    An instance of a manageable application helper class
 751          */
 752         protected final function getApplicationInstance () {
 753                 $applicationInstance = Registry::getRegistry()->getInstance('application');
 754                 return $applicationInstance;
 755         }
 756
 757         /**
 758          * Setter for a manageable application helper class
 759          *
 760          * @param       $applicationInstance    An instance of a manageable application helper class
 761          * @return      void
 762          */
 763         public final function setApplicationInstance (ManageableApplication $applicationInstance) {
 764                 Registry::getRegistry()->addInstance('application', $applicationInstance);
 765         }
 766
 767         /**
 768          * Setter for request instance
 769          *
 770          * @param       $requestInstance        An instance of a Requestable class
 771          * @return      void
 772          */
 773         public final function setRequestInstance (Requestable $requestInstance) {
 774                 $this->requestInstance = $requestInstance;
 775         }
 776
 777         /**
 778          * Getter for request instance
 779          *
 780          * @return      $requestInstance        An instance of a Requestable class
 781          */
 782         public final function getRequestInstance () {
 783                 return $this->requestInstance;
 784         }
 785
 786         /**
 787          * Setter for response instance
 788          *
 789          * @param       $responseInstance       An instance of a Responseable class
 790          * @return      void
 791          */
 792         public final function setResponseInstance (Responseable $responseInstance) {
 793                 $this->responseInstance = $responseInstance;
 794         }
 795
 796         /**
 797          * Getter for response instance
 798          *
 799          * @return      $responseInstance       An instance of a Responseable class
 800          */
 801         public final function getResponseInstance () {
 802                 return $this->responseInstance;
 803         }
 804
 805         /**
 806          * Private getter for language instance
 807          *
 808          * @return      $langInstance   An instance to the language sub-system
 809          */
 810         protected final function getLanguageInstance () {
 811                 $langInstance = Registry::getRegistry()->getInstance('language');
 812                 return $langInstance;
 813         }
 814
 815         /**
 816          * Setter for language instance
 817          *
 818          * @param       $langInstance   An instance to the language sub-system
 819          * @return      void
 820          * @see         LanguageSystem
 821          */
 822         public final function setLanguageInstance (ManageableLanguage $langInstance) {
 823                 Registry::getRegistry()->addInstance('language', $langInstance);
 824         }
 825
 826         /**
 827          * Private getter for file IO instance
 828          *
 829          * @return      $fileIoInstance         An instance to the file I/O sub-system
 830          */
 831         protected final function getFileIoInstance () {
 832                 return $this->fileIoInstance;
 833         }
 834
 835         /**
 836          * Setter for file I/O instance
 837          *
 838          * @param       $fileIoInstance         An instance to the file I/O sub-system
 839          * @return      void
 840          */
 841         public final function setFileIoInstance (IoHandler $fileIoInstance) {
 842                 $this->fileIoInstance = $fileIoInstance;
 843         }
 844
 845         /**
 846          * Protected setter for user instance
 847          *
 848          * @param       $userInstance   An instance of a user class
 849          * @return      void
 850          */
 851         protected final function setUserInstance (ManageableAccount $userInstance) {
 852                 $this->userInstance = $userInstance;
 853         }
 854
 855         /**
 856          * Getter for user instance
 857          *
 858          * @return      $userInstance   An instance of a user class
 859          */
 860         public final function getUserInstance () {
 861                 return $this->userInstance;
 862         }
 863
 864         /**
 865          * Setter for controller instance (this surely breaks a bit the MVC patterm)
 866          *
 867          * @param       $controllerInstance             An instance of the controller
 868          * @return      void
 869          */
 870         public final function setControllerInstance (Controller $controllerInstance) {
 871                 $this->controllerInstance = $controllerInstance;
 872         }
 873
 874         /**
 875          * Getter for controller instance (this surely breaks a bit the MVC patterm)
 876          *
 877          * @return      $controllerInstance             An instance of the controller
 878          */
 879         public final function getControllerInstance () {
 880                 return $this->controllerInstance;
 881         }
 882
 883         /**
 884          * Setter for RNG instance
 885          *
 886          * @param       $rngInstance    An instance of a random number generator (RNG)
 887          * @return      void
 888          */
 889         protected final function setRngInstance (RandomNumberGenerator $rngInstance) {
 890                 $this->rngInstance = $rngInstance;
 891         }
 892
 893         /**
 894          * Getter for RNG instance
 895          *
 896          * @return      $rngInstance    An instance of a random number generator (RNG)
 897          */
 898         public final function getRngInstance () {
 899                 return $this->rngInstance;
 900         }
 901
 902         /**
 903          * Setter for Cryptable instance
 904          *
 905          * @param       $cryptoInstance An instance of a Cryptable class
 906          * @return      void
 907          */
 908         protected final function setCryptoInstance (Cryptable $cryptoInstance) {
 909                 $this->cryptoInstance = $cryptoInstance;
 910         }
 911
 912         /**
 913          * Getter for Cryptable instance
 914          *
 915          * @return      $cryptoInstance An instance of a Cryptable class
 916          */
 917         public final function getCryptoInstance () {
 918                 return $this->cryptoInstance;
 919         }
 920
 921         /**
 922          * Setter for the list instance
 923          *
 924          * @param       $listInstance   A list of Listable
 925          * @return      void
 926          */
 927         protected final function setListInstance (Listable $listInstance) {
 928                 $this->listInstance = $listInstance;
 929         }
 930
 931         /**
 932          * Getter for the list instance
 933          *
 934          * @return      $listInstance   A list of Listable
 935          */
 936         protected final function getListInstance () {
 937                 return $this->listInstance;
 938         }
 939
 940         /**
 941          * Setter for the menu instance
 942          *
 943          * @param       $menuInstance   A RenderableMenu instance
 944          * @return      void
 945          */
 946         protected final function setMenuInstance (RenderableMenu $menuInstance) {
 947                 $this->menuInstance = $menuInstance;
 948         }
 949
 950         /**
 951          * Getter for the menu instance
 952          *
 953          * @return      $menuInstance   A RenderableMenu instance
 954          */
 955         protected final function getMenuInstance () {
 956                 return $this->menuInstance;
 957         }
 958
 959         /**
 960          * Setter for image instance
 961          *
 962          * @param       $imageInstance  An instance of an image
 963          * @return      void
 964          */
 965         public final function setImageInstance (BaseImage $imageInstance) {
 966                 $this->imageInstance = $imageInstance;
 967         }
 968
 969         /**
 970          * Getter for image instance
 971          *
 972          * @return      $imageInstance  An instance of an image
 973          */
 974         public final function getImageInstance () {
 975                 return $this->imageInstance;
 976         }
 977
 978         /**
 979          * Setter for stacker instance
 980          *
 981          * @param       $stackInstance  An instance of an stacker
 982          * @return      void
 983          */
 984         public final function setStackInstance (Stackable $stackInstance) {
 985                 $this->stackInstance = $stackInstance;
 986         }
 987
 988         /**
 989          * Getter for stacker instance
 990          *
 991          * @return      $stackInstance  An instance of an stacker
 992          */
 993         public final function getStackInstance () {
 994                 return $this->stackInstance;
 995         }
 996
 997         /**
 998          * Setter for compressor instance
 999          *
1000          * @param       $compressorInstance     An instance of an compressor
1001          * @return      void
1002          */
1003         public final function setCompressorInstance (Compressor $compressorInstance) {
1004                 $this->compressorInstance = $compressorInstance;
1005         }
1006
1007         /**
1008          * Getter for compressor instance
1009          *
1010          * @return      $compressorInstance     An instance of an compressor
1011          */
1012         public final function getCompressorInstance () {
1013                 return $this->compressorInstance;
1014         }
1015
1016         /**
1017          * Setter for Parseable instance
1018          *
1019          * @param       $parserInstance An instance of an Parseable
1020          * @return      void
1021          */
1022         public final function setParserInstance (Parseable $parserInstance) {
1023                 $this->parserInstance = $parserInstance;
1024         }
1025
1026         /**
1027          * Getter for Parseable instance
1028          *
1029          * @return      $parserInstance An instance of an Parseable
1030          */
1031         public final function getParserInstance () {
1032                 return $this->parserInstance;
1033         }
1034
1035         /**
1036          * Setter for HandleableProtocol instance
1037          *
1038          * @param       $protocolInstance       An instance of an HandleableProtocol
1039          * @return      void
1040          */
1041         public final function setProtocolInstance (HandleableProtocol $protocolInstance = NULL) {
1042                 $this->protocolInstance = $protocolInstance;
1043         }
1044
1045         /**
1046          * Getter for HandleableProtocol instance
1047          *
1048          * @return      $protocolInstance       An instance of an HandleableProtocol
1049          */
1050         public final function getProtocolInstance () {
1051                 return $this->protocolInstance;
1052         }
1053
1054         /**
1055          * Setter for DatabaseWrapper instance
1056          *
1057          * @param       $wrapperInstance        An instance of an DatabaseWrapper
1058          * @return      void
1059          */
1060         public final function setWrapperInstance (DatabaseWrapper $wrapperInstance) {
1061                 $this->wrapperInstance = $wrapperInstance;
1062         }
1063
1064         /**
1065          * Getter for DatabaseWrapper instance
1066          *
1067          * @return      $wrapperInstance        An instance of an DatabaseWrapper
1068          */
1069         public final function getWrapperInstance () {
1070                 return $this->wrapperInstance;
1071         }
1072
1073         /**
1074          * Setter for socket resource
1075          *
1076          * @param       $socketResource         A valid socket resource
1077          * @return      void
1078          */
1079         public final function setSocketResource ($socketResource) {
1080                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . '::' . __FUNCTION__ . ': socketResource=' . $socketResource . ',previous[' . gettype($this->socketResource) . ']=' . $this->socketResource);
1081                 $this->socketResource = $socketResource;
1082         }
1083
1084         /**
1085          * Getter for socket resource
1086          *
1087          * @return      $socketResource         A valid socket resource
1088          */
1089         public final function getSocketResource () {
1090                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . '::' . __FUNCTION__ . ': socketResource[' . gettype($this->socketResource) . ']=' . $this->socketResource);
1091                 return $this->socketResource;
1092         }
1093
1094         /**
1095          * Setter for regular expression
1096          *
1097          * @param       $regularExpression      A valid regular expression
1098          * @return      void
1099          */
1100         public final function setRegularExpression ($regularExpression) {
1101                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . '::' . __FUNCTION__ . ': regularExpression=' . $regularExpression . ',previous[' . gettype($this->regularExpression) . ']=' . $this->regularExpression);
1102                 $this->regularExpression = $regularExpression;
1103         }
1104
1105         /**
1106          * Getter for regular expression
1107          *
1108          * @return      $regularExpression      A valid regular expression
1109          */
1110         public final function getRegularExpression () {
1111                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . '::' . __FUNCTION__ . ': regularExpression[' . gettype($this->regularExpression) . ']=' . $this->regularExpression);
1112                 return $this->regularExpression;
1113         }
1114
1115         /**
1116          * Setter for helper instance
1117          *
1118          * @param       $helperInstance         An instance of a helper class
1119          * @return      void
1120          */
1121         protected final function setHelperInstance (Helper $helperInstance) {
1122                 $this->helperInstance = $helperInstance;
1123         }
1124
1125         /**
1126          * Getter for helper instance
1127          *
1128          * @return      $helperInstance         An instance of a helper class
1129          */
1130         public final function getHelperInstance () {
1131                 return $this->helperInstance;
1132         }
1133
1134         /**
1135          * Setter for a Sourceable instance
1136          *
1137          * @param       $sourceInstance         An instance of a Sourceable class
1138          * @return      void
1139          */
1140         protected final function setSourceInstance (Sourceable $sourceInstance) {
1141                 $this->sourceInstance = $sourceInstance;
1142         }
1143
1144         /**
1145          * Getter for a Sourceable instance
1146          *
1147          * @return      $sourceInstance         An instance of a Sourceable class
1148          */
1149         protected final function getSourceInstance () {
1150                 return $this->sourceInstance;
1151         }
1152
1153         /**
1154          * Setter for a UrlSource instance
1155          *
1156          * @param       $sourceInstance         An instance of a UrlSource class
1157          * @return      void
1158          */
1159         protected final function setUrlSourceInstance (UrlSource $urlSourceInstance) {
1160                 $this->urlSourceInstance = $urlSourceInstance;
1161         }
1162
1163         /**
1164          * Getter for a UrlSource instance
1165          *
1166          * @return      $urlSourceInstance              An instance of a UrlSource class
1167          */
1168         protected final function getUrlSourceInstance () {
1169                 return $this->urlSourceInstance;
1170         }
1171
1172         /**
1173          * Getter for a InputStream instance
1174          *
1175          * @param       $inputStreamInstance    The InputStream instance
1176          */
1177         protected final function getInputStreamInstance () {
1178                 return $this->inputStreamInstance;
1179         }
1180
1181         /**
1182          * Setter for a InputStream instance
1183          *
1184          * @param       $inputStreamInstance    The InputStream instance
1185          * @return      void
1186          */
1187         protected final function setInputStreamInstance (InputStream $inputStreamInstance) {
1188                 $this->inputStreamInstance = $inputStreamInstance;
1189         }
1190
1191         /**
1192          * Getter for a OutputStream instance
1193          *
1194          * @param       $outputStreamInstance   The OutputStream instance
1195          */
1196         protected final function getOutputStreamInstance () {
1197                 return $this->outputStreamInstance;
1198         }
1199
1200         /**
1201          * Setter for a OutputStream instance
1202          *
1203          * @param       $outputStreamInstance   The OutputStream instance
1204          * @return      void
1205          */
1206         protected final function setOutputStreamInstance (OutputStream $outputStreamInstance) {
1207                 $this->outputStreamInstance = $outputStreamInstance;
1208         }
1209
1210         /**
1211          * Setter for handler instance
1212          *
1213          * @param       $handlerInstance        An instance of a Handleable class
1214          * @return      void
1215          */
1216         protected final function setHandlerInstance (Handleable $handlerInstance) {
1217                 $this->handlerInstance = $handlerInstance;
1218         }
1219
1220         /**
1221          * Getter for handler instance
1222          *
1223          * @return      $handlerInstance        A Networkable instance
1224          */
1225         protected final function getHandlerInstance () {
1226                 return $this->handlerInstance;
1227         }
1228
1229         /**
1230          * Setter for visitor instance
1231          *
1232          * @param       $visitorInstance        A Visitor instance
1233          * @return      void
1234          */
1235         protected final function setVisitorInstance (Visitor $visitorInstance) {
1236                 $this->visitorInstance = $visitorInstance;
1237         }
1238
1239         /**
1240          * Getter for visitor instance
1241          *
1242          * @return      $visitorInstance        A Visitor instance
1243          */
1244         protected final function getVisitorInstance () {
1245                 return $this->visitorInstance;
1246         }
1247
1248         /**
1249          * Setter for DHT instance
1250          *
1251          * @param       $dhtInstance    A Distributable instance
1252          * @return      void
1253          */
1254         protected final function setDhtInstance (Distributable $dhtInstance) {
1255                 $this->dhtInstance = $dhtInstance;
1256         }
1257
1258         /**
1259          * Getter for DHT instance
1260          *
1261          * @return      $dhtInstance    A Distributable instance
1262          */
1263         protected final function getDhtInstance () {
1264                 return $this->dhtInstance;
1265         }
1266
1267         /**
1268          * Setter for raw package Data
1269          *
1270          * @param       $packageData    Raw package Data
1271          * @return      void
1272          */
1273         public final function setPackageData (array $packageData) {
1274                 $this->packageData = $packageData;
1275         }
1276
1277         /**
1278          * Getter for raw package Data
1279          *
1280          * @return      $packageData    Raw package Data
1281          */
1282         public function getPackageData () {
1283                 return $this->packageData;
1284         }
1285
1286
1287         /**
1288          * Setter for Iterator instance
1289          *
1290          * @param       $iteratorInstance       An instance of an Iterator
1291          * @return      void
1292          */
1293         protected final function setIteratorInstance (Iterator $iteratorInstance) {
1294                 $this->iteratorInstance = $iteratorInstance;
1295         }
1296
1297         /**
1298          * Getter for Iterator instance
1299          *
1300          * @return      $iteratorInstance       An instance of an Iterator
1301          */
1302         public final function getIteratorInstance () {
1303                 return $this->iteratorInstance;
1304         }
1305
1306         /**
1307          * Setter for FilePointer instance
1308          *
1309          * @param       $pointerInstance        An instance of an FilePointer class
1310          * @return      void
1311          */
1312         protected final function setPointerInstance (FilePointer $pointerInstance) {
1313                 $this->pointerInstance = $pointerInstance;
1314         }
1315
1316         /**
1317          * Getter for FilePointer instance
1318          *
1319          * @return      $pointerInstance        An instance of an FilePointer class
1320          */
1321         public final function getPointerInstance () {
1322                 return $this->pointerInstance;
1323         }
1324
1325         /**
1326          * Setter for Indexable instance
1327          *
1328          * @param       $indexInstance  An instance of an Indexable class
1329          * @return      void
1330          */
1331         protected final function setIndexInstance (Indexable $indexInstance) {
1332                 $this->indexInstance = $indexInstance;
1333         }
1334
1335         /**
1336          * Getter for Indexable instance
1337          *
1338          * @return      $indexInstance  An instance of an Indexable class
1339          */
1340         public final function getIndexInstance () {
1341                 return $this->indexInstance;
1342         }
1343
1344         /**
1345          * Setter for Block instance
1346          *
1347          * @param       $blockInstance  An instance of an Block class
1348          * @return      void
1349          */
1350         protected final function setBlockInstance (Block $blockInstance) {
1351                 $this->blockInstance = $blockInstance;
1352         }
1353
1354         /**
1355          * Getter for Block instance
1356          *
1357          * @return      $blockInstance  An instance of an Block class
1358          */
1359         public final function getBlockInstance () {
1360                 return $this->blockInstance;
1361         }
1362
1363         /**
1364          * Setter for Minable instance
1365          *
1366          * @param       $minableInstance        A Minable instance
1367          * @return      void
1368          */
1369         protected final function setMinableInstance (Minable $minableInstance) {
1370                 $this->minableInstance = $minableInstance;
1371         }
1372
1373         /**
1374          * Getter for minable instance
1375          *
1376          * @return      $minableInstance        A Minable instance
1377          */
1378         protected final function getMinableInstance () {
1379                 return $this->minableInstance;
1380         }
1381
1382         /**
1383          * Setter for FrameworkDirectory instance
1384          *
1385          * @param       $directoryInstance      A FrameworkDirectoryPointer instance
1386          * @return      void
1387          */
1388         protected final function setDirectoryInstance (FrameworkDirectory $directoryInstance) {
1389                 $this->directoryInstance = $directoryInstance;
1390         }
1391
1392         /**
1393          * Getter for FrameworkDirectory instance
1394          *
1395          * @return      $directoryInstance      A FrameworkDirectory instance
1396          */
1397         protected final function getDirectoryInstance () {
1398                 return $this->directoryInstance;
1399         }
1400
1401         /**
1402          * Setter for listener instance
1403          *
1404          * @param       $listenerInstance       A Listenable instance
1405          * @return      void
1406          */
1407         protected final function setListenerInstance (Listenable $listenerInstance) {
1408                 $this->listenerInstance = $listenerInstance;
1409         }
1410
1411         /**
1412          * Getter for listener instance
1413          *
1414          * @return      $listenerInstance       A Listenable instance
1415          */
1416         protected final function getListenerInstance () {
1417                 return $this->listenerInstance;
1418         }
1419
1420         /**
1421          * Checks whether an object equals this object. You should overwrite this
1422          * method to implement own equality checks
1423          *
1424          * @param       $objectInstance         An instance of a FrameworkInterface object
1425          * @return      $equals                         Whether both objects equals
1426          */
1427         public function equals (FrameworkInterface $objectInstance) {
1428                 // Now test it
1429                 $equals = ((
1430                         $this->__toString() == $objectInstance->__toString()
1431                 ) && (
1432                         $this->hashCode() == $objectInstance->hashCode()
1433                 ));
1434
1435                 // Return the result
1436                 return $equals;
1437         }
1438
1439         /**
1440          * Generates a generic hash code of this class. You should really overwrite
1441          * this method with your own hash code generator code. But keep KISS in mind.
1442          *
1443          * @return      $hashCode       A generic hash code respresenting this whole class
1444          */
1445         public function hashCode () {
1446                 // Simple hash code
1447                 return crc32($this->__toString());
1448         }
1449
1450         /**
1451          * Formats computer generated price values into human-understandable formats
1452          * with thousand and decimal separators.
1453          *
1454          * @param       $value          The in computer format value for a price
1455          * @param       $currency       The currency symbol (use HTML-valid characters!)
1456          * @param       $decNum         Number of decimals after commata
1457          * @return      $price          The for the current language formated price string
1458          * @throws      MissingDecimalsThousandsSeparatorException      If decimals or
1459          *                                                                                              thousands separator
1460          *                                                                                              is missing
1461          */
1462         public function formatCurrency ($value, $currency = '&euro;', $decNum = 2) {
1463                 // Are all required attriutes set?
1464                 if ((!isset($this->decimals)) || (!isset($this->thousands))) {
1465                         // Throw an exception
1466                         throw new MissingDecimalsThousandsSeparatorException($this, self::EXCEPTION_ATTRIBUTES_ARE_MISSING);
1467                 } // END - if
1468
1469                 // Cast the number
1470                 $value = (float) $value;
1471
1472                 // Reformat the US number
1473                 $price = number_format($value, $decNum, $this->decimals, $this->thousands) . $currency;
1474
1475                 // Return as string...
1476                 return $price;
1477         }
1478
1479         /**
1480          * Appends a trailing slash to a string
1481          *
1482          * @param       $str    A string (maybe) without trailing slash
1483          * @return      $str    A string with an auto-appended trailing slash
1484          */
1485         public final function addMissingTrailingSlash ($str) {
1486                 // Is there a trailing slash?
1487                 if (substr($str, -1, 1) != '/') {
1488                         $str .= '/';
1489                 } // END - if
1490
1491                 // Return string with trailing slash
1492                 return $str;
1493         }
1494
1495         /**
1496          * Prepare the template engine (WebTemplateEngine by default) for a given
1497          * application helper instance (ApplicationHelper by default).
1498          *
1499          * @param               $applicationInstance    An application helper instance or
1500          *                                                                              null if we shall use the default
1501          * @return              $templateInstance               The template engine instance
1502          * @throws              NullPointerException    If the discovered application
1503          *                                                                              instance is still null
1504          */
1505         protected function prepareTemplateInstance (ManageableApplication $applicationInstance = NULL) {
1506                 // Is the application instance set?
1507                 if (is_null($applicationInstance)) {
1508                         // Get the current instance
1509                         $applicationInstance = $this->getApplicationInstance();
1510
1511                         // Still null?
1512                         if (is_null($applicationInstance)) {
1513                                 // Thrown an exception
1514                                 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
1515                         } // END - if
1516                 } // END - if
1517
1518                 // Initialize the template engine
1519                 $templateInstance = ObjectFactory::createObjectByConfiguredName('web_template_class');
1520
1521                 // Return the prepared instance
1522                 return $templateInstance;
1523         }
1524
1525         /**
1526          * Debugs this instance by putting out it's full content
1527          *
1528          * @param       $message        Optional message to show in debug output
1529          * @return      void
1530          */
1531         public final function debugInstance ($message = '') {
1532                 // Restore the error handler to avoid trouble with missing array elements or undeclared variables
1533                 restore_error_handler();
1534
1535                 // Init content
1536                 $content = '';
1537
1538                 // Is a message set?
1539                 if (!empty($message)) {
1540                         // Construct message
1541                         $content = sprintf('<div class="debug_message">Message: %s</div>' . PHP_EOL, $message);
1542                 } // END - if
1543
1544                 // Generate the output
1545                 $content .= sprintf('<pre>%s</pre>',
1546                         trim(
1547                                 htmlentities(
1548                                         print_r($this, TRUE)
1549                                 )
1550                         )
1551                 );
1552
1553                 // Output it
1554                 ApplicationEntryPoint::app_exit(sprintf('<div class="debug_header">%s debug output:</div><div class="debug_content">%s</div>Loaded includes: <div class="debug_include_list">%s</div>',
1555                         $this->__toString(),
1556                         $content,
1557                         ClassLoader::getSelfInstance()->getPrintableIncludeList()
1558                 ));
1559         }
1560
1561         /**
1562          * Replaces control characters with printable output
1563          *
1564          * @param       $str    String with control characters
1565          * @return      $str    Replaced string
1566          */
1567         protected function replaceControlCharacters ($str) {
1568                 // Replace them
1569                 $str = str_replace(
1570                         chr(13), '[r]', str_replace(
1571                         chr(10), '[n]', str_replace(
1572                         chr(9) , '[t]',
1573                         $str
1574                 )));
1575
1576                 // Return it
1577                 return $str;
1578         }
1579
1580         /**
1581          * Output a partial stub message for the caller method
1582          *
1583          * @param       $message        An optional message to display
1584          * @return      void
1585          */
1586         protected function partialStub ($message = '') {
1587                 // Get the backtrace
1588                 $backtrace = debug_backtrace();
1589
1590                 // Generate the class::method string
1591                 $methodName = 'UnknownClass-&gt;unknownMethod';
1592                 if ((isset($backtrace[1]['class'])) && (isset($backtrace[1]['function']))) {
1593                         $methodName = $backtrace[1]['class'] . '-&gt;' . $backtrace[1]['function'];
1594                 } // END - if
1595
1596                 // Construct the full message
1597                 $stubMessage = sprintf('[%s:] Partial stub!',
1598                         $methodName
1599                 );
1600
1601                 // Is the extra message given?
1602                 if (!empty($message)) {
1603                         // Then add it as well
1604                         $stubMessage .= ' Message: ' . $message;
1605                 } // END - if
1606
1607                 // Debug instance is there?
1608                 if (!is_null($this->getDebugInstance())) {
1609                         // Output stub message
1610                         self::createDebugInstance(__CLASS__)->debugOutput($stubMessage);
1611                 } else {
1612                         // Trigger an error
1613                         trigger_error($stubMessage);
1614                         exit;
1615                 }
1616         }
1617
1618         /**
1619          * Outputs a debug backtrace and stops further script execution
1620          *
1621          * @param       $message        An optional message to output
1622          * @param       $doExit         Whether exit the program (TRUE is default)
1623          * @return      void
1624          */
1625         public function debugBackTrace ($message = '', $doExit = TRUE) {
1626                 // Sorry, there is no other way getting this nice backtrace
1627                 if (!empty($message)) {
1628                         // Output message
1629                         printf('Message: %s<br />' . chr(10), $message);
1630                 } // END - if
1631
1632                 print('<pre>');
1633                 debug_print_backtrace();
1634                 print('</pre>');
1635
1636                 // Exit program?
1637                 if ($doExit === TRUE) {
1638                         exit();
1639                 } // END - if
1640         }
1641
1642         /**
1643          * Creates an instance of a debugger instance
1644          *
1645          * @param       $className              Name of the class (currently unsupported)
1646          * @return      $debugInstance  An instance of a debugger class
1647          */
1648         public final static function createDebugInstance ($className) {
1649                 // Is the instance set?
1650                 if (!Registry::getRegistry()->instanceExists('debug')) {
1651                         // Init debug instance
1652                         $debugInstance = NULL;
1653
1654                         // Try it
1655                         try {
1656                                 // Get a debugger instance
1657                                 $debugInstance = DebugMiddleware::createDebugMiddleware(FrameworkConfiguration::getSelfInstance()->getConfigEntry('debug_class'));
1658                         } catch (NullPointerException $e) {
1659                                 // Didn't work, no instance there
1660                                 exit('Cannot create debugInstance! Exception=' . $e->__toString() . ', message=' . $e->getMessage());
1661                         }
1662
1663                         // Empty string should be ignored and used for testing the middleware
1664                         DebugMiddleware::getSelfInstance()->output('');
1665
1666                         // Set it in its own class. This will set it in the registry
1667                         $debugInstance->setDebugInstance($debugInstance);
1668                 } else {
1669                         // Get instance from registry
1670                         $debugInstance = Registry::getRegistry()->getDebugInstance();
1671                 }
1672
1673                 // Return it
1674                 return $debugInstance;
1675         }
1676
1677         /**
1678          * Simple output of a message with line-break
1679          *
1680          * @param       $message        Message to output
1681          * @return      void
1682          */
1683         public function outputLine ($message) {
1684                 // Simply output it
1685                 print($message . PHP_EOL);
1686         }
1687
1688         /**
1689          * Outputs a debug message whether to debug instance (should be set!) or
1690          * dies with or ptints the message. Do NEVER EVER rewrite the exit() call to
1691          * ApplicationEntryPoint::app_exit(), this would cause an endless loop.
1692          *
1693          * @param       $message        Message we shall send out...
1694          * @param       $doPrint        Whether print or die here (default: print)
1695          * @paran       $stripTags      Whether to strip tags (default: FALSE)
1696          * @return      void
1697          */
1698         public function debugOutput ($message, $doPrint = TRUE, $stripTags = FALSE) {
1699                 // Set debug instance to NULL
1700                 $debugInstance = NULL;
1701
1702                 // Try it:
1703                 try {
1704                         // Get debug instance
1705                         $debugInstance = $this->getDebugInstance();
1706                 } catch (NullPointerException $e) {
1707                         // The debug instance is not set (yet)
1708                 }
1709
1710                 // Is the debug instance there?
1711                 if (is_object($debugInstance)) {
1712                         // Use debug output handler
1713                         $debugInstance->output($message, $stripTags);
1714
1715                         if ($doPrint === FALSE) {
1716                                 // Die here if not printed
1717                                 exit();
1718                         } // END - if
1719                 } else {
1720                         // Are debug times enabled?
1721                         if ($this->getConfigInstance()->getConfigEntry('debug_output_timings') == 'Y') {
1722                                 // Prepent it
1723                                 $message = $this->getPrintableExecutionTime() . $message;
1724                         } // END - if
1725
1726                         // Put directly out
1727                         if ($doPrint === TRUE) {
1728                                 // Print message
1729                                 $this->outputLine($message);
1730                         } else {
1731                                 // Die here
1732                                 exit($message);
1733                         }
1734                 }
1735         }
1736
1737         /**
1738          * Converts e.g. a command from URL to a valid class by keeping out bad characters
1739          *
1740          * @param       $str            The string, what ever it is needs to be converted
1741          * @return      $className      Generated class name
1742          */
1743         public function convertToClassName ($str) {
1744                 // Init class name
1745                 $className = '';
1746
1747                 // Convert all dashes in underscores
1748                 $str = $this->convertDashesToUnderscores($str);
1749
1750                 // Now use that underscores to get classname parts for hungarian style
1751                 foreach (explode('_', $str) as $strPart) {
1752                         // Make the class name part lower case and first upper case
1753                         $className .= ucfirst(strtolower($strPart));
1754                 } // END - foreach
1755
1756                 // Return class name
1757                 return $className;
1758         }
1759
1760         /**
1761          * Converts dashes to underscores, e.g. useable for configuration entries
1762          *
1763          * @param       $str    The string with maybe dashes inside
1764          * @return      $str    The converted string with no dashed, but underscores
1765          */
1766         public final function convertDashesToUnderscores ($str) {
1767                 // Convert them all
1768                 $str = str_replace('-', '_', $str);
1769
1770                 // Return converted string
1771                 return $str;
1772         }
1773
1774         /**
1775          * Marks up the code by adding e.g. line numbers
1776          *
1777          * @param       $phpCode                Unmarked PHP code
1778          * @return      $markedCode             Marked PHP code
1779          */
1780         public function markupCode ($phpCode) {
1781                 // Init marked code
1782                 $markedCode = '';
1783
1784                 // Get last error
1785                 $errorArray = error_get_last();
1786
1787                 // Init the code with error message
1788                 if (is_array($errorArray)) {
1789                         // Get error infos
1790                         $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>',
1791                                 basename($errorArray['file']),
1792                                 $errorArray['line'],
1793                                 $errorArray['message'],
1794                                 $errorArray['type']
1795                         );
1796                 } // END - if
1797
1798                 // Add line number to the code
1799                 foreach (explode(chr(10), $phpCode) as $lineNo => $code) {
1800                         // Add line numbers
1801                         $markedCode .= sprintf('<span id="code_line">%s</span>: %s' . chr(10),
1802                                 ($lineNo + 1),
1803                                 htmlentities($code, ENT_QUOTES)
1804                         );
1805                 } // END - foreach
1806
1807                 // Return the code
1808                 return $markedCode;
1809         }
1810
1811         /**
1812          * Filter a given GMT timestamp (non Uni* stamp!) to make it look more
1813          * beatiful for web-based front-ends. If null is given a message id
1814          * null_timestamp will be resolved and returned.
1815          *
1816          * @param       $timestamp      Timestamp to prepare (filter) for display
1817          * @return      $readable       A readable timestamp
1818          */
1819         public function doFilterFormatTimestamp ($timestamp) {
1820                 // Default value to return
1821                 $readable = '???';
1822
1823                 // Is the timestamp null?
1824                 if (is_null($timestamp)) {
1825                         // Get a message string
1826                         $readable = $this->getLanguageInstance()->getMessage('null_timestamp');
1827                 } else {
1828                         switch ($this->getLanguageInstance()->getLanguageCode()) {
1829                                 case 'de': // German format is a bit different to default
1830                                         // Split the GMT stamp up
1831                                         $dateTime  = explode(' ', $timestamp  );
1832                                         $dateArray = explode('-', $dateTime[0]);
1833                                         $timeArray = explode(':', $dateTime[1]);
1834
1835                                         // Construct the timestamp
1836                                         $readable = sprintf($this->getConfigInstance()->getConfigEntry('german_date_time'),
1837                                                 $dateArray[0],
1838                                                 $dateArray[1],
1839                                                 $dateArray[2],
1840                                                 $timeArray[0],
1841                                                 $timeArray[1],
1842                                                 $timeArray[2]
1843                                         );
1844                                         break;
1845
1846                                 default: // Default is pass-through
1847                                         $readable = $timestamp;
1848                                         break;
1849                         } // END - switch
1850                 }
1851
1852                 // Return the stamp
1853                 return $readable;
1854         }
1855
1856         /**
1857          * Filter a given number into a localized number
1858          *
1859          * @param       $value          The raw value from e.g. database
1860          * @return      $localized      Localized value
1861          */
1862         public function doFilterFormatNumber ($value) {
1863                 // Generate it from config and localize dependencies
1864                 switch ($this->getLanguageInstance()->getLanguageCode()) {
1865                         case 'de': // German format is a bit different to default
1866                                 $localized = number_format($value, $this->getConfigInstance()->getConfigEntry('decimals'), ',', '.');
1867                                 break;
1868
1869                         default: // US, etc.
1870                                 $localized = number_format($value, $this->getConfigInstance()->getConfigEntry('decimals'), '.', ',');
1871                                 break;
1872                 } // END - switch
1873
1874                 // Return it
1875                 return $localized;
1876         }
1877
1878         /**
1879          * "Getter" for databse entry
1880          *
1881          * @return      $entry  An array with database entries
1882          * @throws      NullPointerException    If the database result is not found
1883          * @throws      InvalidDatabaseResultException  If the database result is invalid
1884          */
1885         protected final function getDatabaseEntry () {
1886                 // Is there an instance?
1887                 if (is_null($this->getResultInstance())) {
1888                         // Throw an exception here
1889                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
1890                 } // END - if
1891
1892                 // Rewind it
1893                 $this->getResultInstance()->rewind();
1894
1895                 // Do we have an entry?
1896                 if ($this->getResultInstance()->valid() === FALSE) {
1897                         // @TODO Move the constant to e.g. BaseDatabaseResult when there is a non-cached database result available
1898                         throw new InvalidDatabaseResultException(array($this, $this->getResultInstance()), CachedDatabaseResult::EXCEPTION_INVALID_DATABASE_RESULT);
1899                 } // END - if
1900
1901                 // Get next entry
1902                 $this->getResultInstance()->next();
1903
1904                 // Fetch it
1905                 $entry = $this->getResultInstance()->current();
1906
1907                 // And return it
1908                 return $entry;
1909         }
1910
1911         /**
1912          * Getter for field name
1913          *
1914          * @param       $fieldName              Field name which we shall get
1915          * @return      $fieldValue             Field value from the user
1916          * @throws      NullPointerException    If the result instance is null
1917          */
1918         public final function getField ($fieldName) {
1919                 // Default field value
1920                 $fieldValue = NULL;
1921
1922                 // Get result instance
1923                 $resultInstance = $this->getResultInstance();
1924
1925                 // Is this instance null?
1926                 if (is_null($resultInstance)) {
1927                         // Then the user instance is no longer valid (expired cookies?)
1928                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
1929                 } // END - if
1930
1931                 // Get current array
1932                 $fieldArray = $resultInstance->current();
1933                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($fieldName.':<pre>'.print_r($fieldArray, TRUE).'</pre>');
1934
1935                 // Convert dashes to underscore
1936                 $fieldName = $this->convertDashesToUnderscores($fieldName);
1937
1938                 // Does the field exist?
1939                 if (isset($fieldArray[$fieldName])) {
1940                         // Get it
1941                         $fieldValue = $fieldArray[$fieldName];
1942                 } else {
1943                         // Missing field entry, may require debugging
1944                         self::createDebugInstance(__CLASS__)->debugOutput('[' . __METHOD__ . ':' . __LINE__ . ']:fieldName=' . $fieldName . ' not found!');
1945                 }
1946
1947                 // Return it
1948                 return $fieldValue;
1949         }
1950
1951         /**
1952          * Flushs all pending updates to the database layer
1953          *
1954          * @return      void
1955          */
1956         public function flushPendingUpdates () {
1957                 // Get result instance
1958                 $resultInstance = $this->getResultInstance();
1959
1960                 // Do we have data to update?
1961                 if ((is_object($resultInstance)) && ($resultInstance->ifDataNeedsFlush())) {
1962                         // Get wrapper class name config entry
1963                         $configEntry = $resultInstance->getUpdateInstance()->getWrapperConfigEntry();
1964
1965                         // Create object instance
1966                         $wrapperInstance = ObjectFactory::createObjectByConfiguredName($configEntry);
1967
1968                         // Yes, then send the whole result to the database layer
1969                         $wrapperInstance->doUpdateByResult($this->getResultInstance());
1970                 } // END - if
1971         }
1972
1973         /**
1974          * Outputs a deprecation warning to the developer.
1975          *
1976          * @param       $message        The message we shall output to the developer
1977          * @return      void
1978          * @todo        Write a logging mechanism for productive mode
1979          */
1980         public function deprecationWarning ($message) {
1981                 // Is developer mode active?
1982                 if (defined('DEVELOPER')) {
1983                         // Debug instance is there?
1984                         if (!is_null($this->getDebugInstance())) {
1985                                 // Output stub message
1986                                 self::createDebugInstance(__CLASS__)->debugOutput($message);
1987                         } else {
1988                                 // Trigger an error
1989                                 trigger_error($message . "<br />\n");
1990                                 exit;
1991                         }
1992                 } else {
1993                         // @TODO Finish this part!
1994                         $this->partialStub('Developer mode inactive. Message:' . $message);
1995                 }
1996         }
1997
1998         /**
1999          * Checks whether the given PHP extension is loaded
2000          *
2001          * @param       $phpExtension   The PHP extension we shall check
2002          * @return      $isLoaded       Whether the PHP extension is loaded
2003          */
2004         public final function isPhpExtensionLoaded ($phpExtension) {
2005                 // Is it loaded?
2006                 $isLoaded = in_array($phpExtension, get_loaded_extensions());
2007
2008                 // Return result
2009                 return $isLoaded;
2010         }
2011
2012         /**
2013          * "Getter" as a time() replacement but with milliseconds. You should use this
2014          * method instead of the encapsulated getimeofday() function.
2015          *
2016          * @return      $milliTime      Timestamp with milliseconds
2017          */
2018         public function getMilliTime () {
2019                 // Get the time of day as float
2020                 $milliTime = gettimeofday(TRUE);
2021
2022                 // Return it
2023                 return $milliTime;
2024         }
2025
2026         /**
2027          * Idles (sleeps) for given milliseconds
2028          *
2029          * @return      $hasSlept       Whether it goes fine
2030          */
2031         public function idle ($milliSeconds) {
2032                 // Sleep is fine by default
2033                 $hasSlept = TRUE;
2034
2035                 // Idle so long with found function
2036                 if (function_exists('time_sleep_until')) {
2037                         // Get current time and add idle time
2038                         $sleepUntil = $this->getMilliTime() + abs($milliSeconds) / 1000;
2039
2040                         // New PHP 5.1.0 function found, ignore errors
2041                         $hasSlept = @time_sleep_until($sleepUntil);
2042                 } else {
2043                         /*
2044                          * My Sun station doesn't have that function even with latest PHP
2045                          * package. :(
2046                          */
2047                         usleep($milliSeconds * 1000);
2048                 }
2049
2050                 // Return result
2051                 return $hasSlept;
2052         }
2053         /**
2054          * Converts a hexadecimal string, even with negative sign as first string to
2055          * a decimal number using BC functions.
2056          *
2057          * This work is based on comment #86673 on php.net documentation page at:
2058          * <http://de.php.net/manual/en/function.dechex.php#86673>
2059          *
2060          * @param       $hex    Hexadecimal string
2061          * @return      $dec    Decimal number
2062          */
2063         protected function hex2dec ($hex) {
2064                 // Convert to all lower-case
2065                 $hex = strtolower($hex);
2066
2067                 // Detect sign (negative/positive numbers)
2068                 $sign = '';
2069                 if (substr($hex, 0, 1) == '-') {
2070                         $sign = '-';
2071                         $hex = substr($hex, 1);
2072                 } // END - if
2073
2074                 // Decode the hexadecimal string into a decimal number
2075                 $dec = 0;
2076                 for ($i = strlen($hex) - 1, $e = 1; $i >= 0; $i--, $e = bcmul($e, 16)) {
2077                         $factor = self::$hexdec[substr($hex, $i, 1)];
2078                         $dec = bcadd($dec, bcmul($factor, $e));
2079                 } // END - for
2080
2081                 // Return the decimal number
2082                 return $sign . $dec;
2083         }
2084
2085         /**
2086          * Converts even very large decimal numbers, also signed, to a hexadecimal
2087          * string.
2088          *
2089          * This work is based on comment #97756 on php.net documentation page at:
2090          * <http://de.php.net/manual/en/function.hexdec.php#97756>
2091          *
2092          * @param       $dec            Decimal number, even with negative sign
2093          * @param       $maxLength      Optional maximum length of the string
2094          * @return      $hex    Hexadecimal string
2095          */
2096         protected function dec2hex ($dec, $maxLength = 0) {
2097                 // maxLength can be zero or devideable by 2
2098                 assert(($maxLength == 0) || (($maxLength % 2) == 0));
2099
2100                 // Detect sign (negative/positive numbers)
2101                 $sign = '';
2102                 if ($dec < 0) {
2103                         $sign = '-';
2104                         $dec = abs($dec);
2105                 } // END - if
2106
2107                 // Encode the decimal number into a hexadecimal string
2108                 $hex = '';
2109                 do {
2110                         $hex = self::$dechex[($dec % (2 ^ 4))] . $hex;
2111                         $dec /= (2 ^ 4);
2112                 } while ($dec >= 1);
2113
2114                 /*
2115                  * Leading zeros are required for hex-decimal "numbers". In some
2116                  * situations more leading zeros are wanted, so check for both
2117                  * conditions.
2118                  */
2119                 if ($maxLength > 0) {
2120                         // Prepend more zeros
2121                         $hex = str_pad($hex, $maxLength, '0', STR_PAD_LEFT);
2122                 } elseif ((strlen($hex) % 2) != 0) {
2123                         // Only make string's length dividable by 2
2124                         $hex = '0' . $hex;
2125                 }
2126
2127                 // Return the hexadecimal string
2128                 return $sign . $hex;
2129         }
2130
2131         /**
2132          * Converts a ASCII string (0 to 255) into a decimal number.
2133          *
2134          * @param       $asc    The ASCII string to be converted
2135          * @return      $dec    Decimal number
2136          */
2137         protected function asc2dec ($asc) {
2138                 // Convert it into a hexadecimal number
2139                 $hex = bin2hex($asc);
2140
2141                 // And back into a decimal number
2142                 $dec = $this->hex2dec($hex);
2143
2144                 // Return it
2145                 return $dec;
2146         }
2147
2148         /**
2149          * Converts a decimal number into an ASCII string.
2150          *
2151          * @param       $dec            Decimal number
2152          * @return      $asc    An ASCII string
2153          */
2154         protected function dec2asc ($dec) {
2155                 // First convert the number into a hexadecimal string
2156                 $hex = $this->dec2hex($dec);
2157
2158                 // Then convert it into the ASCII string
2159                 $asc = $this->hex2asc($hex);
2160
2161                 // Return it
2162                 return $asc;
2163         }
2164
2165         /**
2166          * Converts a hexadecimal number into an ASCII string. Negative numbers
2167          * are not allowed.
2168          *
2169          * @param       $hex    Hexadecimal string
2170          * @return      $asc    An ASCII string
2171          */
2172         protected function hex2asc ($hex) {
2173                 // Check for length, it must be devideable by 2
2174                 //* DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput('hex='.$hex);
2175                 assert((strlen($hex) % 2) == 0);
2176
2177                 // Walk the string
2178                 $asc = '';
2179                 for ($idx = 0; $idx < strlen($hex); $idx+=2) {
2180                         // Get the decimal number of the chunk
2181                         $part = hexdec(substr($hex, $idx, 2));
2182
2183                         // Add it to the final string
2184                         $asc .= chr($part);
2185                 } // END - for
2186
2187                 // Return the final string
2188                 return $asc;
2189         }
2190
2191         /**
2192          * Checks whether the given encoded data was encoded with Base64
2193          *
2194          * @param       $encodedData    Encoded data we shall check
2195          * @return      $isBase64               Whether the encoded data is Base64
2196          */
2197         protected function isBase64Encoded ($encodedData) {
2198                 // Determine it
2199                 $isBase64 = (@base64_decode($encodedData, TRUE) !== FALSE);
2200
2201                 // Return it
2202                 return $isBase64;
2203         }
2204
2205         /**
2206          * "Getter" to get response/request type from analysis of the system.
2207          *
2208          * @return      $responseType   Analyzed response type
2209          */
2210         protected function getResponseTypeFromSystem () {
2211                 // Default is console
2212                 $responseType = 'console';
2213
2214                 // Is 'HTTP_HOST' set?
2215                 if (isset($_SERVER['HTTP_HOST'])) {
2216                         // Then it is a HTTP response/request
2217                         $responseType = 'http';
2218                 } // END - if
2219
2220                 // Return it
2221                 return $responseType;
2222         }
2223
2224         /**
2225          * Gets a cache key from Criteria instance
2226          *
2227          * @param       $criteriaInstance       An instance of a Criteria class
2228          * @param       $onlyKeys                       Only use these keys for a cache key
2229          * @return      $cacheKey                       A cache key suitable for lookup/storage purposes
2230          */
2231         protected function getCacheKeyByCriteria (Criteria $criteriaInstance, array $onlyKeys = array()) {
2232                 // Generate it
2233                 $cacheKey = sprintf('%s@%s',
2234                         $this->__toString(),
2235                         $criteriaInstance->getCacheKey($onlyKeys)
2236                 );
2237
2238                 // And return it
2239                 //* NOISY-DEBUG: */ self::createDebugInstance(__CLASS__)->debugOutput($this->__toString() . ': cacheKey=' . $cacheKey);
2240                 return $cacheKey;
2241         }
2242
2243         /**
2244          * Getter for startup time in miliseconds
2245          *
2246          * @return      $startupTime    Startup time in miliseconds
2247          */
2248         protected function getStartupTime () {
2249                 return self::$startupTime;
2250         }
2251
2252         /**
2253          * "Getter" for a printable currently execution time in nice braces
2254          *
2255          * @return      $executionTime  Current execution time in nice braces
2256          */
2257         protected function getPrintableExecutionTime () {
2258                 // Caculate the execution time
2259                 $executionTime = microtime(TRUE) - $this->getStartupTime();
2260
2261                 // Pack it in nice braces
2262                 $executionTime = sprintf('[ %01.5f ] ', $executionTime);
2263
2264                 // And return it
2265                 return $executionTime;
2266         }
2267
2268         /**
2269          * Hashes a given string with a simple but stronger hash function (no salt)
2270          * and hex-encode it.
2271          *
2272          * @param       $str    The string to be hashed
2273          * @return      $hash   The hash from string $str
2274          */
2275         public static final function hash ($str) {
2276                 // Hash given string with (better secure) hasher
2277                 $hash = bin2hex(mhash(MHASH_SHA256, $str));
2278
2279                 // Return it
2280                 return $hash;
2281         }
2282
2283         /**
2284          * "Getter" for length of hash() output. This will be "cached" to speed up
2285          * things.
2286          *
2287          * @return      $length         Length of hash() output
2288          */
2289         public static final function getHashLength () {
2290                 // Is it cashed?
2291                 if (is_null(self::$hashLength)) {
2292                         // No, then hash a string and save its length.
2293                         self::$hashLength = strlen(self::hash('abc123'));
2294                 } // END - if
2295
2296                 // Return it
2297                 return self::$hashLength;
2298         }
2299
2300         /**
2301          * Checks whether the given number is really a number (only chars 0-9).
2302          *
2303          * @param       $num            A string consisting only chars between 0 and 9
2304          * @param       $castValue      Whether to cast the value to double. Do only use this to secure numbers from Requestable classes.
2305          * @param       $assertMismatch         Whether to assert mismatches
2306          * @return      $ret            The (hopefully) secured numbered value
2307          */
2308         public function bigintval ($num, $castValue = TRUE, $assertMismatch = FALSE) {
2309                 // Filter all numbers out
2310                 $ret = preg_replace('/[^0123456789]/', '', $num);
2311
2312                 // Shall we cast?
2313                 if ($castValue === TRUE) {
2314                         // Cast to biggest numeric type
2315                         $ret = (double) $ret;
2316                 } // END - if
2317
2318                 // Assert only if requested
2319                 if ($assertMismatch === TRUE) {
2320                         // Has the whole value changed?
2321                         assert(('' . $ret . '' != '' . $num . '') && (!is_null($num)));
2322                 } // END - if
2323
2324                 // Return result
2325                 return $ret;
2326         }
2327
2328         /**
2329          * Checks whether the given hexadecimal number is really a hex-number (only chars 0-9,a-f).
2330          *
2331          * @param       $num    A string consisting only chars between 0 and 9
2332          * @param       $assertMismatch         Whether to assert mismatches
2333          * @return      $ret    The (hopefully) secured hext-numbered value
2334          */
2335         public function hexval ($num, $assertMismatch = FALSE) {
2336                 // Filter all numbers out
2337                 $ret = preg_replace('/[^0123456789abcdefABCDEF]/', '', $num);
2338
2339                 // Assert only if requested
2340                 if ($assertMismatch === TRUE) {
2341                         // Has the whole value changed?
2342                         assert(('' . $ret . '' != '' . $num . '') && (!is_null($num)));
2343                 } // END - if
2344
2345                 // Return result
2346                 return $ret;
2347         }
2348
2349         /**
2350          * Checks whether start/end marker are set
2351          *
2352          * @param       $data   Data to be checked
2353          * @return      $isset  Whether start/end marker are set
2354          */
2355         public final function ifStartEndMarkersSet ($data) {
2356                 // Determine it
2357                 $isset = ((substr($data, 0, strlen(BaseRawDataHandler::STREAM_START_MARKER)) == BaseRawDataHandler::STREAM_START_MARKER) && (substr($data, -1 * strlen(BaseRawDataHandler::STREAM_END_MARKER), strlen(BaseRawDataHandler::STREAM_END_MARKER)) == BaseRawDataHandler::STREAM_END_MARKER));
2358
2359                 // ... and return it
2360                 return $isset;
2361         }
2362
2363         /**
2364          * Determines if an element is set in the generic array
2365          *
2366          * @param       $keyGroup       Main group for the key
2367          * @param       $subGroup       Sub group for the key
2368          * @param       $key            Key to check
2369          * @param       $element        Element to check
2370          * @return      $isset          Whether the given key is set
2371          */
2372         protected final function isGenericArrayElementSet ($keyGroup, $subGroup, $key, $element) {
2373                 // Debug message
2374                 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element);
2375
2376                 // Is it there?
2377                 $isset = isset($this->genericArray[$keyGroup][$subGroup][$key][$element]);
2378
2379                 // Return it
2380                 return $isset;
2381         }
2382         /**
2383          * Determines if a key is set in the generic array
2384          *
2385          * @param       $keyGroup       Main group for the key
2386          * @param       $subGroup       Sub group for the key
2387          * @param       $key            Key to check
2388          * @return      $isset          Whether the given key is set
2389          */
2390         protected final function isGenericArrayKeySet ($keyGroup, $subGroup, $key) {
2391                 // Debug message
2392                 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2393
2394                 // Is it there?
2395                 $isset = isset($this->genericArray[$keyGroup][$subGroup][$key]);
2396
2397                 // Return it
2398                 return $isset;
2399         }
2400
2401
2402         /**
2403          * Determines if a group is set in the generic array
2404          *
2405          * @param       $keyGroup       Main group
2406          * @param       $subGroup       Sub group
2407          * @return      $isset          Whether the given group is set
2408          */
2409         protected final function isGenericArrayGroupSet ($keyGroup, $subGroup) {
2410                 // Debug message
2411                 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup);
2412
2413                 // Is it there?
2414                 $isset = isset($this->genericArray[$keyGroup][$subGroup]);
2415
2416                 // Return it
2417                 return $isset;
2418         }
2419
2420         /**
2421          * Getter for sub key group
2422          *
2423          * @param       $keyGroup       Main key group
2424          * @param       $subGroup       Sub key group
2425          * @return      $array          An array with all array elements
2426          */
2427         protected final function getGenericSubArray ($keyGroup, $subGroup) {
2428                 // Is it there?
2429                 if (!$this->isGenericArrayGroupSet($keyGroup, $subGroup)) {
2430                         // No, then abort here
2431                         trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' not found.');
2432                         exit;
2433                 } // END - if
2434
2435                 // Debug message
2436                 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',value=' . print_r($this->genericArray[$keyGroup][$subGroup], TRUE));
2437
2438                 // Return it
2439                 return $this->genericArray[$keyGroup][$subGroup];
2440         }
2441
2442         /**
2443          * Unsets a given key in generic array
2444          *
2445          * @param       $keyGroup       Main group for the key
2446          * @param       $subGroup       Sub group for the key
2447          * @param       $key            Key to unset
2448          * @return      void
2449          */
2450         protected final function unsetGenericArrayKey ($keyGroup, $subGroup, $key) {
2451                 // Debug message
2452                 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2453
2454                 // Remove it
2455                 unset($this->genericArray[$keyGroup][$subGroup][$key]);
2456         }
2457
2458         /**
2459          * Unsets a given element in generic array
2460          *
2461          * @param       $keyGroup       Main group for the key
2462          * @param       $subGroup       Sub group for the key
2463          * @param       $key            Key to unset
2464          * @param       $element        Element to unset
2465          * @return      void
2466          */
2467         protected final function unsetGenericArrayElement ($keyGroup, $subGroup, $key, $element) {
2468                 // Debug message
2469                 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element);
2470
2471                 // Remove it
2472                 unset($this->genericArray[$keyGroup][$subGroup][$key][$element]);
2473         }
2474
2475         /**
2476          * Append a string to a given generic array key
2477          *
2478          * @param       $keyGroup       Main group for the key
2479          * @param       $subGroup       Sub group for the key
2480          * @param       $key            Key to unset
2481          * @param       $value          Value to add/append
2482          * @return      void
2483          */
2484         protected final function appendStringToGenericArrayKey ($keyGroup, $subGroup, $key, $value, $appendGlue = '') {
2485                 // Debug message
2486                 //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',value[' . gettype($value) . ']=' . print_r($value, TRUE) . ',appendGlue=' . $appendGlue);
2487
2488                 // Is it already there?
2489                 if ($this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2490                         // Append it
2491                         $this->genericArray[$keyGroup][$subGroup][$key] .= $appendGlue . (string) $value;
2492                 } else {
2493                         // Add it
2494                         $this->genericArray[$keyGroup][$subGroup][$key] = (string) $value;
2495                 }
2496         }
2497
2498         /**
2499          * Append a string to a given generic array element
2500          *
2501          * @param       $keyGroup       Main group for the key
2502          * @param       $subGroup       Sub group for the key
2503          * @param       $key            Key to unset
2504          * @param       $element        Element to check
2505          * @param       $value          Value to add/append
2506          * @return      void
2507          */
2508         protected final function appendStringToGenericArrayElement ($keyGroup, $subGroup, $key, $element, $value, $appendGlue = '') {
2509                 // Debug message
2510                 //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ',value[' . gettype($value) . ']=' . print_r($value, TRUE) . ',appendGlue=' . $appendGlue);
2511
2512                 // Is it already there?
2513                 if ($this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element)) {
2514                         // Append it
2515                         $this->genericArray[$keyGroup][$subGroup][$key][$element] .= $appendGlue . (string) $value;
2516                 } else {
2517                         // Add it
2518                         $this->genericArray[$keyGroup][$subGroup][$key][$element] = (string) $value;
2519                 }
2520         }
2521
2522         /**
2523          * Initializes given generic array group
2524          *
2525          * @param       $keyGroup       Main group for the key
2526          * @param       $subGroup       Sub group for the key
2527          * @param       $key            Key to use
2528          * @param       $forceInit      Optionally force initialization
2529          * @return      void
2530          */
2531         protected final function initGenericArrayGroup ($keyGroup, $subGroup, $forceInit = FALSE) {
2532                 // Debug message
2533                 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',forceInit=' . intval($forceInit));
2534
2535                 // Is it already set?
2536                 if (($forceInit === FALSE) && ($this->isGenericArrayGroupSet($keyGroup, $subGroup))) {
2537                         // Already initialized
2538                         trigger_error(__METHOD__ . ':keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' already initialized.');
2539                         exit;
2540                 } // END - if
2541
2542                 // Initialize it
2543                 $this->genericArray[$keyGroup][$subGroup] = array();
2544         }
2545
2546         /**
2547          * Initializes given generic array key
2548          *
2549          * @param       $keyGroup       Main group for the key
2550          * @param       $subGroup       Sub group for the key
2551          * @param       $key            Key to use
2552          * @param       $forceInit      Optionally force initialization
2553          * @return      void
2554          */
2555         protected final function initGenericArrayKey ($keyGroup, $subGroup, $key, $forceInit = FALSE) {
2556                 // Debug message
2557                 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',forceInit=' . intval($forceInit));
2558
2559                 // Is it already set?
2560                 if (($forceInit === FALSE) && ($this->isGenericArrayKeySet($keyGroup, $subGroup, $key))) {
2561                         // Already initialized
2562                         trigger_error(__METHOD__ . ':keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' already initialized.');
2563                         exit;
2564                 } // END - if
2565
2566                 // Initialize it
2567                 $this->genericArray[$keyGroup][$subGroup][$key] = array();
2568         }
2569
2570         /**
2571          * Initializes given generic array element
2572          *
2573          * @param       $keyGroup       Main group for the key
2574          * @param       $subGroup       Sub group for the key
2575          * @param       $key            Key to use
2576          * @param       $element        Element to use
2577          * @param       $forceInit      Optionally force initialization
2578          * @return      void
2579          */
2580         protected final function initGenericArrayElement ($keyGroup, $subGroup, $key, $element, $forceInit = FALSE) {
2581                 // Debug message
2582                 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ',forceInit=' . intval($forceInit));
2583
2584                 // Is it already set?
2585                 if (($forceInit === FALSE) && ($this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element))) {
2586                         // Already initialized
2587                         trigger_error(__METHOD__ . ':keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ' already initialized.');
2588                         exit;
2589                 } // END - if
2590
2591                 // Initialize it
2592                 $this->genericArray[$keyGroup][$subGroup][$key][$element] = array();
2593         }
2594
2595         /**
2596          * Pushes an element to a generic key
2597          *
2598          * @param       $keyGroup       Main group for the key
2599          * @param       $subGroup       Sub group for the key
2600          * @param       $key            Key to use
2601          * @param       $value          Value to add/append
2602          * @return      $count          Number of array elements
2603          */
2604         protected final function pushValueToGenericArrayKey ($keyGroup, $subGroup, $key, $value) {
2605                 // Debug message
2606                 //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',value[' . gettype($value) . ']=' . print_r($value, TRUE));
2607
2608                 // Is it set?
2609                 if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2610                         // Initialize array
2611                         $this->initGenericArrayKey($keyGroup, $subGroup, $key);
2612                 } // END - if
2613
2614                 // Then push it
2615                 $count = array_push($this->genericArray[$keyGroup][$subGroup][$key], $value);
2616
2617                 // Return count
2618                 //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE));
2619                 //* DEBUG: */ print(__METHOD__ . ': count=' . $count . PHP_EOL);
2620                 return $count;
2621         }
2622
2623         /**
2624          * Pushes an element to a generic array element
2625          *
2626          * @param       $keyGroup       Main group for the key
2627          * @param       $subGroup       Sub group for the key
2628          * @param       $key            Key to use
2629          * @param       $element        Element to check
2630          * @param       $value          Value to add/append
2631          * @return      $count          Number of array elements
2632          */
2633         protected final function pushValueToGenericArrayElement ($keyGroup, $subGroup, $key, $element, $value) {
2634                 // Debug message
2635                 //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ',value[' . gettype($value) . ']=' . print_r($value, TRUE));
2636
2637                 // Is it set?
2638                 if (!$this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element)) {
2639                         // Initialize array
2640                         $this->initGenericArrayElement($keyGroup, $subGroup, $key, $element);
2641                 } // END - if
2642
2643                 // Then push it
2644                 $count = array_push($this->genericArray[$keyGroup][$subGroup][$key][$element], $value);
2645
2646                 // Return count
2647                 //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE));
2648                 //* DEBUG: */ print(__METHOD__ . ': count=' . $count . PHP_EOL);
2649                 return $count;
2650         }
2651
2652         /**
2653          * Pops an element from  a generic group
2654          *
2655          * @param       $keyGroup       Main group for the key
2656          * @param       $subGroup       Sub group for the key
2657          * @param       $key            Key to unset
2658          * @return      $value          Last "popped" value
2659          */
2660         protected final function popGenericArrayElement ($keyGroup, $subGroup, $key) {
2661                 // Debug message
2662                 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2663
2664                 // Is it set?
2665                 if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2666                         // Not found
2667                         trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' not found.');
2668                         exit;
2669                 } // END - if
2670
2671                 // Then "pop" it
2672                 $value = array_pop($this->genericArray[$keyGroup][$subGroup][$key]);
2673
2674                 // Return value
2675                 //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE));
2676                 //* DEBUG: */ print(__METHOD__ . ': value[' . gettype($value) . ']=' . print_r($value, TRUE) . PHP_EOL);
2677                 return $value;
2678         }
2679
2680         /**
2681          * Shifts an element from  a generic group
2682          *
2683          * @param       $keyGroup       Main group for the key
2684          * @param       $subGroup       Sub group for the key
2685          * @param       $key            Key to unset
2686          * @return      $value          Last "popped" value
2687          */
2688         protected final function shiftGenericArrayElement ($keyGroup, $subGroup, $key) {
2689                 // Debug message
2690                 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2691
2692                 // Is it set?
2693                 if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2694                         // Not found
2695                         trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' not found.');
2696                         exit;
2697                 } // END - if
2698
2699                 // Then "shift" it
2700                 $value = array_shift($this->genericArray[$keyGroup][$subGroup][$key]);
2701
2702                 // Return value
2703                 //* DEBUG: */ print(__METHOD__ . ': genericArray=' . print_r($this->genericArray[$keyGroup][$subGroup][$key], TRUE));
2704                 //* DEBUG: */ print(__METHOD__ . ': value[' . gettype($value) . ']=' . print_r($value, TRUE) . PHP_EOL);
2705                 return $value;
2706         }
2707
2708         /**
2709          * Count generic array group
2710          *
2711          * @param       $keyGroup       Main group for the key
2712          * @return      $count          Count of given group
2713          */
2714         protected final function countGenericArray ($keyGroup) {
2715                 // Debug message
2716                 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup);
2717
2718                 // Is it there?
2719                 if (!isset($this->genericArray[$keyGroup])) {
2720                         // Abort here
2721                         trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ' not found.');
2722                         exit;
2723                 } // END - if
2724
2725                 // Then count it
2726                 $count = count($this->genericArray[$keyGroup]);
2727
2728                 // Debug message
2729                 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',count=' . $count);
2730
2731                 // Return it
2732                 return $count;
2733         }
2734
2735         /**
2736          * Count generic array sub group
2737          *
2738          * @param       $keyGroup       Main group for the key
2739          * @param       $subGroup       Sub group for the key
2740          * @return      $count          Count of given group
2741          */
2742         protected final function countGenericArrayGroup ($keyGroup, $subGroup) {
2743                 // Debug message
2744                 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup);
2745
2746                 // Is it there?
2747                 if (!$this->isGenericArrayGroupSet($keyGroup, $subGroup)) {
2748                         // Abort here
2749                         trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' not found.');
2750                         exit;
2751                 } // END - if
2752
2753                 // Then count it
2754                 $count = count($this->genericArray[$keyGroup][$subGroup]);
2755
2756                 // Debug message
2757                 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',count=' . $count);
2758
2759                 // Return it
2760                 return $count;
2761         }
2762
2763         /**
2764          * Count generic array elements
2765          *
2766          * @param       $keyGroup       Main group for the key
2767          * @param       $subGroup       Sub group for the key
2768          * @para        $key            Key to count
2769          * @return      $count          Count of given key
2770          */
2771         protected final function countGenericArrayElements ($keyGroup, $subGroup, $key) {
2772                 // Debug message
2773                 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2774
2775                 // Is it there?
2776                 if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2777                         // Abort here
2778                         trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' not found.');
2779                         exit;
2780                 } elseif (!$this->isValidGenericArrayGroup($keyGroup, $subGroup)) {
2781                         // Not valid
2782                         trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ' is not an array.');
2783                         exit;
2784                 }
2785
2786                 // Then count it
2787                 $count = count($this->genericArray[$keyGroup][$subGroup][$key]);
2788
2789                 // Debug message
2790                 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',count=' . $count);
2791
2792                 // Return it
2793                 return $count;
2794         }
2795
2796         /**
2797          * Getter for whole generic group array
2798          *
2799          * @param       $keyGroup       Key group to get
2800          * @return      $array          Whole generic array group
2801          */
2802         protected final function getGenericArray ($keyGroup) {
2803                 // Debug message
2804                 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup);
2805
2806                 // Is it there?
2807                 if (!isset($this->genericArray[$keyGroup])) {
2808                         // Then abort here
2809                         trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ' does not exist.');
2810                         exit;
2811                 } // END - if
2812
2813                 // Return it
2814                 return $this->genericArray[$keyGroup];
2815         }
2816
2817         /**
2818          * Setter for generic array key
2819          *
2820          * @param       $keyGroup       Key group to get
2821          * @param       $subGroup       Sub group for the key
2822          * @param       $key            Key to unset
2823          * @param       $value          Mixed value from generic array element
2824          * @return      void
2825          */
2826         protected final function setGenericArrayKey ($keyGroup, $subGroup, $key, $value) {
2827                 // Debug message
2828                 //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',value[' . gettype($value) . ']=' . print_r($value, TRUE));
2829
2830                 // Set value here
2831                 $this->genericArray[$keyGroup][$subGroup][$key] = $value;
2832         }
2833
2834         /**
2835          * Getter for generic array key
2836          *
2837          * @param       $keyGroup       Key group to get
2838          * @param       $subGroup       Sub group for the key
2839          * @param       $key            Key to unset
2840          * @return      $value          Mixed value from generic array element
2841          */
2842         protected final function getGenericArrayKey ($keyGroup, $subGroup, $key) {
2843                 // Debug message
2844                 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2845
2846                 // Is it there?
2847                 if (!$this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) {
2848                         // Then abort here
2849                         trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ' does not exist.');
2850                         exit;
2851                 } // END - if
2852
2853                 // Return it
2854                 return $this->genericArray[$keyGroup][$subGroup][$key];
2855         }
2856
2857         /**
2858          * Sets a value in given generic array key/element
2859          *
2860          * @param       $keyGroup       Main group for the key
2861          * @param       $subGroup       Sub group for the key
2862          * @param       $key            Key to set
2863          * @param       $element        Element to set
2864          * @param       $value          Value to set
2865          * @return      void
2866          */
2867         protected final function setGenericArrayElement ($keyGroup, $subGroup, $key, $element, $value) {
2868                 // Debug message
2869                 //* NOISY-DEBUG: */ if (!is_object($value)) $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ',value[' . gettype($value) . ']=' . print_r($value, TRUE));
2870
2871                 // Then set it
2872                 $this->genericArray[$keyGroup][$subGroup][$key][$element] = $value;
2873         }
2874
2875         /**
2876          * Getter for generic array element
2877          *
2878          * @param       $keyGroup       Key group to get
2879          * @param       $subGroup       Sub group for the key
2880          * @param       $key            Key to look for
2881          * @param       $element        Element to look for
2882          * @return      $value          Mixed value from generic array element
2883          */
2884         protected final function getGenericArrayElement ($keyGroup, $subGroup, $key, $element) {
2885                 // Debug message
2886                 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element);
2887
2888                 // Is it there?
2889                 if (!$this->isGenericArrayElementSet($keyGroup, $subGroup, $key, $element)) {
2890                         // Then abort here
2891                         trigger_error(__METHOD__ . ': keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key . ',element=' . $element . ' does not exist.');
2892                         exit;
2893                 } // END - if
2894
2895                 // Return it
2896                 return $this->genericArray[$keyGroup][$subGroup][$key][$element];
2897         }
2898
2899         /**
2900          * Checks if a given sub group is valid (array)
2901          *
2902          * @param       $keyGroup       Key group to get
2903          * @param       $subGroup       Sub group for the key
2904          * @return      $isValid        Whether given sub group is valid
2905          */
2906         protected final function isValidGenericArrayGroup ($keyGroup, $subGroup) {
2907                 // Debug message
2908                 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup);
2909
2910                 // Determine it
2911                 $isValid = (($this->isGenericArrayGroupSet($keyGroup, $subGroup)) && (is_array($this->getGenericSubArray($keyGroup, $subGroup))));
2912
2913                 // Return it
2914                 return $isValid;
2915         }
2916
2917         /**
2918          * Checks if a given key is valid (array)
2919          *
2920          * @param       $keyGroup       Key group to get
2921          * @param       $subGroup       Sub group for the key
2922          * @param       $key            Key to check
2923          * @return      $isValid        Whether given sub group is valid
2924          */
2925         protected final function isValidGenericArrayKey ($keyGroup, $subGroup, $key) {
2926                 // Debug message
2927                 //* NOISY-DEBUG: */ $this->outputLine('[' . __METHOD__ . ':' . __LINE__ . '] keyGroup=' . $keyGroup . ',subGroup=' . $subGroup . ',key=' . $key);
2928
2929                 // Determine it
2930                 $isValid = (($this->isGenericArrayKeySet($keyGroup, $subGroup, $key)) && (is_array($this->getGenericArrayKey($keyGroup, $subGroup, $key))));
2931
2932                 // Return it
2933                 return $isValid;
2934         }
2935
2936         /**
2937          * Translates boolean TRUE to 'Y' and FALSE to 'N'
2938          *
2939          * @param       $boolean                Boolean value
2940          * @return      $translated             Translated boolean value
2941          */
2942         public static final function translateBooleanToYesNo ($boolean) {
2943                 // Make sure it is really boolean
2944                 assert(is_bool($boolean));
2945
2946                 // "Translate" it
2947                 $translated = ($boolean === TRUE) ? 'Y' : 'N';
2948
2949                 // ... and return it
2950                 return $translated;
2951         }
2952 }
2953
2954 // [EOF]
2955 ?>