3 * The simulator system class is the super class of all other classes. This
4 * class handles saving of games etc.
6 * @author Roland Haeder <webmaster@ship-simu.org>
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
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.
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.
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/>.
25 class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
27 * The instance to the debug output handler (should be DebugConsoleOutput or DebugWebOutput)
29 * @see DebugConsoleOutput
32 private static $debug = null;
35 * The instance to the web output handler (should be WebOutput)
39 private static $webOutput = null;
42 * The instance to the compression layer which should be CompressorChannel
44 private static $compressor = null;
47 * The configuration instance which shall be FrameworkConfiguration
49 private static $cfgInstance = null;
52 * The instance to the database layer which should be DatabaseConnection
54 private $dbInstance = null;
57 * Instance to an application helper class
59 private $applicationInstance = null;
64 private $realClass = "FrameworkSystem";
67 * A human-readable description for this simulator part
69 private $objectDescription = "Namenlose Framework-Einheit";
72 * The unique ID string for identifying all type of classes
74 private $uniqueID = "";
79 private $thousands = "."; // German
84 private $decimals = ","; // German
87 * The language instance for the template loader
89 private $langInstance = null;
92 * The file I/O instance for the template loader
94 private $fileIOInstance = null;
96 /***********************
97 * Exception codes.... *
98 ***********************/
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;
153 * In the super constructor these system classes shall be ignored or else
154 * we would get an endless calling loop.
156 *--------------------------------------------------------------------*
157 * ATTENTION: IF YOU REMOVE ONE OF THEM YOU WILL SHOOT YOUR SERVER!!! *
158 *--------------------------------------------------------------------*
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
174 * Private super constructor
178 protected function __construct ($class) {
180 $this->setRealClass($class);
182 // Init this instance
183 $this->initInstance($class);
187 * Destructor reached...
191 public function __destruct() {
192 // Is this object already destroyed?
193 if ($this->__toString() != "DestructedObject") {
195 if ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
196 $this->getDebugInstance()->output(sprintf("[%s:] Das Objekt <strong>%s</strong> wird zerstört.<br />\n",
197 __CLASS__, $this->__toString()
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ört.<br />\n",
208 __CLASS__, $this->__toString()
214 * The call method where all non-implemented methods end up
218 public final function __call ($methodName, $args) {
219 // Implode all given arguments
220 $argsString = implode("|", $args);
221 if (empty($argsString)) $argsString = "NULL";
223 $this->getDebugInstance()->output(sprintf("[%s::%s] Stub! Args: %s",
234 * Initializes the instance
238 public function initInstance ($class) {
239 // Get the current (singleton) configuration instance
240 $this->setConfigInstance(FrameworkConfiguration::createFrameworkConfiguration());
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")));
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")
260 if ((defined('DEBUG_EVAL')) || (defined('DEBUG_ALL'))) $this->getDebugInstance()->output(sprintf("[%s:] Konstruierte PHP-Anweisung: <pre><em>%s</em></pre><br />\n",
269 // Initialize compressor channel
270 if (is_null($this->getCompressorChannel())) {
271 // Set the compressor channel
272 $this->setCompressorChannel(CompressorChannel::createCompressorChannel(sprintf("%s%s",
274 $this->getConfigInstance()->readConfig("compressor_base_path")
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);
289 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Alle Sub-Systeme sind initialisiert.<br />\n",
296 * Setter for language instance
298 * @param $configInstance The configuration instance which shall
299 * be FrameworkConfiguration
302 public final function setConfigInstance (FrameworkConfiguration $configInstance) {
303 self::$cfgInstance = $configInstance;
304 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Konfigurations-Handler auf <strong>%s</strong> gesetzt.<br />\n",
306 $configInstance->__toString()
311 * Getter for configuration instance
313 * @return $cfhInstance - Configuration instance
315 public final function getConfigInstance () {
316 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Konfigurations-Handler <strong>%s</strong> angefordert.<br />\n",
318 self::$cfgInstance->__toString()
320 return self::$cfgInstance;
324 * Setter for debug instance
326 * @param $debugInstance The instance for debug output class
329 public final function setDebugInstance (DebugMiddleware $debugInstance) {
330 self::$debug = $debugInstance;
331 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Debug-Handler auf <strong>%s</strong> gesetzt.<br />\n",
333 $this->getDebugInstance()->__toString()
338 * Getter for debug instance
340 * @return $debug - Instance to class DebugConsoleOutput or DebugWebOutput
342 public final function getDebugInstance () {
347 * Setter for web output instance
349 * @param $webInstance The instance for web output class
352 public final function setWebOutputInstance (OutputStreamer $webInstance) {
353 self::$webOutput = $webInstance;
354 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Web-Handler auf <strong>%s</strong> gesetzt.<br />\n",
356 $this->getWebOutputInstance()->__toString()
361 * Getter for web output instance
363 * @return $webOutput - Instance to class WebOutput
365 public final function getWebOutputInstance () {
366 return self::$webOutput;
370 * Static setter for database instance
372 * @param $dbInstance The instance for the database connection
373 * (forced DatabaseConnection)
376 public final function setDatabaseInstance (DatabaseConnection $dbInstance) {
377 if ((defined('DEBUG_SYSTEM')) && (is_object($dbInstance->getDebugInstance()))) $dbInstance->getDebugInstance()->output(sprintf("[%s:] Datenbankschicht gesetzt.<br />\n",
378 $dbInstance->__toString()
380 $this->dbInstance = $dbInstance;
384 * Getter for $realClass
386 * @return $realClass The name of the real class (not BaseFrameworkSystem)
388 public final function __toString () {
389 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] __toString() erreicht.<br />\n",
392 return $this->realClass;
396 * Setter for the real class name
398 * @param $realClass Class name (string)
401 public final function setRealClass ($realClass) {
403 $realClass = (string) $realClass;
406 $this->realClass = $realClass;
410 * Generate unique ID from a lot entropy
414 public final function createUniqueID () {
415 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] createUniqueID aufgerufen.<br />\n",
419 // Existiert noch keine?
420 if (empty($this->uniqueID)) {
421 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] createUniqueID erzeugt neue Unique-ID.<br />\n",
425 // Correct missing class name
427 if ($this->__toString() == "") {
428 $this->setRealClass(__CLASS__);
435 // Generate a unique ID number
436 $tempID = $this->generateIdNumber();
439 // Try to figure out if the ID number is not yet used
441 if (is_object($this->getDatabaseInstance())) {
442 $isUsed = $this->getDatabaseInstance()->isUniqueIdUsed($tempID, true);
444 } catch (FrameworkException $e) {
445 // Catches all and ignores all ;-)
453 $this->getDatabaseInstance() === null
456 is_object($this->getDatabaseInstance())
469 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] uniqueID ist auf <strong>%s</strong> gesetzt.<br />\n",
475 $this->setUniqueID($tempID);
477 // Revert maybe corrected class name
479 $this->setRealClass("");
482 // Remove system classes if we are in a system class
483 if ((isset($this->systemClasses)) && (in_array($this->__toString(), $this->systemClasses))) {
484 // This may save some RAM...
485 $this->removeSystemArray();
491 * Generates a new ID number for classes based from the class' real name,
492 * the description and some random data
494 * @return $tempID The new (temporary) ID number
496 private final function generateIdNumber () {
497 return sprintf("%s@%s",
499 md5(sprintf("%s:%s:%s:%s:%s:%s",
501 $this->getObjectDescription(),
503 getenv('REMOTE_ADDR'),
504 getenv('SERVER_ADDR'),
511 * Setter for unique ID
513 * @param $uniqueID The newly generated unique ID number
516 private final function setUniqueID ($uniqueID) {
518 $uniqueID = (string) $uniqueID;
521 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Unique-ID gesetzt auf <u>%s</u>.<br />\n",
527 $this->uniqueID = $uniqueID;
531 * Getter for unique ID
533 * @return $uniqueID The unique ID of this class
535 public final function getUniqueID () {
536 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Unique-ID angefordert.<br />\n",
539 return $this->uniqueID;
543 * Resets or recreates the unique ID number
547 public final function resetUniqueID() {
548 // Sweet and simple... ;-)
549 $newUniqueID = $this->generateIdNumber();
550 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Unique-ID zurückgesetzt auf <u>%s</u>.<br />\n",
554 $this->setUniqueID($newUniqueID);
558 * Getter for simulator description
560 * @return $objectDescription The description of this simulation part
562 public final function getObjectDescription () {
563 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] getObjectDescription erreicht.<br />\n",
566 if (isset($this->objectDescription)) {
567 return $this->objectDescription;
574 * Setter for simulation part description
576 * @param $objectDescription The description as string for this simulation part
579 public final function setObjectDescription ($objectDescription) {
580 $this->objectDescription = (String) $objectDescription;
581 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] Teilbeschreibung wird auf <strong>%s</strong> gesetzt.<br />\n",
583 $this->objectDescription
588 * Validate if given object is the same as current
590 * @param $object An object instance for comparison with this class
591 * @return boolean The result of comparing both's unique ID
593 public final function equals ($object) {
594 return ($this->getUniqueID() == $object->getUniqueID());
598 * Compare if both simulation part description and class name matches
601 * @param $itemInstance An object instance to an other class
602 * @return boolean The result of comparing class name simulation part description
604 public function itemMatches ($itemInstance) {
607 $this->__toString() == $itemInstance->__toString()
609 $this->getObjectDescription() == $itemInstance->getObjectDescription()
615 * Compare class name of this and given class name
617 * @param $class The class name as string from the other class
618 * @return boolean The result of comparing both class names
620 public final function isClass ($class) {
621 if ((defined('DEBUG_SYSTEM')) && (is_object($this->getDebugInstance()))) $this->getDebugInstance()->output(sprintf("[%s:] <strong>%s</strong>=<strong>%s</strong>?<br />\n",
626 return ($this->__toString() == $class);
630 * Stub method (only real cabins shall override it)
632 * @return boolean false = is no cabin, true = is a cabin
634 public function isCabin () {
639 * Stub method for tradeable objects
641 * @return boolean false = is not tradeable by the Merchant class,
642 * true = is a tradeable object
644 public function isTradeable () {
649 * Formats computer generated price values into human-understandable formats
650 * with thousand and decimal seperators.
652 * @param $value The in computer format value for a price
653 * @param $currency The currency symbol (use HTML-valid characters!)
654 * @param $decNum Number of decimals after commata
655 * @return $price The for the current language formated price string
656 * @throws MissingDecimalsThousandsSeperatorException If decimals or
657 * thousands seperator
660 public function formatCurrency ($value, $currency = "€", $decNum = 2) {
661 // Are all required attriutes set?
662 if ((!isset($this->decimals)) || (!isset($this->thousands))) {
663 // Throw an exception
664 throw new MissingDecimalsThousandsSeperatorException($this, self::EXCEPTION_ATTRIBUTES_ARE_MISSING);
668 $value = (float) $value;
669 if (defined('DEBUG_CORE') && is_object($this->getDebugInstance())) $this->getDebugInstance()->output(sprintf("[%s:] <strong>%d</strong> wird umformatiert.<br />\n",
674 // Reformat the US number
675 $price = sprintf("%s %s",
676 number_format($value, $decNum, $this->decimals, $this->thousands),
680 // Return as string...
685 * Removes number formating characters
689 public final function removeNumberFormaters () {
690 if (defined('DEBUG_CORE') && is_object($this->getDebugInstance())) $this->getDebugInstance()->output(sprintf("[%s:] Zahlenumformatierungszeichen werden entfernt.<br />\n",
693 unset($this->thousands);
694 unset($this->decimals);
698 * Getter for database layer
700 * @return $dbInstance The database layer instance
702 public final function getDatabaseInstance () {
703 if (defined('DEBUG_CORE') && is_object($this->getDebugInstance())) $this->getDebugInstance()->output(sprintf("[%s:] Datenbank-Instanz <u>%s</u> angefordert.<br />\n",
707 return $this->dbInstance;
711 * Setter for compressor channel
713 * @param $compressorChannel An instance of CompressorChannel
716 public final function setCompressorChannel (CompressorChannel $compressorChannel) {
717 self::$compressor = $compressorChannel;
721 * Getter for compressor channel
723 * @return $compressor The compressor channel
725 public final function getCompressorChannel () {
726 return self::$compressor;
730 * Remove the $systemClasses array from memory
734 public final function removeSystemArray () {
735 unset($this->systemClasses);
739 * Create a file name and path name from the object's unique ID number.
740 * The left part of the ID shall always be a valid class name and the
741 * right part an ID number.
743 * @return $pfn The file name with a prepended path name
744 * @throws NoArrayCreatedException If explode() fails to create an array
745 * @throws InvalidArrayCountException If the array contains less or
746 * more than two elements
748 public final function getPathFileNameFromObject () {
749 // Get the main object's unique ID. We use this as a path/filename combination
750 $pathFile = $this->getUniqueID();
752 // Split it up in path and file name
753 $pathFile = explode("@", $pathFile);
755 // Are there two elements? Index 0 is the path, 1 the file name + global extension
756 if (!is_array($pathFile)) {
758 throw new NoArrayCreatedException(array($this, "pathFile"), self::EXCEPTION_ARRAY_EXPECTED);
759 } elseif (count($pathFile) != 2) {
760 // Invalid ID returned!
761 throw new InvalidArrayCountException(array($this, "pathFile", count($pathFile), 2), self::EXCEPTION_ARRAY_HAS_INVALID_COUNT);
764 // Auto-append missing trailing slash
765 $pathFile[0] = $this->addMissingTrailingSlash($pathFile[0]);
767 // Create the file name and return it
768 $pfn = ($pathFile[0] . $pathFile[1]);
773 * Appends a trailing slash to a string
775 * @param $str A string (maybe) without trailing slash
776 * @return $str A string with an auto-appended trailing slash
778 public final function addMissingTrailingSlash ($str) {
779 // Is there a trailing slash?
780 if (substr($str, -1, 1) != "/") $str .= "/";
785 * Private getter for language instance
787 * @return $langInstance An instance to the language sub-system
789 protected final function getLanguageInstance () {
790 return $this->langInstance;
794 * Setter for language instance
796 * @param $langInstance An instance to the language sub-system
798 * @see LanguageSystem
800 public final function setLanguageInstance (ManageableLanguage $langInstance) {
801 $this->langInstance = $langInstance;
805 * Private getter for file IO instance
807 * @return $fileIOInstance An instance to the file I/O sub-system
809 protected final function getFileIOInstance () {
810 return $this->fileIOInstance;
814 * Setter for file I/O instance
816 * @param $fileIOInstance An instance to the file I/O sub-system
819 public final function setFileIOInstance (FileIOHandler $fileIOInstance) {
820 $this->fileIOInstance = $fileIOInstance;
824 * Protected getter for a manageable application helper class
826 * @return $applicationInstance An instance of a manageable application helper class
828 protected final function getApplicationInstance () {
829 return $this->applicationInstance;
833 * Setter for a manageable application helper class
835 * @param $applicationInstance An instance of a manageable application helper class
838 public final function setApplicationInstance (ManageableApplication $applicationInstance) {
839 $this->applicationInstance = $applicationInstance;
843 * Prepare the template engine (TemplateEngine by default) for a given
844 * application helper instance (ApplicationHelper by default).
846 * @param $appInstance An application helper instance or
847 * null if we shall use the default
848 * @return $tplEngine The template engine instance
849 * @throws NullPointerException If the template engine could not
851 * @throws UnsupportedTemplateEngineException If $tplEngine is an
852 * unsupported template engine
853 * @throws MissingLanguageHandlerException If the language sub-system
854 * is not yet initialized
855 * @throws NullPointerException If the discovered application
856 * instance is still null
858 protected function prepareTemplateEngine (BaseFrameworkSystem $appInstance=null) {
859 // Is the application instance set?
860 if (is_null($appInstance)) {
861 // Get the current instance
862 $appInstance = $this->getApplicationInstance();
865 if (is_null($appInstance)) {
866 // Thrown an exception
867 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
871 // Generate FQFN for all application templates
872 $fqfn = sprintf("%s%s/%s/%s",
874 $this->getConfigInstance()->readConfig("application_path"),
875 strtolower($appInstance->getAppShortName()),
876 $this->getConfigInstance()->readConfig("tpl_base_path")
879 // Are both instances set?
880 if ($appInstance->getLanguageInstance() === null) {
881 // Invalid language instance
882 throw new MissingLanguageHandlerException($appInstance, self::EXCEPTION_MISSING_LANGUAGE_HANDLER);
883 } elseif ($appInstance->getFileIOInstance() === null) {
884 // Invalid language instance
885 throw new MissingFileIoHandlerException($appInstance, self::EXCEPTION_MISSING_FILE_IO_HANDLER);
888 // Initialize the template engine
890 $eval = sprintf("\$tplEngine = %s::create%s(
892 \$appInstance->getLanguageInstance(),
893 \$appInstance->getFileIOInstance()
895 $this->getConfigInstance()->readConfig("tpl_engine"),
896 $this->getConfigInstance()->readConfig("tpl_engine"),
901 if ((!is_null($this->getDebugInstance())) && (defined('DEBUG_EVAL'))) {
902 $this->getDebugInstance()->output(sprintf("[%s:] Konstruierte PHP-Anweisung: <pre><em>%s</em></pre><br />\n",
911 // Is it a valid instance?
912 if (is_null($tplEngine)) {
914 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
915 } elseif (!$tplEngine instanceof CompileableTemplate) {
916 // Not an object! ;-(
917 throw new UnsupportedTemplateEngineException($tplEngine, self::EXCEPTION_TEMPLATE_ENGINE_UNSUPPORTED);
920 // Return the prepared instance
925 * Debugs this instance by putting out it's full content
929 public final function debugInstance () {
930 // Generate the output
931 $content = "<pre>".trim(print_r($this, true))."</pre>";
934 ApplicationEntryPoint::app_die("<strong>Debug output:</strong>".$content);