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;
151 const EXCEPTION_DEFAUL_CONTROLLER_GONE = 0x034;
152 const EXCEPTION_CLASS_NOT_FOUND = 0x035;
155 * In the super constructor these system classes shall be ignored or else
156 * we would get an endless calling loop.
158 *--------------------------------------------------------------------*
159 * ATTENTION: IF YOU REMOVE ONE OF THEM YOU WILL SHOOT YOUR SERVER!!! *
160 *--------------------------------------------------------------------*
162 private $systemClasses = array(
163 "DebugMiddleware", // Debug middleware output sub-system
164 "DebugWebOutput", // Debug web output sub-system
165 "DebugConsoleOutput", // Debug console output sub-system
166 "DebugErrorLogOutput", // Debug error_log() output sub-system
167 "CompressorChannel", // Compressor sub-system
168 "FrameworkDirectoryPointer", // Directory handler sub-system
169 "NullCompressor", // Null compressor
170 "Bzip2Compressor", // BZIP2 compressor
171 "GzipCompressor", // GZIP compressor
172 "WebOutput", // Web output sub-system
176 * Private super constructor
180 protected function __construct ($class) {
182 $this->setRealClass($class);
184 // Init this instance
185 $this->initInstance($class);
189 * Destructor reached...
193 public function __destruct() {
194 // Is this object already destroyed?
195 if ($this->__toString() != "DestructedObject") {
197 if ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
198 $this->getDebugInstance()->output(sprintf("[%s:] Das Objekt <strong>%s</strong> wird zerstört.<br />\n",
199 __CLASS__, $this->__toString()
203 // Destroy all informations about this class but keep some text about it alive
204 $this->setObjectDescription(sprintf("Entferntes Objekt <em>%s</em>", $this->__toString()));
205 $this->setRealClass("DestructedObject");
206 $this->resetUniqueID();
207 } elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
208 // Already destructed object
209 $this->getDebugInstance()->output(sprintf("[%s:] Das Objekt <strong>%s</strong> wurde bereits zerstört.<br />\n",
210 __CLASS__, $this->__toString()
216 * The call method where all non-implemented methods end up
220 public final function __call ($methodName, $args) {
221 // Implode all given arguments
225 $argsString = "NULL";
226 } elseif (is_array($args)) {
227 // Some arguments are there
228 foreach ($args as $arg) {
232 if ($arg) $argsString .= "true(bool)"; else $argsString .= "false(bool)";
233 } elseif (is_int($arg)) {
235 $argsString .= $arg."(int)";
236 } elseif (is_float($arg)) {
238 $argsString .= $arg."(float)";
239 } elseif ($arg instanceof BaseFramework) {
240 // Own object instance
241 $argsString .= $arg->__toString()."(Object)";
242 } elseif (is_object($arg)) {
244 $argsString .= "unknown object(!)";
245 } elseif (is_array($arg)) {
247 $argsString .= "Array(array)";
248 } elseif (is_string($arg)) {
250 $argsString .= "\"".$arg."\"(string)";
252 // Unknown type (please report!)
253 $argsString .= $arg."(unknown!)";
261 if (substr($argsString, -2, 1) === ",") $argsString = substr($argsString, 0, -2);
263 // Invalid arguments!
264 $argsString = sprintf("!INVALID:%s!", $args);
267 $this->getDebugInstance()->output(sprintf("[%s::%s] Stub! Args: %s",
278 * Initializes the instance
282 public function initInstance ($class) {
283 // Get the current (singleton) configuration instance
284 $this->setConfigInstance(FrameworkConfiguration::createFrameworkConfiguration());
286 // Is the class weather debug nor compressor channel?
287 if (!in_array($class, $this->systemClasses)) {
288 // Initialize debug instance
289 if (is_null($this->getDebugInstance())) {
290 // Set the debug output system if it is not debug class ;)
291 $this->setDebugInstance(DebugMiddleware::createDebugMiddleware($this->getConfigInstance()->readConfig('debug_engine')));
294 // Initialize web instance
295 if (is_null($this->getWebOutputInstance())) {
296 // Generate the eval() command
297 $eval = sprintf("\$this->setWebOutputInstance(%s::create%s(\"%s\"));",
298 $this->getConfigInstance()->readConfig('web_engine'),
299 $this->getConfigInstance()->readConfig('web_engine'),
300 $this->getConfigInstance()->readConfig('web_content_type')
304 if (defined('DEBUG_EVAL')) $this->getDebugInstance()->output(sprintf("[%s:] Constructed PHP command: <pre><em>%s</em></pre><br />\n",
313 // Initialize compressor channel
314 if (is_null($this->getCompressorChannel())) {
315 // Set the compressor channel
316 $this->setCompressorChannel(CompressorChannel::createCompressorChannel(sprintf("%s%s",
318 $this->getConfigInstance()->readConfig('compressor_base_path')
322 // Initialize database middleware
323 if (is_null($this->getDatabaseInstance())) {
324 // Get the middleware instance
325 $db = DatabaseConnection::getInstance();
326 if (is_object($db)) {
327 // Set the database middleware
328 $this->setDatabaseInstance($db);
335 * Setter for language instance
337 * @param $configInstance The configuration instance which shall
338 * be FrameworkConfiguration
341 public final function setConfigInstance (FrameworkConfiguration $configInstance) {
342 self::$cfgInstance = $configInstance;
346 * Getter for configuration instance
348 * @return $cfhInstance - Configuration instance
350 protected final function getConfigInstance () {
351 return self::$cfgInstance;
355 * Setter for debug instance
357 * @param $debugInstance The instance for debug output class
360 public final function setDebugInstance (DebugMiddleware $debugInstance) {
361 self::$debug = $debugInstance;
365 * Getter for debug instance
367 * @return $debug - Instance to class DebugConsoleOutput or DebugWebOutput
369 public final function getDebugInstance () {
374 * Setter for web output instance
376 * @param $webInstance The instance for web output class
379 public final function setWebOutputInstance (OutputStreamer $webInstance) {
380 self::$webOutput = $webInstance;
384 * Getter for web output instance
386 * @return $webOutput - Instance to class WebOutput
388 public final function getWebOutputInstance () {
389 return self::$webOutput;
393 * Static setter for database instance
395 * @param $dbInstance The instance for the database connection
396 * (forced DatabaseConnection)
399 public final function setDatabaseInstance (DatabaseConnection $dbInstance) {
400 $this->dbInstance = $dbInstance;
404 * Getter for $realClass
406 * @return $realClass The name of the real class (not BaseFrameworkSystem)
408 public final function __toString () {
409 return $this->realClass;
413 * Setter for the real class name
415 * @param $realClass Class name (string)
418 public final function setRealClass ($realClass) {
420 $realClass = (string) $realClass;
423 $this->realClass = $realClass;
427 * Generate unique ID from a lot entropy
431 public final function createUniqueID () {
432 // Existiert noch keine?
433 if (empty($this->uniqueID)) {
435 // Correct missing class name
437 if ($this->__toString() == "") {
438 $this->setRealClass(__CLASS__);
445 // Generate a unique ID number
446 $tempID = $this->generateIdNumber();
449 // Try to figure out if the ID number is not yet used
451 if (is_object($this->getDatabaseInstance())) {
452 $isUsed = $this->getDatabaseInstance()->isUniqueIdUsed($tempID, true);
454 } catch (FrameworkException $e) {
455 // Catches all and ignores all ;-)
463 $this->getDatabaseInstance() === null
466 is_object($this->getDatabaseInstance())
479 $this->setUniqueID($tempID);
481 // Revert maybe corrected class name
483 $this->setRealClass("");
486 // Remove system classes if we are in a system class
487 if ((isset($this->systemClasses)) && (in_array($this->__toString(), $this->systemClasses))) {
488 // This may save some RAM...
489 $this->removeSystemArray();
495 * Generates a new ID number for classes based from the class' real name,
496 * the description and some random data
498 * @return $tempID The new (temporary) ID number
500 private final function generateIdNumber () {
501 return sprintf("%s@%s",
503 md5(sprintf("%s:%s:%s:%s:%s:%s",
505 $this->getObjectDescription(),
507 getenv('REMOTE_ADDR'),
508 getenv('SERVER_ADDR'),
515 * Setter for unique ID
517 * @param $uniqueID The newly generated unique ID number
520 private final function setUniqueID ($uniqueID) {
522 $uniqueID = (string) $uniqueID;
525 $this->uniqueID = $uniqueID;
529 * Getter for unique ID
531 * @return $uniqueID The unique ID of this class
533 public final function getUniqueID () {
534 return $this->uniqueID;
538 * Resets or recreates the unique ID number
542 public final function resetUniqueID() {
543 // Sweet and simple... ;-)
544 $newUniqueID = $this->generateIdNumber();
545 $this->setUniqueID($newUniqueID);
549 * Getter for simulator description
551 * @return $objectDescription The description of this simulation part
553 public final function getObjectDescription () {
554 if (isset($this->objectDescription)) {
555 return $this->objectDescription;
562 * Setter for simulation part description
564 * @param $objectDescription The description as string for this simulation part
567 public final function setObjectDescription ($objectDescription) {
568 $this->objectDescription = (String) $objectDescription;
572 * Validate if given object is the same as current
574 * @param $object An object instance for comparison with this class
575 * @return boolean The result of comparing both's unique ID
577 public final function equals ($object) {
578 return ($this->getUniqueID() == $object->getUniqueID());
582 * Compare if both simulation part description and class name matches
585 * @param $itemInstance An object instance to an other class
586 * @return boolean The result of comparing class name simulation part description
588 public function itemMatches ($itemInstance) {
591 $this->__toString() == $itemInstance->__toString()
593 $this->getObjectDescription() == $itemInstance->getObjectDescription()
599 * Compare class name of this and given class name
601 * @param $class The class name as string from the other class
602 * @return boolean The result of comparing both class names
604 public final function isClass ($class) {
605 return ($this->__toString() == $class);
609 * Stub method (only real cabins shall override it)
611 * @return boolean false = is no cabin, true = is a cabin
613 public function isCabin () {
618 * Stub method for tradeable objects
620 * @return boolean false = is not tradeable by the Merchant class,
621 * true = is a tradeable object
623 public function isTradeable () {
628 * Formats computer generated price values into human-understandable formats
629 * with thousand and decimal seperators.
631 * @param $value The in computer format value for a price
632 * @param $currency The currency symbol (use HTML-valid characters!)
633 * @param $decNum Number of decimals after commata
634 * @return $price The for the current language formated price string
635 * @throws MissingDecimalsThousandsSeperatorException If decimals or
636 * thousands seperator
639 public function formatCurrency ($value, $currency = "€", $decNum = 2) {
640 // Are all required attriutes set?
641 if ((!isset($this->decimals)) || (!isset($this->thousands))) {
642 // Throw an exception
643 throw new MissingDecimalsThousandsSeperatorException($this, self::EXCEPTION_ATTRIBUTES_ARE_MISSING);
647 $value = (float) $value;
649 // Reformat the US number
650 $price = sprintf("%s %s",
651 number_format($value, $decNum, $this->decimals, $this->thousands),
655 // Return as string...
660 * Removes number formating characters
664 public final function removeNumberFormaters () {
665 unset($this->thousands);
666 unset($this->decimals);
670 * Getter for database layer
672 * @return $dbInstance The database layer instance
674 public final function getDatabaseInstance () {
675 return $this->dbInstance;
679 * Setter for compressor channel
681 * @param $compressorChannel An instance of CompressorChannel
684 public final function setCompressorChannel (CompressorChannel $compressorChannel) {
685 self::$compressor = $compressorChannel;
689 * Getter for compressor channel
691 * @return $compressor The compressor channel
693 public final function getCompressorChannel () {
694 return self::$compressor;
698 * Remove the $systemClasses array from memory
702 public final function removeSystemArray () {
703 unset($this->systemClasses);
707 * Create a file name and path name from the object's unique ID number.
708 * The left part of the ID shall always be a valid class name and the
709 * right part an ID number.
711 * @return $pfn The file name with a prepended path name
712 * @throws NoArrayCreatedException If explode() fails to create an array
713 * @throws InvalidArrayCountException If the array contains less or
714 * more than two elements
716 public final function getPathFileNameFromObject () {
717 // Get the main object's unique ID. We use this as a path/filename combination
718 $pathFile = $this->getUniqueID();
720 // Split it up in path and file name
721 $pathFile = explode("@", $pathFile);
723 // Are there two elements? Index 0 is the path, 1 the file name + global extension
724 if (!is_array($pathFile)) {
726 throw new NoArrayCreatedException(array($this, "pathFile"), self::EXCEPTION_ARRAY_EXPECTED);
727 } elseif (count($pathFile) != 2) {
728 // Invalid ID returned!
729 throw new InvalidArrayCountException(array($this, "pathFile", count($pathFile), 2), self::EXCEPTION_ARRAY_HAS_INVALID_COUNT);
732 // Auto-append missing trailing slash
733 $pathFile[0] = $this->addMissingTrailingSlash($pathFile[0]);
735 // Create the file name and return it
736 $pfn = ($pathFile[0] . $pathFile[1]);
741 * Appends a trailing slash to a string
743 * @param $str A string (maybe) without trailing slash
744 * @return $str A string with an auto-appended trailing slash
746 public final function addMissingTrailingSlash ($str) {
747 // Is there a trailing slash?
748 if (substr($str, -1, 1) != "/") $str .= "/";
753 * Private getter for language instance
755 * @return $langInstance An instance to the language sub-system
757 protected final function getLanguageInstance () {
758 return $this->langInstance;
762 * Setter for language instance
764 * @param $langInstance An instance to the language sub-system
766 * @see LanguageSystem
768 public final function setLanguageInstance (ManageableLanguage $langInstance) {
769 $this->langInstance = $langInstance;
773 * Private getter for file IO instance
775 * @return $fileIOInstance An instance to the file I/O sub-system
777 protected final function getFileIoInstance () {
778 return $this->fileIOInstance;
782 * Setter for file I/O instance
784 * @param $fileIOInstance An instance to the file I/O sub-system
787 public final function setFileIoInstance (FileIoHandler $fileIOInstance) {
788 $this->fileIOInstance = $fileIOInstance;
792 * Protected getter for a manageable application helper class
794 * @return $applicationInstance An instance of a manageable application helper class
796 protected final function getApplicationInstance () {
797 return $this->applicationInstance;
801 * Setter for a manageable application helper class
803 * @param $applicationInstance An instance of a manageable application helper class
806 public final function setApplicationInstance (ManageableApplication $applicationInstance) {
807 $this->applicationInstance = $applicationInstance;
811 * Prepare the template engine (TemplateEngine by default) for a given
812 * application helper instance (ApplicationHelper by default).
814 * @param $appInstance An application helper instance or
815 * null if we shall use the default
816 * @return $tplEngine The template engine instance
817 * @throws NullPointerException If the template engine could not
819 * @throws UnsupportedTemplateEngineException If $tplEngine is an
820 * unsupported template engine
821 * @throws MissingLanguageHandlerException If the language sub-system
822 * is not yet initialized
823 * @throws NullPointerException If the discovered application
824 * instance is still null
826 protected function prepareTemplateEngine (BaseFrameworkSystem $appInstance=null) {
827 // Is the application instance set?
828 if (is_null($appInstance)) {
829 // Get the current instance
830 $appInstance = $this->getApplicationInstance();
833 if (is_null($appInstance)) {
834 // Thrown an exception
835 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
839 // Generate FQFN for all application templates
840 $fqfn = sprintf("%s%s/%s/%s",
842 $this->getConfigInstance()->readConfig('application_path'),
843 strtolower($appInstance->getAppShortName()),
844 $this->getConfigInstance()->readConfig('tpl_base_path')
847 // Are both instances set?
848 if ($appInstance->getLanguageInstance() === null) {
849 // Invalid language instance
850 throw new MissingLanguageHandlerException($appInstance, self::EXCEPTION_MISSING_LANGUAGE_HANDLER);
851 } elseif ($appInstance->getFileIoInstance() === null) {
852 // Invalid language instance
853 throw new MissingFileIoHandlerException($appInstance, self::EXCEPTION_MISSING_FILE_IO_HANDLER);
856 // Initialize the template engine
858 $eval = sprintf("\$tplEngine = %s::create%s(
860 \$appInstance->getLanguageInstance(),
861 \$appInstance->getFileIoInstance()
863 $this->getConfigInstance()->readConfig('tpl_engine'),
864 $this->getConfigInstance()->readConfig('tpl_engine'),
869 if ((!is_null($this->getDebugInstance())) && (defined('DEBUG_EVAL'))) {
870 $this->getDebugInstance()->output(sprintf("[%s:] Constructed PHP command: <pre><em>%s</em></pre><br />\n",
879 // Is it a valid instance?
880 if (is_null($tplEngine)) {
882 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
883 } elseif (!$tplEngine instanceof CompileableTemplate) {
884 // Not an object! ;-(
885 throw new UnsupportedTemplateEngineException($tplEngine, self::EXCEPTION_TEMPLATE_ENGINE_UNSUPPORTED);
888 // Return the prepared instance
893 * Debugs this instance by putting out it's full content
897 public final function debugInstance () {
898 // Generate the output
899 $content = sprintf("<pre>%s</pre>",
900 trim(print_r($this, true))
904 ApplicationEntryPoint::app_die(sprintf("<strong>%s debug output:</strong>%s", $this->__toString(), $content));
908 * Output a partial stub message for the caller method
910 * @param $message An optional message to display
913 protected function partialStub ($message = "") {
915 $backtrace = debug_backtrace();
917 // Generate the class::method string
918 $methodName = "UnknownClass::unknownMethod";
919 if ((isset($backtrace[1]['class'])) && (isset($backtrace[1]['function']))) {
920 $methodName = $backtrace[1]['class']."::".$backtrace[1]['function'];
923 // Construct the full message
924 $stubMessage = sprintf("[%s:] Partial stub!",
928 // Is the extra message given?
929 if (!empty($message)) {
930 // Then add it as well
931 $stubMessage .= sprintf(" Message: <u>%s</u>", $message);
934 // Debug instance is there?
935 if (!is_null($this->getDebugInstance())) {
936 // Output stub message
937 $this->getDebugInstance()->output($stubMessage);
940 trigger_error($stubMessage."<br />\n");
945 * Converts e.g. a command from URL to a valid class by keeping out bad characters
947 * @param $str The string, what ever it is needs to be converted
948 * @return $className Generated class name
950 public function convertToClassName ($str) {
952 foreach (explode("_", $str) as $strPart) {
953 $className .= ucfirst(strtolower($strPart));
959 * Outputs a debug backtrace and stops further script execution
963 public function debugBacktrace () {
964 // Sorry, there is no other way getting this nice backtrace
966 debug_print_backtrace();