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