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