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