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