5652f4fa03001c7363ee453b6f6487eb6daaadbc
[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                         // Add application helper to our class
273                         $this->systemclasses[] = $this->getConfigInstance()->readConfig('app_helper_class');
274
275                         // Set debug instance
276                         $this->setDebugInstance(DebugMiddleware::createDebugMiddleware($this->getConfigInstance()->readConfig('debug_class')));
277
278                         // Get output instance and set it
279                         $outputInstance = ObjectFactory::createObjectByConfiguredName('web_engine', array($this->getConfigInstance()->readConfig('web_content_type')));
280                         $this->setWebOutputInstance($outputInstance);
281
282                         // Set the compressor channel
283                         $this->setCompressorChannel(CompressorChannel::createCompressorChannel(sprintf("%s%s",
284                                 PATH,
285                                 $this->getConfigInstance()->readConfig('compressor_base_path')
286                         )));
287
288                         // Initialization done! :D
289                         Registry::isInitialized('OK');
290                 } elseif ($this->__toString() == 'DebugMiddleware') {
291                         // Set configuration instance
292                         $this->setConfigInstance(FrameworkConfiguration::createFrameworkConfiguration());
293                 }
294         }
295
296         /**
297          * Setter for database result instance
298          *
299          * @param       $resultInstance         An instance of a database result class
300          * @return      void
301          * @todo        SearchableResult and UpdateableResult shall have a super interface to use here
302          */
303         protected final function setResultInstance (SearchableResult $resultInstance) {
304                 $this->resultInstance =  $resultInstance;
305         }
306
307         /**
308          * Getter for database result instance
309          *
310          * @return      $resultInstance         An instance of a database result class
311          */
312         public final function getResultInstance () {
313                 return $this->resultInstance;
314         }
315
316         /**
317          * Setter for template engine instances
318          *
319          * @param       $templateInstance       An instance of a template engine class
320          * @return      void
321          */
322         protected final function setTemplateInstance (CompileableTemplate $templateInstance) {
323                 $this->templateInstance = $templateInstance;
324         }
325
326         /**
327          * Getter for template engine instances
328          *
329          * @return      $templateInstance       An instance of a template engine class
330          */
331         protected final function getTemplateInstance () {
332                 return $this->templateInstance;
333         }
334
335         /**
336          * Setter for search instance
337          *
338          * @param       $searchInstance         Searchable criteria instance
339          * @return      void
340          */
341         public final function setSearchInstance (LocalSearchCriteria $searchInstance) {
342                 $this->searchInstance = $searchInstance;
343         }
344
345         /**
346          * Getter for search instance
347          *
348          * @return      $searchInstance         Searchable criteria instance
349          */
350         public final function getSearchInstance () {
351                 return $this->searchInstance;
352         }
353
354         /**
355          * Setter for resolver instance
356          *
357          * @param       $resolverInstance               Instance of a command resolver class
358          * @return      void
359          */
360         public final function setResolverInstance (Resolver $resolverInstance) {
361                 $this->resolverInstance = $resolverInstance;
362         }
363
364         /**
365          * Getter for resolver instance
366          *
367          * @return      $resolverInstance               Instance of a command resolver class
368          */
369         public final function getResolverInstance () {
370                 return $this->resolverInstance;
371         }
372
373         /**
374          * Setter for language instance
375          *
376          * @param       $configInstance         The configuration instance which shall
377          *                                                              be FrameworkConfiguration
378          * @return      void
379          */
380         public final function setConfigInstance (FrameworkConfiguration $configInstance) {
381                 Registry::getRegistry()->addInstance('config', $configInstance);
382         }
383
384         /**
385          * Getter for configuration instance
386          *
387          * @return      $cfgInstance    Configuration instance
388          */
389         public final function getConfigInstance () {
390                 $cfgInstance = Registry::getRegistry()->getInstance('config');
391                 return $cfgInstance;
392         }
393
394         /**
395          * Setter for debug instance
396          *
397          * @param       $debugInstance  The instance for debug output class
398          * @return      void
399          */
400         public final function setDebugInstance (DebugMiddleware $debugInstance) {
401                 self::$debugInstance = $debugInstance;
402         }
403
404         /**
405          * Getter for debug instance
406          *
407          * @return      $debugInstance  Instance to class DebugConsoleOutput or DebugWebOutput
408          */
409         public final function getDebugInstance () {
410                 return self::$debugInstance;
411         }
412
413         /**
414          * Setter for web output instance
415          *
416          * @param               $webInstance    The instance for web output class
417          * @return      void
418          */
419         public final function setWebOutputInstance (OutputStreamer $webInstance) {
420                 Registry::getRegistry()->addInstance('web_output', $webInstance);
421         }
422
423         /**
424          * Getter for web output instance
425          *
426          * @return      $webOutput - Instance to class WebOutput
427          */
428         public final function getWebOutputInstance () {
429                 return Registry::getRegistry()->getInstance('web_output');
430         }
431
432         /**
433          * Setter for database instance
434          *
435          * @param               $dbInstance     The instance for the database connection
436          *                                      (forced DatabaseConnection)
437          * @return      void
438          */
439         public final function setDatabaseInstance (DatabaseConnection $dbInstance) {
440                 Registry::getRegistry()->addInstance('dbInstance', $dbInstance);
441         }
442
443         /**
444          * Getter for database layer
445          *
446          * @return      $dbInstance     The database layer instance
447          */
448         public final function getDatabaseInstance () {
449                 // Default is invalid db instance
450                 $dbInstance = null;
451
452                 // Is the registry there and initialized?
453                 if ((class_exists('Registry')) && (Registry::isInitialized() === true)) {
454                         $dbInstance = Registry::getRegistry()->getInstance('dbInstance');
455                 } // END - if
456
457                 // Return instance
458                 return $dbInstance;
459         }
460
461         /**
462          * Setter for compressor channel
463          *
464          * @param               $compressorChannel      An instance of CompressorChannel
465          * @return      void
466          */
467         public final function setCompressorChannel (CompressorChannel $compressorChannel) {
468                 Registry::getRegistry()->addInstance('compressor', $compressorChannel);
469         }
470
471         /**
472          * Getter for compressor channel
473          *
474          * @return      $compressor     The compressor channel
475          */
476         public final function getCompressorChannel () {
477                 return Registry::getRegistry()->getInstance('compressor');
478         }
479
480         /**
481          * Protected getter for a manageable application helper class
482          *
483          * @return      $applicationInstance    An instance of a manageable application helper class
484          */
485         protected final function getApplicationInstance () {
486                 return self::$applicationInstance;
487         }
488
489         /**
490          * Setter for a manageable application helper class
491          *
492          * @param       $applicationInstance    An instance of a manageable application helper class
493          * @return      void
494          */
495         public final function setApplicationInstance (ManageableApplication $applicationInstance) {
496                 self::$applicationInstance = $applicationInstance;
497         }
498
499         /**
500          * Setter for request instance
501          *
502          * @param       $requestInstance        An instance of a Requestable class
503          * @return      void
504          */
505         public final function setRequestInstance (Requestable $requestInstance) {
506                 $this->requestInstance = $requestInstance;
507         }
508
509         /**
510          * Getter for request instance
511          *
512          * @return      $requestInstance        An instance of a Requestable class
513          */
514         public final function getRequestInstance () {
515                 return $this->requestInstance;
516         }
517
518         /**
519          * Setter for response instance
520          *
521          * @param       $responseInstance       An instance of a Responseable class
522          * @return      void
523          */
524         public final function setResponseInstance (Responseable $responseInstance) {
525                 $this->responseInstance = $responseInstance;
526         }
527
528         /**
529          * Getter for response instance
530          *
531          * @return      $responseInstance       An instance of a Responseable class
532          */
533         public final function getResponseInstance () {
534                 return $this->responseInstance;
535         }
536
537         /**
538          * Getter for $realClass
539          *
540          * @return      $realClass The name of the real class (not BaseFrameworkSystem)
541          */
542         public final function __toString () {
543                 return $this->realClass;
544         }
545
546         /**
547          * Setter for the real class name
548          *
549          * @param               $realClass      Class name (string)
550          * @return      void
551          */
552         public final function setRealClass ($realClass) {
553                 // Cast to string
554                 $realClass = (string) $realClass;
555
556                 // Set real class
557                 $this->realClass = $realClass;
558         }
559
560         /**
561          * Compare class name of this and given class name
562          *
563          * @param               $className      The class name as string from the other class
564          * @return      boolean The result of comparing both class names
565          */
566         public final function isClass ($className) {
567                 return ($this->__toString() == $className);
568         }
569
570         /**
571          * Stub method (only real cabins shall override it)
572          *
573          * @return      boolean false = is no cabin, true = is a cabin
574          */
575         public function isCabin () {
576                 return false;
577         }
578
579         /**
580          * Stub method for tradeable objects
581          *
582          * @return      boolean false = is not tradeable by the Merchant class,
583          *                                      true  = is a tradeable object
584          */
585         public function isTradeable () {
586                 return false;
587         }
588
589         /**
590          * Formats computer generated price values into human-understandable formats
591          * with thousand and decimal seperators.
592          *
593          * @param       $value          The in computer format value for a price
594          * @param       $currency       The currency symbol (use HTML-valid characters!)
595          * @param       $decNum         Number of decimals after commata
596          * @return      $price          The for the current language formated price string
597          * @throws      MissingDecimalsThousandsSeperatorException      If decimals or
598          *                                                                                              thousands seperator
599          *                                                                                              is missing
600          */
601         public function formatCurrency ($value, $currency = "&euro;", $decNum = 2) {
602                 // Are all required attriutes set?
603                 if ((!isset($this->decimals)) || (!isset($this->thousands))) {
604                         // Throw an exception
605                         throw new MissingDecimalsThousandsSeperatorException($this, self::EXCEPTION_ATTRIBUTES_ARE_MISSING);
606                 }
607
608                 // Cast the number
609                 $value = (float) $value;
610
611                 // Reformat the US number
612                 $price = sprintf("%s %s",
613                         number_format($value, $decNum, $this->decimals, $this->thousands),
614                         $currency
615                 );
616
617                 // Return as string...
618                 return $price;
619         }
620
621         /**
622          * Removes number formating characters
623          *
624          * @return      void
625          */
626         public final function removeNumberFormaters () {
627                 unset($this->thousands);
628                 unset($this->decimals);
629         }
630
631         /**
632          * Private getter for language instance
633          *
634          * @return      $langInstance   An instance to the language sub-system
635          */
636         protected final function getLanguageInstance () {
637                 return self::$langInstance;
638         }
639
640         /**
641          * Setter for language instance
642          *
643          * @param       $langInstance   An instance to the language sub-system
644          * @return      void
645          * @see         LanguageSystem
646          */
647         public final function setLanguageInstance (ManageableLanguage $langInstance) {
648                 self::$langInstance = $langInstance;
649         }
650
651         /**
652          * Remove the $systemClasses array from memory
653          *
654          * @return      void
655          */
656         public final function removeSystemArray () {
657                 unset($this->systemClasses);
658         }
659
660         /**
661          * Appends a trailing slash to a string
662          *
663          * @param       $str            A string (maybe) without trailing slash
664          * @return      $str            A string with an auto-appended trailing slash
665          */
666         public final function addMissingTrailingSlash ($str) {
667                 // Is there a trailing slash?
668                 if (substr($str, -1, 1) != "/") $str .= "/";
669                 return $str;
670         }
671
672         /**
673          * Private getter for file IO instance
674          *
675          * @return      $fileIoInstance An instance to the file I/O sub-system
676          */
677         protected final function getFileIoInstance () {
678                 return $this->fileIoInstance;
679         }
680
681         /**
682          * Setter for file I/O instance
683          *
684          * @param       $fileIoInstance An instance to the file I/O sub-system
685          * @return      void
686          */
687         public final function setFileIoInstance (FileIoHandler $fileIoInstance) {
688                 $this->fileIoInstance = $fileIoInstance;
689         }
690
691         /**
692          * Prepare the template engine (WebTemplateEngine by default) for a given
693          * application helper instance (ApplicationHelper by default).
694          *
695          * @param               $appInstance                    An application helper instance or
696          *                                                                              null if we shall use the default
697          * @return              $templateInstance                               The template engine instance
698          * @throws              NullPointerException    If the template engine could not
699          *                                                                              be initialized
700          * @throws              UnsupportedTemplateEngineException      If $templateInstance is an
701          *                                                                              unsupported template engine
702          * @throws              MissingLanguageHandlerException If the language sub-system
703          *                                                                              is not yet initialized
704          * @throws              NullPointerException    If the discovered application
705          *                                                                              instance is still null
706          */
707         protected function prepareTemplateInstance (BaseFrameworkSystem $appInstance=null) {
708                 // Is the application instance set?
709                 if (is_null($appInstance)) {
710                         // Get the current instance
711                         $appInstance = $this->getApplicationInstance();
712
713                         // Still null?
714                         if (is_null($appInstance)) {
715                                 // Thrown an exception
716                                 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
717                         } // END - if
718                 } // END - if
719
720                 // Generate FQFN for all application templates
721                 $fqfn = sprintf("%s%s/%s/%s",
722                         PATH,
723                         $this->getConfigInstance()->readConfig('application_path'),
724                         strtolower($appInstance->getAppShortName()),
725                         $this->getConfigInstance()->readConfig('tpl_base_path')
726                 );
727
728                 // Are both instances set?
729                 if ($appInstance->getLanguageInstance() === null) {
730                         // Invalid language instance
731                         throw new MissingLanguageHandlerException($appInstance, self::EXCEPTION_MISSING_LANGUAGE_HANDLER);
732                 } elseif ($appInstance->getFileIoInstance() === null) {
733                         // Invalid language instance
734                         throw new MissingFileIoHandlerException($appInstance, self::EXCEPTION_MISSING_FILE_IO_HANDLER);
735                 }
736
737                 // Initialize the template engine
738                 $templateInstance = ObjectFactory::createObjectByConfiguredName('template_class', array($fqfn, $appInstance->getLanguageInstance(), $appInstance->getFileIoInstance()));
739
740                 // Return the prepared instance
741                 return $templateInstance;
742         }
743
744         /**
745          * Debugs this instance by putting out it's full content
746          *
747          * @return      void
748          */
749         public final function debugInstance () {
750                 // Restore the error handler to avoid trouble with missing array elements or undeclared variables
751                 restore_error_handler();
752
753                 // Generate the output
754                 $content = sprintf("<pre>%s</pre>",
755                         trim(
756                                 htmlentities(
757                                         print_r($this, true)
758                                 )
759                         )
760                 );
761
762                 // Output it
763                 ApplicationEntryPoint::app_die(sprintf("<strong>%s debug output:</strong><div id=\"debug_content\">%s</div>\nLoaded includes: <div id=\"debug_include_list\">%s</div>",
764                         $this->__toString(),
765                         $content,
766                         ClassLoader::getInstance()->getPrintableIncludeList()
767                 ));
768         }
769
770         /**
771          * Output a partial stub message for the caller method
772          *
773          * @param       $message        An optional message to display
774          * @return      void
775          */
776         protected function partialStub ($message = "") {
777                 // Get the backtrace
778                 $backtrace = debug_backtrace();
779
780                 // Generate the class::method string
781                 $methodName = "UnknownClass-&gt;unknownMethod";
782                 if ((isset($backtrace[1]['class'])) && (isset($backtrace[1]['function']))) {
783                         $methodName = $backtrace[1]['class']."-&gt;".$backtrace[1]['function'];
784                 } // END - if
785
786                 // Construct the full message
787                 $stubMessage = sprintf("[%s:] Partial stub!",
788                         $methodName
789                 );
790
791                 // Is the extra message given?
792                 if (!empty($message)) {
793                         // Then add it as well
794                         $stubMessage .= sprintf(" Message: <span id=\"stub_message\">%s</span>", $message);
795                 } // END - if
796
797                 // Debug instance is there?
798                 if (!is_null($this->getDebugInstance())) {
799                         // Output stub message
800                         $this->debugOutput($stubMessage);
801                 } else {
802                         // Trigger an error
803                         trigger_error($stubMessage."<br />\n");
804                 }
805         }
806
807         /**
808          * Outputs a debug backtrace and stops further script execution
809          *
810          * @return      void
811          */
812         public function debugBackTrace () {
813                 // Sorry, there is no other way getting this nice backtrace
814                 print "<pre>\n";
815                 debug_print_backtrace();
816                 print "</pre>";
817                 exit;
818         }
819
820         /**
821          * Outputs a debug message wether to debug instance (should be set!) or dies with or pints the message
822          *
823          * @param       $message        Message we shall send out...
824          * @param       $doPrint        Wether we shall print or die here which first is the default
825          * @return      void
826          */
827         public function debugOutput ($message, $doPrint = true) {
828                 // Get debug instance
829                 $debugInstance = $this->getDebugInstance();
830
831                 // Is the debug instance there?
832                 if (is_object($debugInstance)) {
833                         // Use debug output handler
834                         $debugInstance->output($message);
835                         if (!$doPrint) die(); // Die here if not printed
836                 } else {
837                         // Put directly out
838                         if ($doPrint) {
839                                 print($message);
840                         } else {
841                                 // DO NOT REWRITE THIS TO app_die() !!!
842                                 die($message);
843                         }
844                 }
845         }
846
847         /**
848          * Converts e.g. a command from URL to a valid class by keeping out bad characters
849          *
850          * @param       $str            The string, what ever it is needs to be converted
851          * @return      $className      Generated class name
852          */
853         public function convertToClassName ($str) {
854                 // Init class name
855                 $className = "";
856
857                 // Convert all dashes in underscores
858                 $str = str_replace("-", "_", $str);
859
860                 // Now use that underscores to get classname parts for hungarian style
861                 foreach (explode("_", $str) as $strPart) {
862                         // Make the class name part lower case and first upper case
863                         $className .= ucfirst(strtolower($strPart));
864                 } // END - foreach
865
866                 // Return class name
867                 return $className;
868         }
869
870         /**
871          * Marks up the code by adding e.g. line numbers
872          *
873          * @param       $phpCode                Unmarked PHP code
874          * @return      $markedCode             Marked PHP code
875          */
876         public function markupCode ($phpCode) {
877                 // Init marked code
878                 $markedCode = "";
879
880                 // Get last error
881                 $errorArray = error_get_last();
882
883                 // Init the code with error message
884                 if (is_array($errorArray)) {
885                         // Get error infos
886                         $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>",
887                                 basename($errorArray['file']),
888                                 $errorArray['line'],
889                                 $errorArray['message'],
890                                 $errorArray['type']
891                         );
892                 } // END - if
893
894                 // Add line number to the code
895                 foreach (explode("\n", $phpCode) as $lineNo=>$code) {
896                         // Add line numbers
897                         $markedCode .= sprintf("<span id=\"code_line\">%s</span>: %s\n",
898                                 ($lineNo + 1),
899                                 htmlentities($code, ENT_QUOTES)
900                         );
901                 } // END - foreach
902
903                 // Return the code
904                 return $markedCode;
905         }
906
907         /**
908          * Filter a given GMT timestamp (non Uni* stamp!) to make it look more
909          * beatiful for web-based front-ends. If null is given a message id
910          * null_timestamp will be resolved and returned.
911          *
912          * @param       $timestamp      Timestamp to prepare (filter) for display
913          * @return      $readable       A readable timestamp
914          */
915         public function doFilterFormatTimestamp ($timestamp) {
916                 // Default value to return
917                 $readable = "???";
918
919                 // Is the timestamp null?
920                 if (is_null($timestamp)) {
921                         // Get a message string
922                         $readable = $this->getLanguageInstance()->getMessage('null_timestamp');
923                 } else {
924                         switch ($this->getLanguageInstance()->getLanguageCode()) {
925                                 case "de": // German format is a bit different to default
926                                         // Split the GMT stamp up
927                                         $dateTime = explode(" ", $timestamp);
928                                         $dateArray = explode("-", $dateTime[0]);
929                                         $timeArray = explode(":", $dateTime[1]);
930
931                                         // Construct the timestamp
932                                         $readable = sprintf($this->getConfigInstance()->readConfig('german_date_time'),
933                                                 $dateArray[0],
934                                                 $dateArray[1],
935                                                 $dateArray[2],
936                                                 $timeArray[0],
937                                                 $timeArray[1],
938                                                 $timeArray[2]
939                                         );
940                                         break;
941
942                                 default: // Default is pass-through
943                                         $readable = $timestamp;
944                                         break;
945                         }
946                 }
947
948                 // Return the stamp
949                 return $readable;
950         }
951
952         /**
953          * "Getter" for databse entry
954          *
955          * @return      $entry  An array with database entries
956          * @throws      NullPointerException    If the database result is not found
957          * @throws      InvalidDatabaseResultException  If the database result is invalid
958          */
959         protected final function getDatabaseEntry () {
960                 // Is there an instance?
961                 if (is_null($this->getResultInstance())) {
962                         // Throw an exception here
963                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
964                 } // END - if
965
966                 // Rewind it
967                 $this->getResultInstance()->rewind();
968
969                 // Do we have an entry?
970                 if (!$this->getResultInstance()->valid()) {
971                         throw new InvalidDatabaseResultException(array($this, $this->getResultInstance()), DatabaseResult::EXCEPTION_INVALID_DATABASE_RESULT);
972                 } // END - if
973
974                 // Get next entry
975                 $this->getResultInstance()->next();
976
977                 // Fetch it
978                 $entry = $this->getResultInstance()->current();
979
980                 // And return it
981                 return $entry;
982         }
983
984         /**
985          * Getter for field name
986          *
987          * @param       $fieldName              Field name which we shall get
988          * @return      $fieldValue             Field value from the user
989          * @throws      NullPointerException    If the result instance is null
990          */
991         public final function getField ($fieldName) {
992                 // Default field value
993                 $fieldValue = null;
994
995                 // Get result instance
996                 $resultInstance = $this->getResultInstance();
997
998                 // Is this instance null?
999                 if (is_null($resultInstance)) {
1000                         // Then the user instance is no longer valid (expired cookies?)
1001                         throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
1002                 } // END - if
1003
1004                 // Get current array
1005                 $fieldArray = $resultInstance->current();
1006
1007                 // Does the field exist?
1008                 if (isset($fieldArray[$fieldName])) {
1009                         // Get it
1010                         $fieldValue = $fieldArray[$fieldName];
1011                 } // END - if
1012
1013                 // Return it
1014                 return $fieldValue;
1015         }
1016
1017         /**
1018          * Protected setter for user instance
1019          *
1020          * @param       $userInstance   An instance of a user class
1021          * @return      void
1022          */
1023         protected final function setUserInstance (ManageableAccount $userInstance) {
1024                 $this->userInstance = $userInstance;
1025         }
1026
1027         /**
1028          * Getter for user instance
1029          *
1030          * @return      $userInstance   An instance of a user class
1031          */
1032         public final function getUserInstance () {
1033                 return $this->userInstance;
1034         }
1035 }
1036
1037 // [EOF]
1038 ?>