Payment introduced, minor rewrites
[shipsimu.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, this is free software
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          * Instance to an application helper class
28          */
29         private static $applicationInstance = null;
30
31         /**
32          * The language instance for the template loader
33          */
34         private static $langInstance = null;
35
36         /**
37          * Debug instance
38          */
39         private static $debugInstance = null;
40
41         /**
42          * Instance of a request class
43          */
44         private $requestInstance = null;
45
46         /**
47          * Instance of a response class
48          */
49         private $responseInstance = null;
50
51         /**
52          * Search criteria instance
53          */
54         private $searchInstance = null;
55
56         /**
57          * The file I/O instance for the template loader
58          */
59         private $fileIoInstance = null;
60
61         /**
62          * Resolver instance
63          */
64         private $resolverInstance = null;
65
66         /**
67          * Template engine instance
68          */
69         private $templateInstance = null;
70
71         /**
72          * Database result instance
73          */
74         private $resultInstance = null;
75
76         /**
77          * Instance for user class
78          */
79         private $userInstance = null;
80
81         /**
82          * The real class name
83          */
84         private $realClass      = "FrameworkSystem";
85
86         /**
87          * Thousands seperator
88          */
89         private $thousands = "."; // German
90
91         /**
92          * Decimal seperator
93          */
94         private $decimals  = ","; // German
95
96         /***********************
97          * Exception codes.... *
98          ***********************/
99
100         const EXCEPTION_IS_NULL_POINTER              = 0x001;
101         const EXCEPTION_IS_NO_OBJECT                 = 0x002;
102         const EXCEPTION_IS_NO_ARRAY                  = 0x003;
103         const EXCEPTION_MISSING_METHOD               = 0x004;
104         const EXCEPTION_CLASSES_NOT_MATCHING         = 0x005;
105         const EXCEPTION_INDEX_OUT_OF_BOUNDS          = 0x006;
106         const EXCEPTION_DIMENSION_ARRAY_INVALID      = 0x007;
107         const EXCEPTION_ITEM_NOT_TRADEABLE           = 0x008;
108         const EXCEPTION_ITEM_NOT_IN_PRICE_LIST       = 0x009;
109         const EXCEPTION_GENDER_IS_WRONG              = 0x00a;
110         const EXCEPTION_BIRTH_DATE_IS_INVALID        = 0x00b;
111         const EXCEPTION_EMPTY_STRUCTURES_ARRAY       = 0x00c;
112         const EXCEPTION_HAS_ALREADY_PERSONELL_LIST   = 0x00d;
113         const EXCEPTION_NOT_ENOUGTH_UNEMPLOYEES      = 0x00e;
114         const EXCEPTION_TOTAL_PRICE_NOT_CALCULATED   = 0x00f;
115         const EXCEPTION_HARBOR_HAS_NO_SHIPYARDS      = 0x010;
116         const EXCEPTION_CONTRACT_PARTNER_INVALID     = 0x011;
117         const EXCEPTION_CONTRACT_PARTNER_MISMATCH    = 0x012;
118         const EXCEPTION_CONTRACT_ALREADY_SIGNED      = 0x013;
119         const EXCEPTION_UNEXPECTED_EMPTY_STRING      = 0x014;
120         const EXCEPTION_PATH_NOT_FOUND               = 0x015;
121         const EXCEPTION_INVALID_PATH_NAME            = 0x016;
122         const EXCEPTION_READ_PROTECED_PATH           = 0x017;
123         const EXCEPTION_WRITE_PROTECED_PATH          = 0x018;
124         const EXCEPTION_DIR_POINTER_INVALID          = 0x019;
125         const EXCEPTION_FILE_POINTER_INVALID         = 0x01a;
126         const EXCEPTION_INVALID_DIRECTORY_POINTER    = 0x01b;
127         const EXCEPTION_UNEXPECTED_OBJECT            = 0x01c;
128         const EXCEPTION_LIMIT_ELEMENT_IS_UNSUPPORTED = 0x01d;
129         const EXCEPTION_GETTER_IS_MISSING            = 0x01e;
130         const EXCEPTION_ARRAY_EXPECTED               = 0x01f;
131         const EXCEPTION_ARRAY_HAS_INVALID_COUNT      = 0x020;
132         const EXCEPTION_ID_IS_INVALID_FORMAT         = 0x021;
133         const EXCEPTION_MD5_CHECKSUMS_MISMATCH       = 0x022;
134         const EXCEPTION_UNEXPECTED_STRING_SIZE       = 0x023;
135         const EXCEPTION_SIMULATOR_ID_INVALID         = 0x024;
136         const EXCEPTION_MISMATCHING_COMPRESSORS      = 0x025;
137         const EXCEPTION_CONTAINER_ITEM_IS_NULL       = 0x026;
138         const EXCEPTION_ITEM_IS_NO_ARRAY             = 0x027;
139         const EXCEPTION_CONTAINER_MAYBE_DAMAGED      = 0x028;
140         const EXCEPTION_INVALID_STRING               = 0x029;
141         const EXCEPTION_VARIABLE_NOT_SET             = 0x02a;
142         const EXCEPTION_ATTRIBUTES_ARE_MISSING       = 0x02b;
143         const EXCEPTION_ARRAY_ELEMENTS_MISSING       = 0x02c;
144         const EXCEPTION_TEMPLATE_ENGINE_UNSUPPORTED  = 0x02d;
145         const EXCEPTION_MISSING_LANGUAGE_HANDLER     = 0x02e;
146         const EXCEPTION_MISSING_FILE_IO_HANDLER      = 0x02f;
147         const EXCEPTION_MISSING_ELEMENT              = 0x030;
148         const EXCEPTION_HEADERS_ALREADY_SENT         = 0x031;
149         const EXCEPTION_DEFAULT_CONTROLLER_GONE      = 0x032;
150         const EXCEPTION_CLASS_NOT_FOUND              = 0x033;
151         const EXCEPTION_REQUIRED_INTERFACE_MISSING   = 0x034;
152         const EXCEPTION_FATAL_ERROR                  = 0x035;
153         const EXCEPTION_FILE_NOT_FOUND               = 0x036;
154         const EXCEPTION_ASSERTION_FAILED             = 0x037;
155         const EXCEPTION_FILE_CANNOT_BE_READ          = 0x038;
156         const EXCEPTION_DATABASE_UPDATED_NOT_ALLOWED = 0x039;
157
158         /**
159          * In the super constructor these system classes shall be ignored or else
160          * we would get an endless calling loop.
161          *
162          *---------------------------------------------------------------------*
163          * ATTENTION: IF YOU REMOVE ONE OF THEM YOU WILL RUN YOUR SERVER IN AN *
164          * ENDLESS LOOP !!!                                                    *
165          *---------------------------------------------------------------------*
166          */
167         private $systemClasses = array(
168                 "DebugMiddleware",                              // Debug middleware output sub-system
169                 "Registry",                                             // Object registry
170                 "ObjectFactory",                                // Object factory
171                 "DebugWebOutput",                               // Debug web output sub-system
172                 "WebOutput",                                    // Web output sub-system
173                 "CompressorChannel",                    // Compressor sub-system
174                 "DebugConsoleOutput",                   // Debug console output sub-system
175                 "DebugErrorLogOutput",                  // Debug error_log() output sub-system
176                 "FrameworkDirectoryPointer",    // Directory handler sub-system
177                 "NullCompressor",                               // Null compressor
178                 "Bzip2Compressor",                              // BZIP2 compressor
179                 "GzipCompressor",                               // GZIP compressor
180         );
181
182         /* No longer used:
183         */
184
185         /**
186          * Private super constructor
187          *
188          * @param       $className      Name of the class
189          * @return      void
190          */
191         protected function __construct ($className) {
192                 // Set real class
193                 $this->setRealClass($className);
194
195                 // Initialize the class if the registry is there
196                 if ((class_exists('Registry')) && (Registry::isInitialized() === false)) {
197                         $this->initInstance();
198                 } // END - if
199         }
200
201         /**
202          * Destructor reached...
203          *
204          * @return      void
205          * @todo        This is old code. Do we still need this old lost code?
206          */
207         public function __destruct() {
208                 // Is this object already destroyed?
209                 if ($this->__toString() != 'DestructedObject') {
210                         // Destroy all informations about this class but keep some text about it alive
211                         $this->setRealClass('DestructedObject');
212                 } elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
213                         // Already destructed object
214                         $this->debugOutput(sprintf("[%s:] The object <strong>%s</strong> is already destroyed.",
215                                 __CLASS__, $this->__toString()
216                         ));
217                 }
218         }
219
220         /**
221          * The call method where all non-implemented methods end up
222          *
223          * @return      void
224          */
225         public final function __call ($methodName, $args) {
226                 // Implode all given arguments
227                 $argsString = "";
228                 if (empty($args)) {
229                         // No arguments
230                         $argsString = "NULL";
231                 } elseif (is_array($args)) {
232                         // Some arguments are there
233                         foreach ($args as $arg) {
234                                 // Add the type
235                                 $argsString .= $arg." (".gettype($arg);
236
237                                 // Add length if type is string
238                                 if (gettype($arg) == 'string') $argsString .= ", ".strlen($arg);
239
240                                 // Closing bracket
241                                 $argsString .= "), ";
242                         } // END - foreach
243
244                         // Remove last comma
245                         if (substr($argsString, -2, 1) === ",") {
246                                 $argsString = substr($argsString, 0, -2);
247                         } // END - if
248                 } else {
249                         // Invalid arguments!
250                         $argsString = sprintf("!INVALID:%s!", $args);
251                 }
252
253                 // Output stub message
254                 $this->debugOutput(sprintf("[%s-&gt;%s] Stub! Args: %s",
255                         $this->__toString(),
256                         $methodName,
257                         $argsString
258                 ));
259
260                 // Return nothing
261                 return null;
262         }
263
264         /**
265          * Private initializer for this class
266          *
267          * @return      void
268          */
269         private final function initInstance () {
270                 // Is this a system class?
271                 if (!in_array($this->__toString(), $this->systemClasses)) {
272                         // Set configuration instance
273                         $this->setConfigInstance(FrameworkConfiguration::getInstance());
274
275                         // Add application helper to our class
276                         $this->systemclasses[] = $this->getConfigInstance()->readConfig('app_helper_class');
277
278                         // Set debug instance
279                         $this->setDebugInstance(DebugMiddleware::createDebugMiddleware($this->getConfigInstance()->readConfig('debug_class')));
280
281                         // Get output instance and set it
282                         $outputInstance = ObjectFactory::createObjectByConfiguredName('web_engine', array($this->getConfigInstance()->readConfig('web_content_type')));
283                         $this->setWebOutputInstance($outputInstance);
284
285                         // Set the compressor channel
286                         $this->setCompressorChannel(CompressorChannel::createCompressorChannel(sprintf("%s%s",
287                                 $this->getConfigInstance()->readConfig('base_path'),
288                                 $this->getConfigInstance()->readConfig('compressor_base_path')
289                         )));
290
291                         // Initialization done! :D
292                         Registry::isInitialized('OK');
293                 } elseif ($this->__toString() == 'DebugMiddleware') {
294                         // Set configuration instance
295                         $this->setConfigInstance(FrameworkConfiguration::getInstance());
296                 }
297         }
298
299         /**
300          * Setter for database result instance
301          *
302          * @param       $resultInstance         An instance of a database result class
303          * @return      void
304          * @todo        SearchableResult and UpdateableResult shall have a super interface to use here
305          */
306         protected final function setResultInstance (SearchableResult $resultInstance) {
307                 $this->resultInstance =  $resultInstance;
308         }
309
310         /**
311          * Getter for database result instance
312          *
313          * @return      $resultInstance         An instance of a database result class
314          */
315         public final function getResultInstance () {
316                 return $this->resultInstance;
317         }
318
319         /**
320          * Setter for template engine instances
321          *
322          * @param       $templateInstance       An instance of a template engine class
323          * @return      void
324          */
325         protected final function setTemplateInstance (CompileableTemplate $templateInstance) {
326                 $this->templateInstance = $templateInstance;
327         }
328
329         /**
330          * Getter for template engine instances
331          *
332          * @return      $templateInstance       An instance of a template engine class
333          */
334         protected final function getTemplateInstance () {
335                 return $this->templateInstance;
336         }
337
338         /**
339          * Setter for search instance
340          *
341          * @param       $searchInstance         Searchable criteria instance
342          * @return      void
343          */
344         public final function setSearchInstance (LocalSearchCriteria $searchInstance) {
345                 $this->searchInstance = $searchInstance;
346         }
347
348         /**
349          * Getter for search instance
350          *
351          * @return      $searchInstance         Searchable criteria instance
352          */
353         public final function getSearchInstance () {
354                 return $this->searchInstance;
355         }
356
357         /**
358          * Setter for resolver instance
359          *
360          * @param       $resolverInstance               Instance of a command resolver class
361          * @return      void
362          */
363         public final function setResolverInstance (Resolver $resolverInstance) {
364                 $this->resolverInstance = $resolverInstance;
365         }
366
367         /**
368          * Getter for resolver instance
369          *
370          * @return      $resolverInstance               Instance of a command resolver class
371          */
372         public final function getResolverInstance () {
373                 return $this->resolverInstance;
374         }
375
376         /**
377          * Setter for language instance
378          *
379          * @param       $configInstance         The configuration instance which shall
380          *                                                              be FrameworkConfiguration
381          * @return      void
382          */
383         public final function setConfigInstance (FrameworkConfiguration $configInstance) {
384                 Registry::getRegistry()->addInstance('config', $configInstance);
385         }
386
387         /**
388          * Getter for configuration instance
389          *
390          * @return      $cfgInstance    Configuration instance
391          */
392         public final function getConfigInstance () {
393                 $cfgInstance = Registry::getRegistry()->getInstance('config');
394                 return $cfgInstance;
395         }
396
397         /**
398          * Setter for debug instance
399          *
400          * @param       $debugInstance  The instance for debug output class
401          * @return      void
402          */
403         public final function setDebugInstance (DebugMiddleware $debugInstance) {
404                 self::$debugInstance = $debugInstance;
405         }
406
407         /**
408          * Getter for debug instance
409          *
410          * @return      $debugInstance  Instance to class DebugConsoleOutput or DebugWebOutput
411          */
412         public final function getDebugInstance () {
413                 return self::$debugInstance;
414         }
415
416         /**
417          * Setter for web output instance
418          *
419          * @param               $webInstance    The instance for web output class
420          * @return      void
421          */
422         public final function setWebOutputInstance (OutputStreamer $webInstance) {
423                 Registry::getRegistry()->addInstance('web_output', $webInstance);
424         }
425
426         /**
427          * Getter for web output instance
428          *
429          * @return      $webOutput - Instance to class WebOutput
430          */
431         public final function getWebOutputInstance () {
432                 return Registry::getRegistry()->getInstance('web_output');
433         }
434
435         /**
436          * Setter for database instance
437          *
438          * @param               $dbInstance     The instance for the database connection
439          *                                      (forced DatabaseConnection)
440          * @return      void
441          */
442         public final function setDatabaseInstance (DatabaseConnection $dbInstance) {
443                 Registry::getRegistry()->addInstance('dbInstance', $dbInstance);
444         }
445
446         /**
447          * Getter for database layer
448          *
449          * @return      $dbInstance     The database layer instance
450          */
451         public final function getDatabaseInstance () {
452                 // Default is invalid db instance
453                 $dbInstance = null;
454
455                 // Is the registry there and initialized?
456                 if ((class_exists('Registry')) && (Registry::isInitialized() === true)) {
457                         $dbInstance = Registry::getRegistry()->getInstance('dbInstance');
458                 } // END - if
459
460                 // Return instance
461                 return $dbInstance;
462         }
463
464         /**
465          * Setter for compressor channel
466          *
467          * @param               $compressorChannel      An instance of CompressorChannel
468          * @return      void
469          */
470         public final function setCompressorChannel (CompressorChannel $compressorChannel) {
471                 Registry::getRegistry()->addInstance('compressor', $compressorChannel);
472         }
473
474         /**
475          * Getter for compressor channel
476          *
477          * @return      $compressor     The compressor channel
478          */
479         public final function getCompressorChannel () {
480                 return Registry::getRegistry()->getInstance('compressor');
481         }
482
483         /**
484          * Protected getter for a manageable application helper class
485          *
486          * @return      $applicationInstance    An instance of a manageable application helper class
487          */
488         protected final function getApplicationInstance () {
489                 return self::$applicationInstance;
490         }
491
492         /**
493          * Setter for a manageable application helper class
494          *
495          * @param       $applicationInstance    An instance of a manageable application helper class
496          * @return      void
497          */
498         public final function setApplicationInstance (ManageableApplication $applicationInstance) {
499                 self::$applicationInstance = $applicationInstance;
500         }
501
502         /**
503          * Setter for request instance
504          *
505          * @param       $requestInstance        An instance of a Requestable class
506          * @return      void
507          */
508         public final function setRequestInstance (Requestable $requestInstance) {
509                 $this->requestInstance = $requestInstance;
510         }
511
512         /**
513          * Getter for request instance
514          *
515          * @return      $requestInstance        An instance of a Requestable class
516          */
517         public final function getRequestInstance () {
518                 return $this->requestInstance;
519         }
520
521         /**
522          * Setter for response instance
523          *
524          * @param       $responseInstance       An instance of a Responseable class
525          * @return      void
526          */
527         public final function setResponseInstance (Responseable $responseInstance) {
528                 $this->responseInstance = $responseInstance;
529         }
530
531         /**
532          * Getter for response instance
533          *
534          * @return      $responseInstance       An instance of a Responseable class
535          */
536         public final function getResponseInstance () {
537                 return $this->responseInstance;
538         }
539
540         /**
541          * Getter for $realClass
542          *
543          * @return      $realClass The name of the real class (not BaseFrameworkSystem)
544          */
545         public final function __toString () {
546                 return $this->realClass;
547         }
548
549         /**
550          * Setter for the real class name
551          *
552          * @param               $realClass      Class name (string)
553          * @return      void
554          */
555         public final function setRealClass ($realClass) {
556                 // Cast to string
557                 $realClass = (string) $realClass;
558
559                 // Set real class
560                 $this->realClass = $realClass;
561         }
562
563         /**
564          * Compare class name of this and given class name
565          *
566          * @param               $className      The class name as string from the other class
567          * @return      boolean The result of comparing both class names
568          */
569         public final function isClass ($className) {
570                 return ($this->__toString() == $className);
571         }
572
573         /**
574          * Stub method (only real cabins shall override it)
575          *
576          * @return      boolean false = is no cabin, true = is a cabin
577          * @deprecated
578          */
579         public function isCabin () {
580                 return false;
581         }
582
583         /**
584          * Stub method for tradeable objects
585          *
586          * @return      boolean false = is not tradeable by the Merchant class,
587          *                                      true  = is a tradeable object
588          * @deprecated
589          */
590         public function isTradeable () {
591                 return false;
592         }
593
594         /**
595          * Formats computer generated price values into human-understandable formats
596          * with thousand and decimal seperators.
597          *
598          * @param       $value          The in computer format value for a price
599          * @param       $currency       The currency symbol (use HTML-valid characters!)
600          * @param       $decNum         Number of decimals after commata
601          * @return      $price          The for the current language formated price string
602          * @throws      MissingDecimalsThousandsSeperatorException      If decimals or
603          *                                                                                              thousands seperator
604          *                                                                                              is missing
605          */
606         public function formatCurrency ($value, $currency = "&euro;", $decNum = 2) {
607                 // Are all required attriutes set?
608                 if ((!isset($this->decimals)) || (!isset($this->thousands))) {
609                         // Throw an exception
610                         throw new MissingDecimalsThousandsSeperatorException($this, self::EXCEPTION_ATTRIBUTES_ARE_MISSING);
611                 }
612
613                 // Cast the number
614                 $value = (float) $value;
615
616                 // Reformat the US number
617                 $price = sprintf("%s %s",
618                         number_format($value, $decNum, $this->decimals, $this->thousands),
619                         $currency
620                 );
621
622                 // Return as string...
623                 return $price;
624         }
625
626         /**
627          * Removes number formating characters
628          *
629          * @return      void
630          */
631         public final function removeNumberFormaters () {
632                 unset($this->thousands);
633                 unset($this->decimals);
634         }
635
636         /**
637          * Private getter for language instance
638          *
639          * @return      $langInstance   An instance to the language sub-system
640          */
641         protected final function getLanguageInstance () {
642                 return self::$langInstance;
643         }
644
645         /**
646          * Setter for language instance
647          *
648          * @param       $langInstance   An instance to the language sub-system
649          * @return      void
650          * @see         LanguageSystem
651          */
652         public final function setLanguageInstance (ManageableLanguage $langInstance) {
653                 self::$langInstance = $langInstance;
654         }
655
656         /**
657          * Remove the $systemClasses array from memory
658          *
659          * @return      void
660          */
661         public final function removeSystemArray () {
662                 unset($this->systemClasses);
663         }
664
665         /**
666          * Appends a trailing slash to a string
667          *
668          * @param       $str            A string (maybe) without trailing slash
669          * @return      $str            A string with an auto-appended trailing slash
670          */
671         public final function addMissingTrailingSlash ($str) {
672                 // Is there a trailing slash?
673                 if (substr($str, -1, 1) != "/") $str .= "/";
674                 return $str;
675         }
676
677         /**
678          * Private getter for file IO instance
679          *
680          * @return      $fileIoInstance An instance to the file I/O sub-system
681          */
682         protected final function getFileIoInstance () {
683                 return $this->fileIoInstance;
684         }
685
686         /**
687          * Setter for file I/O instance
688          *
689          * @param       $fileIoInstance An instance to the file I/O sub-system
690          * @return      void
691          */
692         public final function setFileIoInstance (FileIoHandler $fileIoInstance) {
693                 $this->fileIoInstance = $fileIoInstance;
694         }
695
696         /**
697          * Prepare the template engine (WebTemplateEngine by default) for a given
698          * application helper instance (ApplicationHelper by default).
699          *
700          * @param               $appInstance                    An application helper instance or
701          *                                                                              null if we shall use the default
702          * @return              $templateInstance                               The template engine instance
703          * @throws              NullPointerException    If the template engine could not
704          *                                                                              be initialized
705          * @throws              UnsupportedTemplateEngineException      If $templateInstance is an
706          *                                                                              unsupported template engine
707          * @throws              MissingLanguageHandlerException If the language sub-system
708          *                                                                              is not yet initialized
709          * @throws              NullPointerException    If the discovered application
710          *                                                                              instance is still null
711          */
712         protected function prepareTemplateInstance (BaseFrameworkSystem $appInstance=null) {
713                 // Is the application instance set?
714                 if (is_null($appInstance)) {
715                         // Get the current instance
716                         $appInstance = $this->getApplicationInstance();
717
718                         // Still null?
719                         if (is_null($appInstance)) {
720                                 // Thrown an exception
721                                 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
722                         } // END - if
723                 } // END - if
724
725                 // Generate FQFN for all application templates
726                 $fqfn = sprintf("%s%s/%s",
727                         $this->getConfigInstance()->readConfig('application_path'),
728                         strtolower($appInstance->getAppShortName()),
729                         $this->getConfigInstance()->readConfig('tpl_base_path')
730                 );
731
732                 // Are both instances set?
733                 if ($appInstance->getLanguageInstance() === null) {
734                         // Invalid language instance
735                         throw new MissingLanguageHandlerException($appInstance, self::EXCEPTION_MISSING_LANGUAGE_HANDLER);
736                 } elseif ($appInstance->getFileIoInstance() === null) {
737                         // Invalid language instance
738                         throw new MissingFileIoHandlerException($appInstance, self::EXCEPTION_MISSING_FILE_IO_HANDLER);
739                 }
740
741                 // Initialize the template engine
742                 $templateInstance = ObjectFactory::createObjectByConfiguredName('template_class', array($fqfn, $appInstance->getLanguageInstance(), $appInstance->getFileIoInstance()));
743
744                 // Return the prepared instance
745                 return $templateInstance;
746         }
747
748         /**
749          * Debugs this instance by putting out it's full content
750          *
751          * @return      void
752          */
753         public final function debugInstance () {
754                 // Restore the error handler to avoid trouble with missing array elements or undeclared variables
755                 restore_error_handler();
756
757                 // Generate the output
758                 $content = sprintf("<pre>%s</pre>",
759                         trim(
760                                 htmlentities(
761                                         print_r($this, true)
762                                 )
763                         )
764                 );
765
766                 // Output it
767                 ApplicationEntryPoint::app_die(sprintf("<strong>%s debug output:</strong><div id=\"debug_content\">%s</div>\nLoaded includes: <div id=\"debug_include_list\">%s</div>",
768                         $this->__toString(),
769                         $content,
770                         ClassLoader::getInstance()->getPrintableIncludeList()
771                 ));
772         }
773
774         /**
775          * Output a partial stub message for the caller method
776          *
777          * @param       $message        An optional message to display
778          * @return      void
779          */
780         protected function partialStub ($message = "") {
781                 // Get the backtrace
782                 $backtrace = debug_backtrace();
783
784                 // Generate the class::method string
785                 $methodName = "UnknownClass-&gt;unknownMethod";
786                 if ((isset($backtrace[1]['class'])) && (isset($backtrace[1]['function']))) {
787                         $methodName = $backtrace[1]['class']."-&gt;".$backtrace[1]['function'];
788                 } // END - if
789
790                 // Construct the full message
791                 $stubMessage = sprintf("[%s:] Partial stub!",
792                         $methodName
793                 );
794
795                 // Is the extra message given?
796                 if (!empty($message)) {
797                         // Then add it as well
798                         $stubMessage .= sprintf(" Message: <span id=\"stub_message\">%s</span>", $message);
799                 } // END - if
800
801                 // Debug instance is there?
802                 if (!is_null($this->getDebugInstance())) {
803                         // Output stub message
804                         $this->debugOutput($stubMessage);
805                 } else {
806                         // Trigger an error
807                         trigger_error($stubMessage."<br />\n");
808                 }
809         }
810
811         /**
812          * Outputs a debug backtrace and stops further script execution
813          *
814          * @return      void
815          */
816         public function debugBackTrace () {
817                 // Sorry, there is no other way getting this nice backtrace
818                 print("<pre>\n");
819                 debug_print_backtrace();
820                 print("</pre>");
821                 exit;
822         }
823
824         /**
825          * Outputs a debug message wether to debug instance (should be set!) or dies with or pints the message
826          *
827          * @param       $message        Message we shall send out...
828          * @param       $doPrint        Wether we shall print or die here which first is the default
829          * @return      void
830          */
831         public function debugOutput ($message, $doPrint = true) {
832                 // Get debug instance
833                 $debugInstance = $this->getDebugInstance();
834
835                 // Is the debug instance there?
836                 if (is_object($debugInstance)) {
837                         // Use debug output handler
838                         $debugInstance->output($message);
839                         if (!$doPrint) die(); // Die here if not printed
840                 } else {
841                         // Put directly out
842                         if ($doPrint) {
843                                 print($message);
844                         } else {
845                                 // DO NOT REWRITE THIS TO app_die() !!!
846                                 die($message);
847                         }
848                 }
849         }
850
851         /**
852          * Converts e.g. a command from URL to a valid class by keeping out bad characters
853          *
854          * @param       $str            The string, what ever it is needs to be converted
855          * @return      $className      Generated class name
856          */
857         public function convertToClassName ($str) {
858                 // Init class name
859                 $className = "";
860
861                 // Convert all dashes in underscores
862                 $str = str_replace("-", "_", $str);
863
864                 // Now use that underscores to get classname parts for hungarian style
865                 foreach (explode("_", $str) as $strPart) {
866                         // Make the class name part lower case and first upper case
867                         $className .= ucfirst(strtolower($strPart));
868                 } // END - foreach
869
870                 // Return class name
871                 return $className;
872         }
873
874         /**
875          * Marks up the code by adding e.g. line numbers
876          *
877          * @param       $phpCode                Unmarked PHP code
878          * @return      $markedCode             Marked PHP code
879          */
880         public function markupCode ($phpCode) {
881                 // Init marked code
882                 $markedCode = "";
883
884                 // Get last error
885                 $errorArray = error_get_last();
886
887                 // Init the code with error message
888                 if (is_array($errorArray)) {
889                         // Get error infos
890                         $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>",
891                                 basename($errorArray['file']),
892                                 $errorArray['line'],
893                                 $errorArray['message'],
894                                 $errorArray['type']
895                         );
896                 } // END - if
897
898                 // Add line number to the code
899                 foreach (explode("\n", $phpCode) as $lineNo => $code) {
900                         // Add line numbers
901                         $markedCode .= sprintf("<span id=\"code_line\">%s</span>: %s\n",
902                                 ($lineNo + 1),
903                                 htmlentities($code, ENT_QUOTES)
904                         );
905                 } // END - foreach
906
907                 // Return the code
908                 return $markedCode;
909         }
910
911         /**
912          * Filter a given GMT timestamp (non Uni* stamp!) to make it look more
913          * beatiful for web-based front-ends. If null is given a message id
914          * null_timestamp will be resolved and returned.
915          *
916          * @param       $timestamp      Timestamp to prepare (filter) for display
917          * @return      $readable       A readable timestamp
918          */
919         public function doFilterFormatTimestamp ($timestamp) {
920                 // Default value to return
921                 $readable = "???";
922
923                 // Is the timestamp null?
924                 if (is_null($timestamp)) {
925                         // Get a message string
926                         $readable = $this->getLanguageInstance()->getMessage('null_timestamp');
927                 } else {
928                         switch ($this->getLanguageInstance()->getLanguageCode()) {
929                                 case "de": // German format is a bit different to default
930                                         // Split the GMT stamp up
931                                         $dateTime = explode(" ", $timestamp);
932                                         $dateArray = explode("-", $dateTime[0]);
933                                         $timeArray = explode(":", $dateTime[1]);
934
935                                         // Construct the timestamp
936                                         $readable = sprintf($this->getConfigInstance()->readConfig('german_date_time'),
937                                                 $dateArray[0],
938                                                 $dateArray[1],
939                                                 $dateArray[2],
940                                                 $timeArray[0],
941                                                 $timeArray[1],
942                                                 $timeArray[2]
943                                         );
944                                         break;
945
946                                 default: // Default is pass-through
947                                         $readable = $timestamp;
948                                         break;
949                         }
950                 }
951
952                 // Return the stamp
953                 return $readable;
954         }
955
956         /**
957          * "Getter" for databse entry
958          *
959          * @return      $entry  An array with database entries
960          * @throws      NullPointerException    If the database result is not found
961          * @throws      InvalidDatabaseResultException  If the database result is invalid
962          */
963         protected final function getDatabaseEntry () {
964                 // Is there an instance?
965                 if (is_null($this->getResultInstance())) {
966                         // Throw an exception here
967                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
968                 } // END - if
969
970                 // Rewind it
971                 $this->getResultInstance()->rewind();
972
973                 // Do we have an entry?
974                 if (!$this->getResultInstance()->valid()) {
975                         throw new InvalidDatabaseResultException(array($this, $this->getResultInstance()), DatabaseResult::EXCEPTION_INVALID_DATABASE_RESULT);
976                 } // END - if
977
978                 // Get next entry
979                 $this->getResultInstance()->next();
980
981                 // Fetch it
982                 $entry = $this->getResultInstance()->current();
983
984                 // And return it
985                 return $entry;
986         }
987
988         /**
989          * Getter for field name
990          *
991          * @param       $fieldName              Field name which we shall get
992          * @return      $fieldValue             Field value from the user
993          * @throws      NullPointerException    If the result instance is null
994          */
995         public final function getField ($fieldName) {
996                 // Default field value
997                 $fieldValue = null;
998
999                 // Get result instance
1000                 $resultInstance = $this->getResultInstance();
1001
1002                 // Is this instance null?
1003                 if (is_null($resultInstance)) {
1004                         // Then the user instance is no longer valid (expired cookies?)
1005                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
1006                 } // END - if
1007
1008                 // Get current array
1009                 $fieldArray = $resultInstance->current();
1010
1011                 // Does the field exist?
1012                 if (isset($fieldArray[$fieldName])) {
1013                         // Get it
1014                         $fieldValue = $fieldArray[$fieldName];
1015                 } // END - if
1016
1017                 // Return it
1018                 return $fieldValue;
1019         }
1020
1021         /**
1022          * Protected setter for user instance
1023          *
1024          * @param       $userInstance   An instance of a user class
1025          * @return      void
1026          */
1027         protected final function setUserInstance (ManageableAccount $userInstance) {
1028                 $this->userInstance = $userInstance;
1029         }
1030
1031         /**
1032          * Getter for user instance
1033          *
1034          * @return      $userInstance   An instance of a user class
1035          */
1036         public final function getUserInstance () {
1037                 return $this->userInstance;
1038         }
1039 }
1040
1041 // [EOF]
1042 ?>