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