eval() commands replace by improved object factory, user login class stub added
[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          * The instance to the debug output handler (should be DebugConsoleOutput or DebugWebOutput)
28          *
29          * @see         DebugConsoleOutput
30          * @see         DebugWebOutput
31          */
32         private static $debug       = null;
33
34         /**
35          * The instance to the web output handler (should be WebOutput)
36          *
37          * @see         WebOutput
38          */
39         private static $webOutput   = null;
40
41         /**
42          * The instance to the compression layer which should be CompressorChannel
43          */
44         private static $compressor  = null;
45
46         /**
47          * The configuration instance which shall be FrameworkConfiguration
48          */
49         private static $cfgInstance = null;
50
51         /**
52          * The instance to the database layer which should be DatabaseConnection
53          */
54         private $dbInstance  = null;
55
56         /**
57          * Instance to an application helper class
58          */
59         private $applicationInstance = null;
60
61         /**
62          * The real class name
63          */
64         private $realClass      = "FrameworkSystem";
65
66         /**
67          * A human-readable description for this simulator part
68          */
69         private $objectDescription      = "Namenlose Framework-Einheit";
70
71         /**
72          * The unique ID string for identifying all type of classes
73          */
74         private $uniqueID = "";
75
76         /**
77          * Thousands seperator
78          */
79         private $thousands = "."; // German
80
81         /**
82          * Decimal seperator
83          */
84         private $decimals  = ","; // German
85
86         /**
87          * The language instance for the template loader
88          */
89         private $langInstance = null;
90
91         /**
92          * The file I/O instance for the template loader
93          */
94         private $fileIOInstance = null;
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_INVALID_COMMAND              = 0x031;
149         const EXCEPTION_INVALID_CONTROLLER           = 0x032;
150         const EXCEPTION_HEADERS_ALREADY_SENT         = 0x033;
151         const EXCEPTION_DEFAUL_CONTROLLER_GONE       = 0x034;
152         const EXCEPTION_CLASS_NOT_FOUND              = 0x035;
153         const EXCEPTION_REQUIRED_INTERFACE_MISSING   = 0x036;
154
155         /**
156          * In the super constructor these system classes shall be ignored or else
157          * we would get an endless calling loop.
158          *
159          *--------------------------------------------------------------------*
160          * ATTENTION: IF YOU REMOVE ONE OF THEM YOU WILL SHOOT YOUR SERVER!!! *
161          *--------------------------------------------------------------------*
162          */
163         private $systemClasses = array(
164                 "DebugMiddleware",                              // Debug middleware output sub-system
165                 "DebugWebOutput",                               // Debug web output sub-system
166                 "DebugConsoleOutput",                   // Debug console output sub-system
167                 "DebugErrorLogOutput",                  // Debug error_log() output sub-system
168                 "CompressorChannel",                    // Compressor sub-system
169                 "FrameworkDirectoryPointer",    // Directory handler sub-system
170                 "NullCompressor",                               // Null compressor
171                 "Bzip2Compressor",                              // BZIP2 compressor
172                 "GzipCompressor",                               // GZIP compressor
173                 "WebOutput",                                    // Web output sub-system
174         );
175
176         /**
177          * Private super constructor
178          *
179          * @return      void
180          */
181         protected function __construct ($class) {
182                 // Set real class
183                 $this->setRealClass($class);
184
185                 // Init this instance
186                 $this->initInstance($class);
187         }
188
189         /**
190          * Destructor reached...
191          *
192          * @return      void
193          */
194         public function __destruct() {
195                 // Is this object already destroyed?
196                 if ($this->__toString() != "DestructedObject") {
197                         // Debug message
198                         if ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
199                                 $this->getDebugInstance()->output(sprintf("[%s:] Das Objekt <strong>%s</strong> wird zerst&ouml;rt.<br />\n",
200                                         __CLASS__, $this->__toString()
201                                 ));
202                         }
203
204                         // Destroy all informations about this class but keep some text about it alive
205                         $this->setObjectDescription(sprintf("Entferntes Objekt <em>%s</em>", $this->__toString()));
206                         $this->setRealClass("DestructedObject");
207                         $this->resetUniqueID();
208                 } elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
209                         // Already destructed object
210                         $this->getDebugInstance()->output(sprintf("[%s:] Das Objekt <strong>%s</strong> wurde bereits zerst&ouml;rt.<br />\n",
211                                 __CLASS__, $this->__toString()
212                         ));
213                 }
214         }
215
216         /**
217          * The call method where all non-implemented methods end up
218          *
219          * @return      void
220          */
221         public final function __call ($methodName, $args) {
222                 // Implode all given arguments
223                 $argsString = "";
224                 if (empty($args)) {
225                         // No arguments
226                         $argsString = "NULL";
227                 } elseif (is_array($args)) {
228                         // Some arguments are there
229                         foreach ($args as $arg) {
230                                 // Check the type
231                                 if (is_bool($arg)) {
232                                         // Boolean!
233                                         if ($arg) $argsString .= "true(bool)"; else $argsString .= "false(bool)";
234                                 } elseif (is_int($arg)) {
235                                         // Integer
236                                         $argsString .= $arg."(int)";
237                                 } elseif (is_float($arg)) {
238                                         // Floating point
239                                         $argsString .= $arg."(float)";
240                                 } elseif ($arg instanceof BaseFrameworkSystem) {
241                                         // Own object instance
242                                         $argsString .= $arg->__toString()."(Object)";
243                                 } elseif (is_object($arg)) {
244                                         // External object
245                                         $argsString .= "unknown object(!)";
246                                 } elseif (is_array($arg)) {
247                                         // Array
248                                         $argsString .= "Array(array)";
249                                 } elseif (is_string($arg)) {
250                                         // String
251                                         $argsString .= "\"".$arg."\"(string)";
252                                 } elseif (is_null($arg)) {
253                                         // Null
254                                         $argsString .= "(null)";
255                                 } else {
256                                         // Unknown type (please report!)
257                                         $argsString .= $arg."(unknown!)";
258                                 }
259
260                                 // Add comma
261                                 $argsString .= ", ";
262                         }
263
264                         // Remove last comma
265                         if (substr($argsString, -2, 1) === ",") $argsString = substr($argsString, 0, -2);
266                 } else {
267                         // Invalid arguments!
268                         $argsString = sprintf("!INVALID:%s!", $args);
269                 }
270
271                 $this->getDebugInstance()->output(sprintf("[%s::%s] Stub! Args: %s",
272                         $this->__toString(),
273                         $methodName,
274                         $argsString
275                 ));
276
277                 // Return nothing
278                 return null;
279         }
280
281         /**
282          * Initializes the instance
283          *
284          * @return      void
285          */
286         public function initInstance ($class) {
287                 // Get the current (singleton) configuration instance
288                 $this->setConfigInstance(FrameworkConfiguration::createFrameworkConfiguration());
289
290                 // Is the class weather debug nor compressor channel?
291                 if (!in_array($class, $this->systemClasses)) {
292                         // Initialize debug instance
293                         if (is_null($this->getDebugInstance())) {
294                                 // Set the debug output system if it is not debug class ;)
295                                 $this->setDebugInstance(DebugMiddleware::createDebugMiddleware($this->getConfigInstance()->readConfig('debug_engine')));
296                         } // END - if
297
298                         // Initialize web instance
299                         if ((is_null($this->getWebOutputInstance())) && ($this->__toString() != "ObjectFactory")) {
300                                 // Call our object factory
301                                 $outputInstance = ObjectFactory::createObjectByConfiguredName('web_engine', array($this->getConfigInstance()->readConfig('web_content_type')));
302
303                                 // And set the instance
304                                 $this->setWebOutputInstance($outputInstance);
305                         } // END - if
306
307                         // Initialize compressor channel
308                         if (is_null($this->getCompressorChannel())) {
309                                 // Set the compressor channel
310                                 $this->setCompressorChannel(CompressorChannel::createCompressorChannel(sprintf("%s%s",
311                                         PATH,
312                                         $this->getConfigInstance()->readConfig('compressor_base_path')
313                                 )));
314                         } // END - if
315
316                         // Initialize database middleware
317                         if (is_null($this->getDatabaseInstance())) {
318                                 // Get the middleware instance
319                                 $db = DatabaseConnection::getInstance();
320                                 if (is_object($db)) {
321                                         // Set the database middleware
322                                         $this->setDatabaseInstance($db);
323                                 } // END - if
324                         } // END - if
325                 } // END - if
326         }
327
328         /**
329          * Setter for language instance
330          *
331          * @param       $configInstance         The configuration instance which shall
332          *                                                              be FrameworkConfiguration
333          * @return      void
334          */
335         public final function setConfigInstance (FrameworkConfiguration $configInstance) {
336                 self::$cfgInstance = $configInstance;
337         }
338
339         /**
340          * Getter for configuration instance
341          *
342          * @return      $cfhInstance - Configuration instance
343          */
344         protected final function getConfigInstance () {
345                 return self::$cfgInstance;
346         }
347
348         /**
349          * Setter for debug instance
350          *
351          * @param               $debugInstance  The instance for debug output class
352          * @return      void
353          */
354         public final function setDebugInstance (DebugMiddleware $debugInstance) {
355                 self::$debug = $debugInstance;
356         }
357
358         /**
359          * Getter for debug instance
360          *
361          * @return      $debug - Instance to class DebugConsoleOutput or DebugWebOutput
362          */
363         public final function getDebugInstance () {
364                 return self::$debug;
365         }
366
367         /**
368          * Setter for web output instance
369          *
370          * @param               $webInstance    The instance for web output class
371          * @return      void
372          */
373         public final function setWebOutputInstance (OutputStreamer $webInstance) {
374                 self::$webOutput = $webInstance;
375         }
376
377         /**
378          * Getter for web output instance
379          *
380          * @return      $webOutput - Instance to class WebOutput
381          */
382         public final function getWebOutputInstance () {
383                 return self::$webOutput;
384         }
385
386         /**
387          * Static setter for database instance
388          *
389          * @param               $dbInstance     The instance for the database connection
390          *                                      (forced DatabaseConnection)
391          * @return      void
392          */
393         public final function setDatabaseInstance (DatabaseConnection $dbInstance) {
394                 $this->dbInstance = $dbInstance;
395         }
396
397         /**
398          * Getter for $realClass
399          *
400          * @return      $realClass The name of the real class (not BaseFrameworkSystem)
401          */
402         public final function __toString () {
403                 return $this->realClass;
404         }
405
406         /**
407          * Setter for the real class name
408          *
409          * @param               $realClass      Class name (string)
410          * @return      void
411          */
412         public final function setRealClass ($realClass) {
413                 // Cast to string
414                 $realClass = (string) $realClass;
415
416                 // Set real class
417                 $this->realClass = $realClass;
418         }
419
420         /**
421          * Generate unique ID from a lot entropy
422          *
423          * @return      void
424          */
425         public final function generateUniqueId () {
426                 // Existiert noch keine?
427                 if (empty($this->uniqueID)) {
428
429                         // Correct missing class name
430                         $corrected = false;
431                         if ($this->__toString() == "") {
432                                 $this->setRealClass(__CLASS__);
433                                 $corrected = true;
434                         }
435
436                         // Neue ID erstellen
437                         $tempID = false;
438                         while (true) {
439                                 // Generate a unique ID number
440                                 $tempID = $this->generateIdNumber();
441                                 $isUsed = false;
442
443                                 // Try to figure out if the ID number is not yet used
444                                 try {
445                                         if (is_object($this->getDatabaseInstance())) {
446                                                 $isUsed = $this->getDatabaseInstance()->isUniqueIdUsed($tempID, true);
447                                         }
448                                 } catch (FrameworkException $e) {
449                                         // Catches all and ignores all ;-)
450                                 }
451
452                                 if (
453                                         (
454                                                 $tempID !== false
455                                         ) && (
456                                                 (
457                                                         $this->getDatabaseInstance() === null
458                                                 ) || (
459                                                         (
460                                                                 is_object($this->getDatabaseInstance())
461                                                         ) && (
462                                                                 !$isUsed
463                                                         )
464                                                 )
465                                         )
466                                 ) {
467                                         // Abort the loop
468                                         break;
469                                 }
470                         } // END - while
471
472                         // Apply the new ID
473                         $this->setUniqueID($tempID);
474
475                         // Revert maybe corrected class name
476                         if ($corrected) {
477                                 $this->setRealClass("");
478                         }
479
480                         // Remove system classes if we are in a system class
481                         if ((isset($this->systemClasses)) && (in_array($this->__toString(), $this->systemClasses))) {
482                                 // This may save some RAM...
483                                 $this->removeSystemArray();
484                         }
485                 }
486         }
487
488         /**
489          * Generates a new ID number for classes based from the class' real name,
490          * the description and some random data
491          *
492          * @return      $tempID The new (temporary) ID number
493          */
494         private final function generateIdNumber () {
495                 return sprintf("%s@%s",
496                         $this->__toString(),
497                         md5(sprintf("%s:%s:%s:%s:%s:%s",
498                                 $this->__toString(),
499                                 $this->getObjectDescription(),
500                                 time(),
501                                 getenv('REMOTE_ADDR'),
502                                 getenv('SERVER_ADDR'),
503                                 mt_rand()
504                         ))
505                 );
506         }
507
508         /**
509          * Setter for unique ID
510          *
511          * @param               $uniqueID               The newly generated unique ID number
512          * @return      void
513          */
514         private final function setUniqueID ($uniqueID) {
515                 // Cast to string
516                 $uniqueID = (string) $uniqueID;
517
518                 // Set the ID number
519                 $this->uniqueID = $uniqueID;
520         }
521
522         /**
523          * Getter for unique ID
524          *
525          * @return      $uniqueID               The unique ID of this class
526          */
527         public final function getUniqueID () {
528                 return $this->uniqueID;
529         }
530
531         /**
532          * Resets or recreates the unique ID number
533          *
534          * @return      void
535          */
536         public final function resetUniqueID() {
537                 // Sweet and simple... ;-)
538                 $newUniqueID = $this->generateIdNumber();
539                 $this->setUniqueID($newUniqueID);
540         }
541
542         /**
543          * Getter for simulator description
544          *
545          * @return      $objectDescription      The description of this simulation part
546          */
547         public final function getObjectDescription () {
548                 if (isset($this->objectDescription)) {
549                         return $this->objectDescription;
550                 } else {
551                         return null;
552                 }
553         }
554
555         /**
556          * Setter for simulation part description
557          *
558          * @param               $objectDescription      The description as string for this simulation part
559          * @return      void
560          */
561         public final function setObjectDescription ($objectDescription) {
562                 $this->objectDescription = (String) $objectDescription;
563         }
564
565         /**
566          * Validate if given object is the same as current
567          *
568          * @param               $object An object instance for comparison with this class
569          * @return      boolean The result of comparing both's unique ID
570          */
571         public final function equals ($object) {
572                 return ($this->getUniqueID() == $object->getUniqueID());
573         }
574
575         /**
576          * Compare if both simulation part description and class name matches
577          * (shall be enougth)
578          *
579          * @param               $itemInstance   An object instance to an other class
580          * @return      boolean         The result of comparing class name simulation part description
581          */
582         public function itemMatches ($itemInstance) {
583                 return (
584                         (
585                                 $this->__toString()   == $itemInstance->__toString()
586                         ) && (
587                                 $this->getObjectDescription() == $itemInstance->getObjectDescription()
588                         )
589                 );
590         }
591
592         /**
593          * Compare class name of this and given class name
594          *
595          * @param               $class  The class name as string from the other class
596          * @return      boolean The result of comparing both class names
597          */
598         public final function isClass ($class) {
599                 return ($this->__toString() == $class);
600         }
601
602         /**
603          * Stub method (only real cabins shall override it)
604          *
605          * @return      boolean false = is no cabin, true = is a cabin
606          */
607         public function isCabin () {
608                 return false;
609         }
610
611         /**
612          * Stub method for tradeable objects
613          *
614          * @return      boolean false = is not tradeable by the Merchant class,
615          *                                      true  = is a tradeable object
616          */
617         public function isTradeable () {
618                 return false;
619         }
620
621         /**
622          * Formats computer generated price values into human-understandable formats
623          * with thousand and decimal seperators.
624          *
625          * @param       $value          The in computer format value for a price
626          * @param       $currency       The currency symbol (use HTML-valid characters!)
627          * @param       $decNum         Number of decimals after commata
628          * @return      $price          The for the current language formated price string
629          * @throws      MissingDecimalsThousandsSeperatorException      If decimals or
630          *                                                                                              thousands seperator
631          *                                                                                              is missing
632          */
633         public function formatCurrency ($value, $currency = "&euro;", $decNum = 2) {
634                 // Are all required attriutes set?
635                 if ((!isset($this->decimals)) || (!isset($this->thousands))) {
636                         // Throw an exception
637                         throw new MissingDecimalsThousandsSeperatorException($this, self::EXCEPTION_ATTRIBUTES_ARE_MISSING);
638                 }
639
640                 // Cast the number
641                 $value = (float) $value;
642
643                 // Reformat the US number
644                 $price = sprintf("%s %s",
645                         number_format($value, $decNum, $this->decimals, $this->thousands),
646                         $currency
647                 );
648
649                 // Return as string...
650                 return $price;
651         }
652
653         /**
654          * Removes number formating characters
655          *
656          * @return      void
657          */
658         public final function removeNumberFormaters () {
659                 unset($this->thousands);
660                 unset($this->decimals);
661         }
662
663         /**
664          * Getter for database layer
665          *
666          * @return      $dbInstance     The database layer instance
667          */
668         public final function getDatabaseInstance () {
669                 return $this->dbInstance;
670         }
671
672         /**
673          * Setter for compressor channel
674          *
675          * @param               $compressorChannel      An instance of CompressorChannel
676          * @return      void
677          */
678         public final function setCompressorChannel (CompressorChannel $compressorChannel) {
679                 self::$compressor = $compressorChannel;
680         }
681
682         /**
683          * Getter for compressor channel
684          *
685          * @return      $compressor     The compressor channel
686          */
687         public final function getCompressorChannel () {
688                 return self::$compressor;
689         }
690
691         /**
692          * Remove the $systemClasses array from memory
693          *
694          * @return      void
695          */
696         public final function removeSystemArray () {
697                 unset($this->systemClasses);
698         }
699
700         /**
701          * Create a file name and path name from the object's unique ID number.
702          * The left part of the ID shall always be a valid class name and the
703          * right part an ID number.
704          *
705          * @return      $pfn            The file name with a prepended path name
706          * @throws      NoArrayCreatedException If explode() fails to create an array
707          * @throws      InvalidArrayCountException      If the array contains less or
708          *                                                                      more than two elements
709          */
710         public final function getPathFileNameFromObject () {
711                 // Get the main object's unique ID. We use this as a path/filename combination
712                 $pathFile = $this->getUniqueID();
713
714                 // Split it up in path and file name
715                 $pathFile = explode("@", $pathFile);
716
717                 // Are there two elements? Index 0 is the path, 1 the file name + global extension
718                 if (!is_array($pathFile)) {
719                         // No array found
720                         throw new NoArrayCreatedException(array($this, "pathFile"), self::EXCEPTION_ARRAY_EXPECTED);
721                 } elseif (count($pathFile) != 2) {
722                         // Invalid ID returned!
723                         throw new InvalidArrayCountException(array($this, "pathFile", count($pathFile), 2), self::EXCEPTION_ARRAY_HAS_INVALID_COUNT);
724                 }
725
726                 // Auto-append missing trailing slash
727                 $pathFile[0] = $this->addMissingTrailingSlash($pathFile[0]);
728
729                 // Create the file name and return it
730                 $pfn = ($pathFile[0] . $pathFile[1]);
731                 return $pfn;
732         }
733
734         /**
735          * Appends a trailing slash to a string
736          *
737          * @param       $str            A string (maybe) without trailing slash
738          * @return      $str            A string with an auto-appended trailing slash
739          */
740         public final function addMissingTrailingSlash ($str) {
741                 // Is there a trailing slash?
742                 if (substr($str, -1, 1) != "/") $str .= "/";
743                 return $str;
744         }
745
746         /**
747          * Private getter for language instance
748          *
749          * @return      $langInstance   An instance to the language sub-system
750          */
751         protected final function getLanguageInstance () {
752                 return $this->langInstance;
753         }
754
755         /**
756          * Setter for language instance
757          *
758          * @param       $langInstance   An instance to the language sub-system
759          * @return      void
760          * @see         LanguageSystem
761          */
762         public final function setLanguageInstance (ManageableLanguage $langInstance) {
763                 $this->langInstance = $langInstance;
764         }
765
766         /**
767          * Private getter for file IO instance
768          *
769          * @return      $fileIOInstance An instance to the file I/O sub-system
770          */
771         protected final function getFileIoInstance () {
772                 return $this->fileIOInstance;
773         }
774
775         /**
776          * Setter for file I/O instance
777          *
778          * @param       $fileIOInstance An instance to the file I/O sub-system
779          * @return      void
780          */
781         public final function setFileIoInstance (FileIoHandler $fileIOInstance) {
782                 $this->fileIOInstance = $fileIOInstance;
783         }
784
785         /**
786          * Protected getter for a manageable application helper class
787          *
788          * @return      $applicationInstance    An instance of a manageable application helper class
789          */
790         protected final function getApplicationInstance () {
791                 return $this->applicationInstance;
792         }
793
794         /**
795          * Setter for a manageable application helper class
796          *
797          * @param       $applicationInstance    An instance of a manageable application helper class
798          * @return      void
799          */
800         public final function setApplicationInstance (ManageableApplication $applicationInstance) {
801                 $this->applicationInstance = $applicationInstance;
802         }
803
804         /**
805          * Prepare the template engine (TemplateEngine by default) for a given
806          * application helper instance (ApplicationHelper by default).
807          *
808          * @param               $appInstance                    An application helper instance or
809          *                                                                              null if we shall use the default
810          * @return              $tplEngine                              The template engine instance
811          * @throws              NullPointerException    If the template engine could not
812          *                                                                              be initialized
813          * @throws              UnsupportedTemplateEngineException      If $tplEngine is an
814          *                                                                              unsupported template engine
815          * @throws              MissingLanguageHandlerException If the language sub-system
816          *                                                                              is not yet initialized
817          * @throws              NullPointerException    If the discovered application
818          *                                                                              instance is still null
819          */
820         protected function prepareTemplateEngine (BaseFrameworkSystem $appInstance=null) {
821                 // Is the application instance set?
822                 if (is_null($appInstance)) {
823                         // Get the current instance
824                         $appInstance = $this->getApplicationInstance();
825
826                         // Still null?
827                         if (is_null($appInstance)) {
828                                 // Thrown an exception
829                                 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
830                         }
831                 }
832
833                 // Generate FQFN for all application templates
834                 $fqfn = sprintf("%s%s/%s/%s",
835                         PATH,
836                         $this->getConfigInstance()->readConfig('application_path'),
837                         strtolower($appInstance->getAppShortName()),
838                         $this->getConfigInstance()->readConfig('tpl_base_path')
839                 );
840
841                 // Are both instances set?
842                 if ($appInstance->getLanguageInstance() === null) {
843                         // Invalid language instance
844                         throw new MissingLanguageHandlerException($appInstance, self::EXCEPTION_MISSING_LANGUAGE_HANDLER);
845                 } elseif ($appInstance->getFileIoInstance() === null) {
846                         // Invalid language instance
847                         throw new MissingFileIoHandlerException($appInstance, self::EXCEPTION_MISSING_FILE_IO_HANDLER);
848                 }
849
850                 // Initialize the template engine
851                 $tplEngine = ObjectFactory::createObjectByConfiguredName('tpl_engine', array($fqfn, $appInstance->getLanguageInstance(), $appInstance->getFileIoInstance()));
852
853                 // Return the prepared instance
854                 return $tplEngine;
855         }
856
857         /**
858          * Debugs this instance by putting out it's full content
859          *
860          * @return      void
861          */
862         public final function debugInstance () {
863                 // Generate the output
864                 $content = sprintf("<pre>%s</pre>",
865                         trim(print_r($this, true))
866                 );
867
868                 // Output it
869                 ApplicationEntryPoint::app_die(sprintf("<strong>%s debug output:</strong>%s", $this->__toString(), $content));
870         }
871
872         /**
873          * Output a partial stub message for the caller method
874          *
875          * @param       $message        An optional message to display
876          * @return      void
877          */
878         protected function partialStub ($message = "") {
879                 // Get the backtrace
880                 $backtrace = debug_backtrace();
881
882                 // Generate the class::method string
883                 $methodName = "UnknownClass::unknownMethod";
884                 if ((isset($backtrace[1]['class'])) && (isset($backtrace[1]['function']))) {
885                         $methodName = $backtrace[1]['class']."::".$backtrace[1]['function'];
886                 }
887
888                 // Construct the full message
889                 $stubMessage = sprintf("[%s:] Partial stub!",
890                         $methodName
891                 );
892
893                 // Is the extra message given?
894                 if (!empty($message)) {
895                         // Then add it as well
896                         $stubMessage .= sprintf(" Message: <u>%s</u>", $message);
897                 }
898
899                 // Debug instance is there?
900                 if (!is_null($this->getDebugInstance())) {
901                         // Output stub message
902                         $this->getDebugInstance()->output($stubMessage);
903                 } else {
904                         // Trigger an error
905                         trigger_error($stubMessage."<br />\n");
906                 }
907         }
908
909         /**
910          * Converts e.g. a command from URL to a valid class by keeping out bad characters
911          *
912          * @param       $str            The string, what ever it is needs to be converted
913          * @return      $className      Generated class name
914          */
915         public function convertToClassName ($str) {
916                 $className = "";
917                 foreach (explode("_", $str) as $strPart) {
918                         $className .= ucfirst(strtolower($strPart));
919                 }
920                 return $className;
921         }
922
923         /**
924          * Outputs a debug backtrace and stops further script execution
925          *
926          * @return      void
927          */
928         public function debugBacktrace () {
929                 // Sorry, there is no other way getting this nice backtrace
930                 print "<pre>\n";
931                 debug_print_backtrace();
932                 print "</pre>";
933                 exit;
934         }
935 }
936
937 // [EOF]
938 ?>