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;
69 private $realClass = "FrameworkSystem";
72 * A human-readable description for this simulator part
74 private $objectDescription = "Namenlose Framework-Einheit";
77 * The unique ID string for identifying all type of classes
79 private $uniqueID = "";
84 private $thousands = "."; // German
89 private $decimals = ","; // German
91 /***********************
92 * Exception codes.... *
93 ***********************/
95 const EXCEPTION_IS_NULL_POINTER = 0x001;
96 const EXCEPTION_IS_NO_OBJECT = 0x002;
97 const EXCEPTION_IS_NO_ARRAY = 0x003;
98 const EXCEPTION_MISSING_METHOD = 0x004;
99 const EXCEPTION_CLASSES_NOT_MATCHING = 0x005;
100 const EXCEPTION_INDEX_OUT_OF_BOUNDS = 0x006;
101 const EXCEPTION_DIMENSION_ARRAY_INVALID = 0x007;
102 const EXCEPTION_ITEM_NOT_TRADEABLE = 0x008;
103 const EXCEPTION_ITEM_NOT_IN_PRICE_LIST = 0x009;
104 const EXCEPTION_GENDER_IS_WRONG = 0x00a;
105 const EXCEPTION_BIRTH_DATE_IS_INVALID = 0x00b;
106 const EXCEPTION_EMPTY_STRUCTURES_ARRAY = 0x00c;
107 const EXCEPTION_HAS_ALREADY_PERSONELL_LIST = 0x00d;
108 const EXCEPTION_NOT_ENOUGTH_UNEMPLOYEES = 0x00e;
109 const EXCEPTION_TOTAL_PRICE_NOT_CALCULATED = 0x00f;
110 const EXCEPTION_HARBOR_HAS_NO_SHIPYARDS = 0x010;
111 const EXCEPTION_CONTRACT_PARTNER_INVALID = 0x011;
112 const EXCEPTION_CONTRACT_PARTNER_MISMATCH = 0x012;
113 const EXCEPTION_CONTRACT_ALREADY_SIGNED = 0x013;
114 const EXCEPTION_UNEXPECTED_EMPTY_STRING = 0x014;
115 const EXCEPTION_PATH_NOT_FOUND = 0x015;
116 const EXCEPTION_INVALID_PATH_NAME = 0x016;
117 const EXCEPTION_READ_PROTECED_PATH = 0x017;
118 const EXCEPTION_WRITE_PROTECED_PATH = 0x018;
119 const EXCEPTION_DIR_POINTER_INVALID = 0x019;
120 const EXCEPTION_FILE_POINTER_INVALID = 0x01a;
121 const EXCEPTION_INVALID_DIRECTORY_POINTER = 0x01b;
122 const EXCEPTION_UNEXPECTED_OBJECT = 0x01c;
123 const EXCEPTION_LIMIT_ELEMENT_IS_UNSUPPORTED = 0x01d;
124 const EXCEPTION_GETTER_IS_MISSING = 0x01e;
125 const EXCEPTION_ARRAY_EXPECTED = 0x01f;
126 const EXCEPTION_ARRAY_HAS_INVALID_COUNT = 0x020;
127 const EXCEPTION_ID_IS_INVALID_FORMAT = 0x021;
128 const EXCEPTION_MD5_CHECKSUMS_MISMATCH = 0x022;
129 const EXCEPTION_UNEXPECTED_STRING_SIZE = 0x023;
130 const EXCEPTION_SIMULATOR_ID_INVALID = 0x024;
131 const EXCEPTION_MISMATCHING_COMPRESSORS = 0x025;
132 const EXCEPTION_CONTAINER_ITEM_IS_NULL = 0x026;
133 const EXCEPTION_ITEM_IS_NO_ARRAY = 0x027;
134 const EXCEPTION_CONTAINER_MAYBE_DAMAGED = 0x028;
135 const EXCEPTION_INVALID_STRING = 0x029;
136 const EXCEPTION_VARIABLE_NOT_SET = 0x02a;
137 const EXCEPTION_ATTRIBUTES_ARE_MISSING = 0x02b;
138 const EXCEPTION_ARRAY_ELEMENTS_MISSING = 0x02c;
139 const EXCEPTION_TEMPLATE_ENGINE_UNSUPPORTED = 0x02d;
140 const EXCEPTION_MISSING_LANGUAGE_HANDLER = 0x02e;
141 const EXCEPTION_MISSING_FILE_IO_HANDLER = 0x02f;
142 const EXCEPTION_MISSING_ELEMENT = 0x030;
143 const EXCEPTION_HEADERS_ALREADY_SENT = 0x031;
144 const EXCEPTION_DEFAUL_CONTROLLER_GONE = 0x032;
145 const EXCEPTION_CLASS_NOT_FOUND = 0x033;
146 const EXCEPTION_REQUIRED_INTERFACE_MISSING = 0x034;
147 const EXCEPTION_FATAL_ERROR = 0x035;
148 const EXCEPTION_FILE_NOT_FOUND = 0x036;
151 * In the super constructor these system classes shall be ignored or else
152 * we would get an endless calling loop.
154 *--------------------------------------------------------------------*
155 * ATTENTION: IF YOU REMOVE ONE OF THEM YOU WILL SHOOT YOUR SERVER!!! *
156 *--------------------------------------------------------------------*
158 private $systemClasses = array(
159 "DebugMiddleware", // Debug middleware output sub-system
160 "Registry", // Object registry
161 "ObjectFactory", // Object factory
162 "DebugWebOutput", // Debug web output sub-system
163 "WebOutput", // Web output sub-system
164 "CompressorChannel", // Compressor sub-system
165 "DebugConsoleOutput", // Debug console output sub-system
166 "DebugErrorLogOutput", // Debug error_log() output sub-system
167 "FrameworkDirectoryPointer", // Directory handler sub-system
168 "NullCompressor", // Null compressor
169 "Bzip2Compressor", // BZIP2 compressor
170 "GzipCompressor", // GZIP compressor
177 * Private super constructor
181 protected function __construct ($class) {
183 $this->setRealClass($class);
185 // Initialize the class if the registry is there
186 if ((class_exists('Registry')) && (Registry::isInitialized() === false)) {
187 $this->initInstance();
192 * Destructor reached...
196 public function __destruct() {
197 // Is this object already destroyed?
198 if ($this->__toString() != "DestructedObject") {
200 if ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
201 $this->getDebugInstance()->output(sprintf("[%s:] Das Objekt <strong>%s</strong> wird zerstört.<br />\n",
202 __CLASS__, $this->__toString()
206 // Destroy all informations about this class but keep some text about it alive
207 $this->setObjectDescription(sprintf("Entferntes Objekt <em>%s</em>", $this->__toString()));
208 $this->setRealClass("DestructedObject");
209 $this->resetUniqueID();
210 } elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
211 // Already destructed object
212 $this->getDebugInstance()->output(sprintf("[%s:] Das Objekt <strong>%s</strong> wurde bereits zerstört.<br />\n",
213 __CLASS__, $this->__toString()
219 * The call method where all non-implemented methods end up
223 public final function __call ($methodName, $args) {
224 // Implode all given arguments
228 $argsString = "NULL";
229 } elseif (is_array($args)) {
230 // Some arguments are there
231 foreach ($args as $arg) {
235 if ($arg) $argsString .= "true(bool)"; else $argsString .= "false(bool)";
236 } elseif (is_int($arg)) {
238 $argsString .= $arg."(int)";
239 } elseif (is_float($arg)) {
241 $argsString .= $arg."(float)";
242 } elseif ($arg instanceof BaseFrameworkSystem) {
243 // Own object instance
244 $argsString .= $arg->__toString()."(Object)";
245 } elseif (is_object($arg)) {
247 $argsString .= "unknown object(!)";
248 } elseif (is_array($arg)) {
250 $argsString .= "Array(array)";
251 } elseif (is_string($arg)) {
253 $argsString .= "\"".$arg."\"(string)";
254 } elseif (is_null($arg)) {
256 $argsString .= "(null)";
258 // Unknown type (please report!)
259 $argsString .= $arg."(unknown!)";
267 if (substr($argsString, -2, 1) === ",") $argsString = substr($argsString, 0, -2);
269 // Invalid arguments!
270 $argsString = sprintf("!INVALID:%s!", $args);
273 $this->getDebugInstance()->output(sprintf("[%s::%s] Stub! Args: %s",
284 * Private initializer for this class
288 private final function initInstance () {
289 // Is this a system class?
290 if (!in_array($this->__toString(), $this->systemClasses)) {
291 // Add application helper to our class
292 $this->systemclasses[] = $this->getConfigInstance()->readConfig('app_helper_class');
294 // Set debug instance
295 $this->setDebugInstance(DebugMiddleware::createDebugMiddleware($this->getConfigInstance()->readConfig('debug_class')));
297 // Get output instance and set it
298 $outputInstance = ObjectFactory::createObjectByConfiguredName('web_engine', array($this->getConfigInstance()->readConfig('web_content_type')));
299 $this->setWebOutputInstance($outputInstance);
301 // Set the compressor channel
302 $this->setCompressorChannel(CompressorChannel::createCompressorChannel(sprintf("%s%s",
304 $this->getConfigInstance()->readConfig('compressor_base_path')
307 // Initialization done! :D
308 Registry::isInitialized("OK");
309 } elseif ($this->__toString() == "DebugMiddleware") {
310 // Set configuration instance
311 $this->setConfigInstance(FrameworkConfiguration::createFrameworkConfiguration());
316 * Setter for search instance
318 * @param $searchInstance Searchable criteria instance
321 public final function setSearchInstance (LocalSearchCriteria $searchInstance) {
322 $this->searchInstance = $searchInstance;
326 * Getter for search instance
328 * @return $searchInstance Searchable criteria instance
330 public final function getSearchInstance () {
331 return $this->searchInstance;
335 * Setter for resolver instance
337 * @param $resolverInstance Instance of a command resolver class
340 public final function setResolverInstance (Resolver $resolverInstance) {
341 $this->resolverInstance = $resolverInstance;
345 * Getter for resolver instance
347 * @return $resolverInstance Instance of a command resolver class
349 public final function getResolverInstance () {
350 return $this->resolverInstance;
354 * Setter for language instance
356 * @param $configInstance The configuration instance which shall
357 * be FrameworkConfiguration
360 public final function setConfigInstance (FrameworkConfiguration $configInstance) {
361 Registry::getRegistry()->addInstance('config', $configInstance);
365 * Getter for configuration instance
367 * @return $cfgInstance Configuration instance
369 protected final function getConfigInstance () {
370 $cfgInstance = Registry::getRegistry()->getInstance('config');
375 * Setter for debug instance
377 * @param $debugInstance The instance for debug output class
380 public final function setDebugInstance (DebugMiddleware $debugInstance) {
381 self::$debugInstance = $debugInstance;
385 * Getter for debug instance
387 * @return $debugInstance Instance to class DebugConsoleOutput or DebugWebOutput
389 public final function getDebugInstance () {
390 return self::$debugInstance;
394 * Setter for web output instance
396 * @param $webInstance The instance for web output class
399 public final function setWebOutputInstance (OutputStreamer $webInstance) {
400 Registry::getRegistry()->addInstance('web_output', $webInstance);
404 * Getter for web output instance
406 * @return $webOutput - Instance to class WebOutput
408 public final function getWebOutputInstance () {
409 return Registry::getRegistry()->getInstance('web_output');
413 * Setter for database instance
415 * @param $dbInstance The instance for the database connection
416 * (forced DatabaseConnection)
419 public final function setDatabaseInstance (DatabaseConnection $dbInstance) {
420 Registry::getRegistry()->addInstance('dbInstance', $dbInstance);
424 * Getter for database layer
426 * @return $dbInstance The database layer instance
428 public final function getDatabaseInstance () {
429 if ((class_exists('Registry')) && (Registry::isInitialized() === true)) {
430 return Registry::getRegistry()->getInstance('dbInstance');
437 * Setter for compressor channel
439 * @param $compressorChannel An instance of CompressorChannel
442 public final function setCompressorChannel (CompressorChannel $compressorChannel) {
443 Registry::getRegistry()->addInstance('compressor', $compressorChannel);
447 * Getter for compressor channel
449 * @return $compressor The compressor channel
451 public final function getCompressorChannel () {
452 return Registry::getRegistry()->getInstance('compressor');
456 * Protected getter for a manageable application helper class
458 * @return $applicationInstance An instance of a manageable application helper class
460 protected final function getApplicationInstance () {
461 return self::$applicationInstance;
465 * Setter for a manageable application helper class
467 * @param $applicationInstance An instance of a manageable application helper class
470 public final function setApplicationInstance (ManageableApplication $applicationInstance) {
471 self::$applicationInstance = $applicationInstance;
475 * Setter for request instance
477 * @param $requestInstance An instance of a Requestable class
480 public final function setRequestInstance (Requestable $requestInstance) {
481 $this->requestInstance = $requestInstance;
485 * Getter for request instance
487 * @return $requestInstance An instance of a Requestable class
489 public final function getRequestInstance () {
490 return $this->requestInstance;
494 * Setter for response instance
496 * @param $responseInstance An instance of a Responseable class
499 public final function setResponseInstance (Responseable $responseInstance) {
500 $this->responseInstance = $responseInstance;
504 * Getter for response instance
506 * @return $responseInstance An instance of a Responseable class
508 public final function getResponseInstance () {
509 return $this->responseInstance;
513 * Getter for $realClass
515 * @return $realClass The name of the real class (not BaseFrameworkSystem)
517 public final function __toString () {
518 return $this->realClass;
522 * Setter for the real class name
524 * @param $realClass Class name (string)
527 public final function setRealClass ($realClass) {
529 $realClass = (string) $realClass;
532 $this->realClass = $realClass;
536 * Generate unique ID from a lot entropy
540 public final function generateUniqueId () {
541 // Is the id set for this class?
542 if (empty($this->uniqueID)) {
544 // Correct missing class name
546 if ($this->__toString() == "") {
547 $this->setRealClass(__CLASS__);
551 // Cache datbase instance
552 $db = $this->getDatabaseInstance();
557 // Generate a unique ID number
558 $tempID = $this->generateIdNumber();
561 // Try to figure out if the ID number is not yet used
563 // Is this a registry?
564 if ($this->__toString() == "Registry") {
565 // Registry, then abort here
567 } elseif (is_object($db)) {
568 $isUsed = $db->isUniqueIdUsed($tempID, true);
570 } catch (FrameworkException $e) {
571 // Catches all and ignores all ;-)
595 $this->setUniqueID($tempID);
597 // Revert maybe corrected class name
599 $this->setRealClass("");
602 // Remove system classes if we are in a system class
603 if ((isset($this->systemClasses)) && (in_array($this->__toString(), $this->systemClasses))) {
604 // This may save some RAM...
605 $this->removeSystemArray();
611 * Generates a new ID number for classes based from the class' real name,
612 * the description and some random data
614 * @return $tempID The new (temporary) ID number
616 private final function generateIdNumber () {
617 return sprintf("%s@%s",
619 md5(sprintf("%s:%s:%s:%s:%s:%s",
621 $this->getObjectDescription(),
623 getenv('REMOTE_ADDR'),
624 getenv('SERVER_ADDR'),
631 * Setter for unique ID
633 * @param $uniqueID The newly generated unique ID number
636 private final function setUniqueID ($uniqueID) {
638 $uniqueID = (string) $uniqueID;
641 $this->uniqueID = $uniqueID;
645 * Getter for unique ID
647 * @return $uniqueID The unique ID of this class
649 public final function getUniqueID () {
650 return $this->uniqueID;
654 * Resets or recreates the unique ID number
658 public final function resetUniqueID() {
659 // Sweet and simple... ;-)
660 $newUniqueID = $this->generateIdNumber();
661 $this->setUniqueID($newUniqueID);
665 * Getter for simulator description
667 * @return $objectDescription The description of this simulation part
669 public final function getObjectDescription () {
670 if (isset($this->objectDescription)) {
671 return $this->objectDescription;
678 * Setter for simulation part description
680 * @param $objectDescription The description as string for this simulation part
683 public final function setObjectDescription ($objectDescription) {
684 $this->objectDescription = (String) $objectDescription;
688 * Validate if given object is the same as current
690 * @param $object An object instance for comparison with this class
691 * @return boolean The result of comparing both's unique ID
693 public final function equals ($object) {
694 return ($this->getUniqueID() == $object->getUniqueID());
698 * Compare if both simulation part description and class name matches
701 * @param $itemInstance An object instance to an other class
702 * @return boolean The result of comparing class name simulation part description
704 public function itemMatches ($itemInstance) {
707 $this->__toString() == $itemInstance->__toString()
709 $this->getObjectDescription() == $itemInstance->getObjectDescription()
715 * Compare class name of this and given class name
717 * @param $class The class name as string from the other class
718 * @return boolean The result of comparing both class names
720 public final function isClass ($class) {
721 return ($this->__toString() == $class);
725 * Stub method (only real cabins shall override it)
727 * @return boolean false = is no cabin, true = is a cabin
729 public function isCabin () {
734 * Stub method for tradeable objects
736 * @return boolean false = is not tradeable by the Merchant class,
737 * true = is a tradeable object
739 public function isTradeable () {
744 * Formats computer generated price values into human-understandable formats
745 * with thousand and decimal seperators.
747 * @param $value The in computer format value for a price
748 * @param $currency The currency symbol (use HTML-valid characters!)
749 * @param $decNum Number of decimals after commata
750 * @return $price The for the current language formated price string
751 * @throws MissingDecimalsThousandsSeperatorException If decimals or
752 * thousands seperator
755 public function formatCurrency ($value, $currency = "€", $decNum = 2) {
756 // Are all required attriutes set?
757 if ((!isset($this->decimals)) || (!isset($this->thousands))) {
758 // Throw an exception
759 throw new MissingDecimalsThousandsSeperatorException($this, self::EXCEPTION_ATTRIBUTES_ARE_MISSING);
763 $value = (float) $value;
765 // Reformat the US number
766 $price = sprintf("%s %s",
767 number_format($value, $decNum, $this->decimals, $this->thousands),
771 // Return as string...
776 * Removes number formating characters
780 public final function removeNumberFormaters () {
781 unset($this->thousands);
782 unset($this->decimals);
786 * Private getter for language instance
788 * @return $langInstance An instance to the language sub-system
790 protected final function getLanguageInstance () {
791 return self::$langInstance;
795 * Setter for language instance
797 * @param $langInstance An instance to the language sub-system
799 * @see LanguageSystem
801 public final function setLanguageInstance (ManageableLanguage $langInstance) {
802 self::$langInstance = $langInstance;
806 * Remove the $systemClasses array from memory
810 public final function removeSystemArray () {
811 unset($this->systemClasses);
815 * Create a file name and path name from the object's unique ID number.
816 * The left part of the ID shall always be a valid class name and the
817 * right part an ID number.
819 * @return $pfn The file name with a prepended path name
820 * @throws NoArrayCreatedException If explode() fails to create an array
821 * @throws InvalidArrayCountException If the array contains less or
822 * more than two elements
824 public final function getPathFileNameFromObject () {
825 // Get the main object's unique ID. We use this as a path/filename combination
826 $pathFile = $this->getUniqueID();
828 // Split it up in path and file name
829 $pathFile = explode("@", $pathFile);
831 // Are there two elements? Index 0 is the path, 1 the file name + global extension
832 if (!is_array($pathFile)) {
834 throw new NoArrayCreatedException(array($this, "pathFile"), self::EXCEPTION_ARRAY_EXPECTED);
835 } elseif (count($pathFile) != 2) {
836 // Invalid ID returned!
837 throw new InvalidArrayCountException(array($this, "pathFile", count($pathFile), 2), self::EXCEPTION_ARRAY_HAS_INVALID_COUNT);
840 // Auto-append missing trailing slash
841 $pathFile[0] = $this->addMissingTrailingSlash($pathFile[0]);
843 // Create the file name and return it
844 $pfn = ($pathFile[0] . $pathFile[1]);
849 * Appends a trailing slash to a string
851 * @param $str A string (maybe) without trailing slash
852 * @return $str A string with an auto-appended trailing slash
854 public final function addMissingTrailingSlash ($str) {
855 // Is there a trailing slash?
856 if (substr($str, -1, 1) != "/") $str .= "/";
861 * Private getter for file IO instance
863 * @return $fileIoInstance An instance to the file I/O sub-system
865 protected final function getFileIoInstance () {
866 return $this->fileIoInstance;
870 * Setter for file I/O instance
872 * @param $fileIoInstance An instance to the file I/O sub-system
875 public final function setFileIoInstance (FileIoHandler $fileIoInstance) {
876 $this->fileIoInstance = $fileIoInstance;
880 * Prepare the template engine (TemplateEngine by default) for a given
881 * application helper instance (ApplicationHelper by default).
883 * @param $appInstance An application helper instance or
884 * null if we shall use the default
885 * @return $tplEngine The template engine instance
886 * @throws NullPointerException If the template engine could not
888 * @throws UnsupportedTemplateEngineException If $tplEngine is an
889 * unsupported template engine
890 * @throws MissingLanguageHandlerException If the language sub-system
891 * is not yet initialized
892 * @throws NullPointerException If the discovered application
893 * instance is still null
895 protected function prepareTemplateEngine (BaseFrameworkSystem $appInstance=null) {
896 // Is the application instance set?
897 if (is_null($appInstance)) {
898 // Get the current instance
899 $appInstance = $this->getApplicationInstance();
902 if (is_null($appInstance)) {
903 // Thrown an exception
904 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
908 // Generate FQFN for all application templates
909 $fqfn = sprintf("%s%s/%s/%s",
911 $this->getConfigInstance()->readConfig('application_path'),
912 strtolower($appInstance->getAppShortName()),
913 $this->getConfigInstance()->readConfig('tpl_base_path')
916 // Are both instances set?
917 if ($appInstance->getLanguageInstance() === null) {
918 // Invalid language instance
919 throw new MissingLanguageHandlerException($appInstance, self::EXCEPTION_MISSING_LANGUAGE_HANDLER);
920 } elseif ($appInstance->getFileIoInstance() === null) {
921 // Invalid language instance
922 throw new MissingFileIoHandlerException($appInstance, self::EXCEPTION_MISSING_FILE_IO_HANDLER);
925 // Initialize the template engine
926 $tplEngine = ObjectFactory::createObjectByConfiguredName('template_class', array($fqfn, $appInstance->getLanguageInstance(), $appInstance->getFileIoInstance()));
928 // Return the prepared instance
933 * Debugs this instance by putting out it's full content
937 public final function debugInstance () {
938 // Generate the output
939 $content = sprintf("<pre>%s</pre>",
940 trim(print_r($this, true))
944 ApplicationEntryPoint::app_die(sprintf("<strong>%s debug output:</strong><div id=\"debug_content\">%s</div>Loaded includes: <div id=\"debug_include_list\">%s</div>",
947 ClassLoader::getInstance()->getPrintableIncludeList()
952 * Output a partial stub message for the caller method
954 * @param $message An optional message to display
957 protected function partialStub ($message = "") {
959 $backtrace = debug_backtrace();
961 // Generate the class::method string
962 $methodName = "UnknownClass::unknownMethod";
963 if ((isset($backtrace[1]['class'])) && (isset($backtrace[1]['function']))) {
964 $methodName = $backtrace[1]['class']."::".$backtrace[1]['function'];
967 // Construct the full message
968 $stubMessage = sprintf("[%s:] Partial stub!",
972 // Is the extra message given?
973 if (!empty($message)) {
974 // Then add it as well
975 $stubMessage .= sprintf(" Message: <span id=\"stub_message\">%s</span>", $message);
978 // Debug instance is there?
979 if (!is_null($this->getDebugInstance())) {
980 // Output stub message
981 $this->getDebugInstance()->output($stubMessage);
984 trigger_error($stubMessage."<br />\n");
989 * Outputs a debug backtrace and stops further script execution
993 public function debugBacktrace () {
994 // Sorry, there is no other way getting this nice backtrace
996 debug_print_backtrace();
1002 * Outputs a debug message wether to debug instance (should be set!) or dies with or pints the message
1004 * @param $message Message we shall send out...
1005 * @param $doPrint Wether we shall print or die here which last is the default
1008 public function debugOutput ($message, $doPrint = false) {
1009 // Get debug instance
1010 $debugInstance = $this->getDebugInstance();
1012 // Is the debug instance there?
1013 if (is_object($debugInstance)) {
1014 // Use debug output handler
1015 $debugInstance->output($message);
1016 if (!$doPrint) die(); // Die here if not printed
1019 // DO NOT REWRITE THIS TO app_die() !!!
1029 * Converts e.g. a command from URL to a valid class by keeping out bad characters
1031 * @param $str The string, what ever it is needs to be converted
1032 * @return $className Generated class name
1034 public function convertToClassName ($str) {
1038 // Convert all dashes in underscores
1039 $str = str_replace("-", "_", $str);
1041 // Now use that underscores to get classname parts for hungarian style
1042 foreach (explode("_", $str) as $strPart) {
1043 // Make the class name part lower case and first upper case
1044 $className .= ucfirst(strtolower($strPart));
1047 // Return class name
1052 * Marks up the code by adding e.g. line numbers
1054 * @param $phpCode Unmarked PHP code
1055 * @return $markedCode Marked PHP code
1057 public function markupCode ($phpCode) {
1059 $errorArray = error_get_last();
1061 // Init the code with error message
1063 if (is_array($errorArray)) {
1065 $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>",
1066 basename($errorArray['file']),
1067 $errorArray['line'],
1068 $errorArray['message'],
1073 // Add line number to the code
1074 foreach (explode("\n", $phpCode) as $lineNo=>$code) {
1076 $markedCode .= sprintf("<span id=\"code_line\">%s</span>: %s\n",
1078 htmlentities($code, ENT_QUOTES)