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 * Instance to an application helper class
29 private static $applicationInstance = null;
32 * The language instance for the template loader
34 private static $langInstance = null;
39 private static $debugInstance = null;
42 * Instance of a request class
44 private $requestInstance = null;
47 * Instance of a response class
49 private $responseInstance = null;
52 * Search criteria instance
54 private $searchInstance = null;
57 * The file I/O instance for the template loader
59 private $fileIoInstance = null;
64 private $resolverInstance = null;
67 * Template engine instance
69 private $templateInstance = null;
74 private $realClass = "FrameworkSystem";
77 * A human-readable description for this simulator part
79 private $objectDescription = "Namenlose Framework-Einheit";
82 * The unique ID string for identifying all type of classes
84 private $uniqueID = "";
89 private $thousands = "."; // German
94 private $decimals = ","; // German
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_HEADERS_ALREADY_SENT = 0x031;
149 const EXCEPTION_DEFAULT_CONTROLLER_GONE = 0x032;
150 const EXCEPTION_CLASS_NOT_FOUND = 0x033;
151 const EXCEPTION_REQUIRED_INTERFACE_MISSING = 0x034;
152 const EXCEPTION_FATAL_ERROR = 0x035;
153 const EXCEPTION_FILE_NOT_FOUND = 0x036;
154 const EXCEPTION_ASSERTION_FAILED = 0x037;
155 const EXCEPTION_FILE_CANNOT_BE_READ = 0x038;
158 * In the super constructor these system classes shall be ignored or else
159 * we would get an endless calling loop.
161 *--------------------------------------------------------------------*
162 * ATTENTION: IF YOU REMOVE ONE OF THEM YOU WILL SHOOT YOUR SERVER!!! *
163 *--------------------------------------------------------------------*
165 private $systemClasses = array(
166 "DebugMiddleware", // Debug middleware output sub-system
167 "Registry", // Object registry
168 "ObjectFactory", // Object factory
169 "DebugWebOutput", // Debug web output sub-system
170 "WebOutput", // Web output sub-system
171 "CompressorChannel", // Compressor sub-system
172 "DebugConsoleOutput", // Debug console output sub-system
173 "DebugErrorLogOutput", // Debug error_log() output sub-system
174 "FrameworkDirectoryPointer", // Directory handler sub-system
175 "NullCompressor", // Null compressor
176 "Bzip2Compressor", // BZIP2 compressor
177 "GzipCompressor", // GZIP compressor
184 * Private super constructor
186 * @param $className Name of the class
189 protected function __construct ($className) {
191 $this->setRealClass($className);
193 // Initialize the class if the registry is there
194 if ((class_exists('Registry')) && (Registry::isInitialized() === false)) {
195 $this->initInstance();
200 * Destructor reached...
204 public function __destruct() {
205 // Is this object already destroyed?
206 if ($this->__toString() != "DestructedObject") {
208 if ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
209 $this->getDebugInstance()->output(sprintf("[%s:] Das Objekt <strong>%s</strong> wird zerstört.",
210 __CLASS__, $this->__toString()
214 // Destroy all informations about this class but keep some text about it alive
215 $this->setObjectDescription(sprintf("Entferntes Objekt <em>%s</em>", $this->__toString()));
216 $this->setRealClass("DestructedObject");
217 $this->resetUniqueID();
218 } elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
219 // Already destructed object
220 $this->getDebugInstance()->output(sprintf("[%s:] Das Objekt <strong>%s</strong> wurde bereits zerstört.",
221 __CLASS__, $this->__toString()
227 * The call method where all non-implemented methods end up
231 public final function __call ($methodName, $args) {
232 // Implode all given arguments
236 $argsString = "NULL";
237 } elseif (is_array($args)) {
238 // Some arguments are there
239 foreach ($args as $arg) {
243 if ($arg) $argsString .= "true(bool)"; else $argsString .= "false(bool)";
244 } elseif (is_int($arg)) {
246 $argsString .= $arg."(int)";
247 } elseif (is_float($arg)) {
249 $argsString .= $arg."(float)";
250 } elseif ($arg instanceof BaseFrameworkSystem) {
251 // Own object instance
252 $argsString .= $arg->__toString()."(Object)";
253 } elseif (is_object($arg)) {
255 $argsString .= "unknown object(!)";
256 } elseif (is_array($arg)) {
258 $argsString .= "Array(array)";
259 } elseif (is_string($arg)) {
261 $argsString .= "\"".$arg."\"(string)";
262 } elseif (is_null($arg)) {
264 $argsString .= "(null)";
265 } elseif (is_resource($arg)) {
267 $argsString .= "(resource)";
269 // Unknown type (please report!)
270 $argsString .= $arg."(<em>unknown!</em>)";
278 if (substr($argsString, -2, 1) === ",") {
279 $argsString = substr($argsString, 0, -2);
282 // Invalid arguments!
283 $argsString = sprintf("!INVALID:%s!", $args);
286 // Output stub message
287 $this->getDebugInstance()->output(sprintf("[%s->%s] Stub! Args: %s",
298 * Private initializer for this class
302 private final function initInstance () {
303 // Is this a system class?
304 if (!in_array($this->__toString(), $this->systemClasses)) {
305 // Add application helper to our class
306 $this->systemclasses[] = $this->getConfigInstance()->readConfig('app_helper_class');
308 // Set debug instance
309 $this->setDebugInstance(DebugMiddleware::createDebugMiddleware($this->getConfigInstance()->readConfig('debug_class')));
311 // Get output instance and set it
312 $outputInstance = ObjectFactory::createObjectByConfiguredName('web_engine', array($this->getConfigInstance()->readConfig('web_content_type')));
313 $this->setWebOutputInstance($outputInstance);
315 // Set the compressor channel
316 $this->setCompressorChannel(CompressorChannel::createCompressorChannel(sprintf("%s%s",
318 $this->getConfigInstance()->readConfig('compressor_base_path')
321 // Initialization done! :D
322 Registry::isInitialized("OK");
323 } elseif ($this->__toString() == "DebugMiddleware") {
324 // Set configuration instance
325 $this->setConfigInstance(FrameworkConfiguration::createFrameworkConfiguration());
330 * Setter for template engine instances
332 * @param $templateInstance An instance of a template engine class
335 protected final function setTemplateInstance (CompileableTemplate $templateInstance) {
336 $this->templateInstance = $templateInstance;
340 * Getter for template engine instances
342 * @return $templateInstance An instance of a template engine class
344 protected final function getTemplateInstance () {
345 return $this->templateInstance;
349 * Setter for search instance
351 * @param $searchInstance Searchable criteria instance
354 public final function setSearchInstance (LocalSearchCriteria $searchInstance) {
355 $this->searchInstance = $searchInstance;
359 * Getter for search instance
361 * @return $searchInstance Searchable criteria instance
363 public final function getSearchInstance () {
364 return $this->searchInstance;
368 * Setter for resolver instance
370 * @param $resolverInstance Instance of a command resolver class
373 public final function setResolverInstance (Resolver $resolverInstance) {
374 $this->resolverInstance = $resolverInstance;
378 * Getter for resolver instance
380 * @return $resolverInstance Instance of a command resolver class
382 public final function getResolverInstance () {
383 return $this->resolverInstance;
387 * Setter for language instance
389 * @param $configInstance The configuration instance which shall
390 * be FrameworkConfiguration
393 public final function setConfigInstance (FrameworkConfiguration $configInstance) {
394 Registry::getRegistry()->addInstance('config', $configInstance);
398 * Getter for configuration instance
400 * @return $cfgInstance Configuration instance
402 public final function getConfigInstance () {
403 $cfgInstance = Registry::getRegistry()->getInstance('config');
408 * Setter for debug instance
410 * @param $debugInstance The instance for debug output class
413 public final function setDebugInstance (DebugMiddleware $debugInstance) {
414 self::$debugInstance = $debugInstance;
418 * Getter for debug instance
420 * @return $debugInstance Instance to class DebugConsoleOutput or DebugWebOutput
422 public final function getDebugInstance () {
423 return self::$debugInstance;
427 * Setter for web output instance
429 * @param $webInstance The instance for web output class
432 public final function setWebOutputInstance (OutputStreamer $webInstance) {
433 Registry::getRegistry()->addInstance('web_output', $webInstance);
437 * Getter for web output instance
439 * @return $webOutput - Instance to class WebOutput
441 public final function getWebOutputInstance () {
442 return Registry::getRegistry()->getInstance('web_output');
446 * Setter for database instance
448 * @param $dbInstance The instance for the database connection
449 * (forced DatabaseConnection)
452 public final function setDatabaseInstance (DatabaseConnection $dbInstance) {
453 Registry::getRegistry()->addInstance('dbInstance', $dbInstance);
457 * Getter for database layer
459 * @return $dbInstance The database layer instance
461 public final function getDatabaseInstance () {
462 if ((class_exists('Registry')) && (Registry::isInitialized() === true)) {
463 return Registry::getRegistry()->getInstance('dbInstance');
470 * Setter for compressor channel
472 * @param $compressorChannel An instance of CompressorChannel
475 public final function setCompressorChannel (CompressorChannel $compressorChannel) {
476 Registry::getRegistry()->addInstance('compressor', $compressorChannel);
480 * Getter for compressor channel
482 * @return $compressor The compressor channel
484 public final function getCompressorChannel () {
485 return Registry::getRegistry()->getInstance('compressor');
489 * Protected getter for a manageable application helper class
491 * @return $applicationInstance An instance of a manageable application helper class
493 protected final function getApplicationInstance () {
494 return self::$applicationInstance;
498 * Setter for a manageable application helper class
500 * @param $applicationInstance An instance of a manageable application helper class
503 public final function setApplicationInstance (ManageableApplication $applicationInstance) {
504 self::$applicationInstance = $applicationInstance;
508 * Setter for request instance
510 * @param $requestInstance An instance of a Requestable class
513 public final function setRequestInstance (Requestable $requestInstance) {
514 $this->requestInstance = $requestInstance;
518 * Getter for request instance
520 * @return $requestInstance An instance of a Requestable class
522 public final function getRequestInstance () {
523 return $this->requestInstance;
527 * Setter for response instance
529 * @param $responseInstance An instance of a Responseable class
532 public final function setResponseInstance (Responseable $responseInstance) {
533 $this->responseInstance = $responseInstance;
537 * Getter for response instance
539 * @return $responseInstance An instance of a Responseable class
541 public final function getResponseInstance () {
542 return $this->responseInstance;
546 * Getter for $realClass
548 * @return $realClass The name of the real class (not BaseFrameworkSystem)
550 public final function __toString () {
551 return $this->realClass;
555 * Setter for the real class name
557 * @param $realClass Class name (string)
560 public final function setRealClass ($realClass) {
562 $realClass = (string) $realClass;
565 $this->realClass = $realClass;
569 * Generate unique ID from a lot entropy
573 public final function generateUniqueId () {
574 // Is the id set for this class?
575 if (empty($this->uniqueID)) {
577 // Correct missing class name
579 if ($this->__toString() == "") {
580 $this->setRealClass(__CLASS__);
584 // Cache datbase instance
585 $db = $this->getDatabaseInstance();
590 // Generate a unique ID number
591 $tempID = $this->generateIdNumber();
594 // Try to figure out if the ID number is not yet used
596 // Is this a registry?
597 if ($this->__toString() == "Registry") {
598 // Registry, then abort here
600 } elseif (is_object($db)) {
601 $isUsed = $db->isUniqueIdUsed($tempID, true);
603 } catch (FrameworkException $e) {
604 // Catches all and ignores all ;-)
628 $this->setUniqueID($tempID);
630 // Revert maybe corrected class name
632 $this->setRealClass("");
635 // Remove system classes if we are in a system class
636 if ((isset($this->systemClasses)) && (in_array($this->__toString(), $this->systemClasses))) {
637 // This may save some RAM...
638 $this->removeSystemArray();
644 * Generates a new ID number for classes based from the class' real name,
645 * the description and some random data
647 * @return $tempID The new (temporary) ID number
649 private final function generateIdNumber () {
650 return sprintf("%s@%s",
652 md5(sprintf("%s:%s:%s:%s:%s:%s",
654 $this->getObjectDescription(),
656 getenv('REMOTE_ADDR'),
657 getenv('SERVER_ADDR'),
664 * Setter for unique ID
666 * @param $uniqueID The newly generated unique ID number
669 private final function setUniqueID ($uniqueID) {
671 $uniqueID = (string) $uniqueID;
674 $this->uniqueID = $uniqueID;
678 * Getter for unique ID
680 * @return $uniqueID The unique ID of this class
682 public final function getUniqueID () {
683 return $this->uniqueID;
687 * Resets or recreates the unique ID number
691 public final function resetUniqueID() {
692 // Sweet and simple... ;-)
693 $newUniqueID = $this->generateIdNumber();
694 $this->setUniqueID($newUniqueID);
698 * Getter for simulator description
700 * @return $objectDescription The description of this simulation part
702 public final function getObjectDescription () {
703 if (isset($this->objectDescription)) {
704 return $this->objectDescription;
711 * Setter for simulation part description
713 * @param $objectDescription The description as string for this simulation part
716 public final function setObjectDescription ($objectDescription) {
717 $this->objectDescription = (String) $objectDescription;
721 * Validate if given object is the same as current
723 * @param $object An object instance for comparison with this class
724 * @return boolean The result of comparing both's unique ID
726 public final function equals (FrameworkInterface $object) {
727 return ($this->getUniqueID() == $object->getUniqueID());
731 * Compare if both simulation part description and class name matches
734 * @param $itemInstance An object instance to an other class
735 * @return boolean The result of comparing class name simulation part description
737 public function itemMatches ($itemInstance) {
740 $this->__toString() == $itemInstance->__toString()
742 $this->getObjectDescription() == $itemInstance->getObjectDescription()
748 * Compare class name of this and given class name
750 * @param $className The class name as string from the other class
751 * @return boolean The result of comparing both class names
753 public final function isClass ($className) {
754 return ($this->__toString() == $className);
758 * Stub method (only real cabins shall override it)
760 * @return boolean false = is no cabin, true = is a cabin
762 public function isCabin () {
767 * Stub method for tradeable objects
769 * @return boolean false = is not tradeable by the Merchant class,
770 * true = is a tradeable object
772 public function isTradeable () {
777 * Formats computer generated price values into human-understandable formats
778 * with thousand and decimal seperators.
780 * @param $value The in computer format value for a price
781 * @param $currency The currency symbol (use HTML-valid characters!)
782 * @param $decNum Number of decimals after commata
783 * @return $price The for the current language formated price string
784 * @throws MissingDecimalsThousandsSeperatorException If decimals or
785 * thousands seperator
788 public function formatCurrency ($value, $currency = "€", $decNum = 2) {
789 // Are all required attriutes set?
790 if ((!isset($this->decimals)) || (!isset($this->thousands))) {
791 // Throw an exception
792 throw new MissingDecimalsThousandsSeperatorException($this, self::EXCEPTION_ATTRIBUTES_ARE_MISSING);
796 $value = (float) $value;
798 // Reformat the US number
799 $price = sprintf("%s %s",
800 number_format($value, $decNum, $this->decimals, $this->thousands),
804 // Return as string...
809 * Removes number formating characters
813 public final function removeNumberFormaters () {
814 unset($this->thousands);
815 unset($this->decimals);
819 * Private getter for language instance
821 * @return $langInstance An instance to the language sub-system
823 protected final function getLanguageInstance () {
824 return self::$langInstance;
828 * Setter for language instance
830 * @param $langInstance An instance to the language sub-system
832 * @see LanguageSystem
834 public final function setLanguageInstance (ManageableLanguage $langInstance) {
835 self::$langInstance = $langInstance;
839 * Remove the $systemClasses array from memory
843 public final function removeSystemArray () {
844 unset($this->systemClasses);
848 * Create a file name and path name from the object's unique ID number.
849 * The left part of the ID shall always be a valid class name and the
850 * right part an ID number.
852 * @return $pfn The file name with a prepended path name
853 * @throws NoArrayCreatedException If explode() fails to create an array
854 * @throws InvalidArrayCountException If the array contains less or
855 * more than two elements
857 public final function getPathFileNameFromObject () {
858 // Get the main object's unique ID. We use this as a path/filename combination
859 $pathFile = $this->getUniqueID();
861 // Split it up in path and file name
862 $pathFile = explode("@", $pathFile);
864 // Are there two elements? Index 0 is the path, 1 the file name + global extension
865 if (!is_array($pathFile)) {
867 throw new NoArrayCreatedException(array($this, "pathFile"), self::EXCEPTION_ARRAY_EXPECTED);
868 } elseif (count($pathFile) != 2) {
869 // Invalid ID returned!
870 throw new InvalidArrayCountException(array($this, "pathFile", count($pathFile), 2), self::EXCEPTION_ARRAY_HAS_INVALID_COUNT);
873 // Auto-append missing trailing slash
874 $pathFile[0] = $this->addMissingTrailingSlash($pathFile[0]);
876 // Create the file name and return it
877 $pfn = ($pathFile[0] . $pathFile[1]);
882 * Appends a trailing slash to a string
884 * @param $str A string (maybe) without trailing slash
885 * @return $str A string with an auto-appended trailing slash
887 public final function addMissingTrailingSlash ($str) {
888 // Is there a trailing slash?
889 if (substr($str, -1, 1) != "/") $str .= "/";
894 * Private getter for file IO instance
896 * @return $fileIoInstance An instance to the file I/O sub-system
898 protected final function getFileIoInstance () {
899 return $this->fileIoInstance;
903 * Setter for file I/O instance
905 * @param $fileIoInstance An instance to the file I/O sub-system
908 public final function setFileIoInstance (FileIoHandler $fileIoInstance) {
909 $this->fileIoInstance = $fileIoInstance;
913 * Prepare the template engine (WebTemplateEngine by default) for a given
914 * application helper instance (ApplicationHelper by default).
916 * @param $appInstance An application helper instance or
917 * null if we shall use the default
918 * @return $tplEngine The template engine instance
919 * @throws NullPointerException If the template engine could not
921 * @throws UnsupportedTemplateEngineException If $tplEngine is an
922 * unsupported template engine
923 * @throws MissingLanguageHandlerException If the language sub-system
924 * is not yet initialized
925 * @throws NullPointerException If the discovered application
926 * instance is still null
928 protected function prepareTemplateEngine (BaseFrameworkSystem $appInstance=null) {
929 // Is the application instance set?
930 if (is_null($appInstance)) {
931 // Get the current instance
932 $appInstance = $this->getApplicationInstance();
935 if (is_null($appInstance)) {
936 // Thrown an exception
937 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
941 // Generate FQFN for all application templates
942 $fqfn = sprintf("%s%s/%s/%s",
944 $this->getConfigInstance()->readConfig('application_path'),
945 strtolower($appInstance->getAppShortName()),
946 $this->getConfigInstance()->readConfig('tpl_base_path')
949 // Are both instances set?
950 if ($appInstance->getLanguageInstance() === null) {
951 // Invalid language instance
952 throw new MissingLanguageHandlerException($appInstance, self::EXCEPTION_MISSING_LANGUAGE_HANDLER);
953 } elseif ($appInstance->getFileIoInstance() === null) {
954 // Invalid language instance
955 throw new MissingFileIoHandlerException($appInstance, self::EXCEPTION_MISSING_FILE_IO_HANDLER);
958 // Initialize the template engine
959 $tplEngine = ObjectFactory::createObjectByConfiguredName('template_class', array($fqfn, $appInstance->getLanguageInstance(), $appInstance->getFileIoInstance()));
961 // Return the prepared instance
966 * Debugs this instance by putting out it's full content
970 public final function debugInstance () {
971 // Generate the output
972 $content = sprintf("<pre>%s</pre>",
973 trim(print_r($this, true))
977 ApplicationEntryPoint::app_die(sprintf("<strong>%s debug output:</strong><div id=\"debug_content\">%s</div>Loaded includes: <div id=\"debug_include_list\">%s</div>",
980 ClassLoader::getInstance()->getPrintableIncludeList()
985 * Output a partial stub message for the caller method
987 * @param $message An optional message to display
990 protected function partialStub ($message = "") {
992 $backtrace = debug_backtrace();
994 // Generate the class::method string
995 $methodName = "UnknownClass->unknownMethod";
996 if ((isset($backtrace[1]['class'])) && (isset($backtrace[1]['function']))) {
997 $methodName = $backtrace[1]['class']."->".$backtrace[1]['function'];
1000 // Construct the full message
1001 $stubMessage = sprintf("[%s:] Partial stub!",
1005 // Is the extra message given?
1006 if (!empty($message)) {
1007 // Then add it as well
1008 $stubMessage .= sprintf(" Message: <span id=\"stub_message\">%s</span>", $message);
1011 // Debug instance is there?
1012 if (!is_null($this->getDebugInstance())) {
1013 // Output stub message
1014 $this->getDebugInstance()->output($stubMessage);
1017 trigger_error($stubMessage."<br />\n");
1022 * Outputs a debug backtrace and stops further script execution
1026 public function debugBackTrace () {
1027 // Sorry, there is no other way getting this nice backtrace
1029 debug_print_backtrace();
1035 * Outputs a debug message wether to debug instance (should be set!) or dies with or pints the message
1037 * @param $message Message we shall send out...
1038 * @param $doPrint Wether we shall print or die here which last is the default
1041 public function debugOutput ($message, $doPrint = false) {
1042 // Get debug instance
1043 $debugInstance = $this->getDebugInstance();
1045 // Is the debug instance there?
1046 if (is_object($debugInstance)) {
1047 // Use debug output handler
1048 $debugInstance->output($message);
1049 if (!$doPrint) die(); // Die here if not printed
1052 // DO NOT REWRITE THIS TO app_die() !!!
1062 * Converts e.g. a command from URL to a valid class by keeping out bad characters
1064 * @param $str The string, what ever it is needs to be converted
1065 * @return $className Generated class name
1067 public function convertToClassName ($str) {
1071 // Convert all dashes in underscores
1072 $str = str_replace("-", "_", $str);
1074 // Now use that underscores to get classname parts for hungarian style
1075 foreach (explode("_", $str) as $strPart) {
1076 // Make the class name part lower case and first upper case
1077 $className .= ucfirst(strtolower($strPart));
1080 // Return class name
1085 * Marks up the code by adding e.g. line numbers
1087 * @param $phpCode Unmarked PHP code
1088 * @return $markedCode Marked PHP code
1090 public function markupCode ($phpCode) {
1092 $errorArray = error_get_last();
1094 // Init the code with error message
1096 if (is_array($errorArray)) {
1098 $markedCode = sprintf("<div id=\"error_header\">File: <span id=\"error_data\">%s</span>, Line: <span id=\"error_data\">%s</span>, Message: <span id=\"error_data\">%s</span>, Type: <span id=\"error_data\">%s</span></div>",
1099 basename($errorArray['file']),
1100 $errorArray['line'],
1101 $errorArray['message'],
1106 // Add line number to the code
1107 foreach (explode("\n", $phpCode) as $lineNo=>$code) {
1109 $markedCode .= sprintf("<span id=\"code_line\">%s</span>: %s\n",
1111 htmlentities($code, ENT_QUOTES)