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;
37 * Instance of a request class
39 private $requestInstance = null;
42 * Instance of a response class
44 private $responseInstance = null;
47 * Search criteria instance
49 private $searchInstance = null;
52 * The file I/O instance for the template loader
54 private $fileIoInstance = null;
59 private $resolverInstance = 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
86 /***********************
87 * Exception codes.... *
88 ***********************/
90 const EXCEPTION_IS_NULL_POINTER = 0x001;
91 const EXCEPTION_IS_NO_OBJECT = 0x002;
92 const EXCEPTION_IS_NO_ARRAY = 0x003;
93 const EXCEPTION_MISSING_METHOD = 0x004;
94 const EXCEPTION_CLASSES_NOT_MATCHING = 0x005;
95 const EXCEPTION_INDEX_OUT_OF_BOUNDS = 0x006;
96 const EXCEPTION_DIMENSION_ARRAY_INVALID = 0x007;
97 const EXCEPTION_ITEM_NOT_TRADEABLE = 0x008;
98 const EXCEPTION_ITEM_NOT_IN_PRICE_LIST = 0x009;
99 const EXCEPTION_GENDER_IS_WRONG = 0x00a;
100 const EXCEPTION_BIRTH_DATE_IS_INVALID = 0x00b;
101 const EXCEPTION_EMPTY_STRUCTURES_ARRAY = 0x00c;
102 const EXCEPTION_HAS_ALREADY_PERSONELL_LIST = 0x00d;
103 const EXCEPTION_NOT_ENOUGTH_UNEMPLOYEES = 0x00e;
104 const EXCEPTION_TOTAL_PRICE_NOT_CALCULATED = 0x00f;
105 const EXCEPTION_HARBOR_HAS_NO_SHIPYARDS = 0x010;
106 const EXCEPTION_CONTRACT_PARTNER_INVALID = 0x011;
107 const EXCEPTION_CONTRACT_PARTNER_MISMATCH = 0x012;
108 const EXCEPTION_CONTRACT_ALREADY_SIGNED = 0x013;
109 const EXCEPTION_UNEXPECTED_EMPTY_STRING = 0x014;
110 const EXCEPTION_PATH_NOT_FOUND = 0x015;
111 const EXCEPTION_INVALID_PATH_NAME = 0x016;
112 const EXCEPTION_READ_PROTECED_PATH = 0x017;
113 const EXCEPTION_WRITE_PROTECED_PATH = 0x018;
114 const EXCEPTION_DIR_POINTER_INVALID = 0x019;
115 const EXCEPTION_FILE_POINTER_INVALID = 0x01a;
116 const EXCEPTION_INVALID_DIRECTORY_POINTER = 0x01b;
117 const EXCEPTION_UNEXPECTED_OBJECT = 0x01c;
118 const EXCEPTION_LIMIT_ELEMENT_IS_UNSUPPORTED = 0x01d;
119 const EXCEPTION_GETTER_IS_MISSING = 0x01e;
120 const EXCEPTION_ARRAY_EXPECTED = 0x01f;
121 const EXCEPTION_ARRAY_HAS_INVALID_COUNT = 0x020;
122 const EXCEPTION_ID_IS_INVALID_FORMAT = 0x021;
123 const EXCEPTION_MD5_CHECKSUMS_MISMATCH = 0x022;
124 const EXCEPTION_UNEXPECTED_STRING_SIZE = 0x023;
125 const EXCEPTION_SIMULATOR_ID_INVALID = 0x024;
126 const EXCEPTION_MISMATCHING_COMPRESSORS = 0x025;
127 const EXCEPTION_CONTAINER_ITEM_IS_NULL = 0x026;
128 const EXCEPTION_ITEM_IS_NO_ARRAY = 0x027;
129 const EXCEPTION_CONTAINER_MAYBE_DAMAGED = 0x028;
130 const EXCEPTION_INVALID_STRING = 0x029;
131 const EXCEPTION_VARIABLE_NOT_SET = 0x02a;
132 const EXCEPTION_ATTRIBUTES_ARE_MISSING = 0x02b;
133 const EXCEPTION_ARRAY_ELEMENTS_MISSING = 0x02c;
134 const EXCEPTION_TEMPLATE_ENGINE_UNSUPPORTED = 0x02d;
135 const EXCEPTION_MISSING_LANGUAGE_HANDLER = 0x02e;
136 const EXCEPTION_MISSING_FILE_IO_HANDLER = 0x02f;
137 const EXCEPTION_MISSING_ELEMENT = 0x030;
138 const EXCEPTION_HEADERS_ALREADY_SENT = 0x031;
139 const EXCEPTION_DEFAUL_CONTROLLER_GONE = 0x032;
140 const EXCEPTION_CLASS_NOT_FOUND = 0x033;
141 const EXCEPTION_REQUIRED_INTERFACE_MISSING = 0x034;
142 const EXCEPTION_FATAL_ERROR = 0x035;
143 const EXCEPTION_FILE_NOT_FOUND = 0x036;
146 * In the super constructor these system classes shall be ignored or else
147 * we would get an endless calling loop.
149 *--------------------------------------------------------------------*
150 * ATTENTION: IF YOU REMOVE ONE OF THEM YOU WILL SHOOT YOUR SERVER!!! *
151 *--------------------------------------------------------------------*
153 private $systemClasses = array(
154 "DebugMiddleware", // Debug middleware output sub-system
155 "Registry", // Object registry
156 "ObjectFactory", // Object factory
157 "DebugWebOutput", // Debug web output sub-system
158 "WebOutput", // Web output sub-system
159 "CompressorChannel", // Compressor sub-system
160 "DebugConsoleOutput", // Debug console output sub-system
161 "DebugErrorLogOutput", // Debug error_log() output sub-system
162 "FrameworkDirectoryPointer", // Directory handler sub-system
163 "NullCompressor", // Null compressor
164 "Bzip2Compressor", // BZIP2 compressor
165 "GzipCompressor", // GZIP compressor
172 * Private super constructor
176 protected function __construct ($class) {
178 $this->setRealClass($class);
180 // Initialize the class if the registry is there
181 if ((class_exists('Registry')) && (Registry::isInitialized() === false)) {
182 $this->initInstance();
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
223 $argsString = "NULL";
224 } elseif (is_array($args)) {
225 // Some arguments are there
226 foreach ($args as $arg) {
230 if ($arg) $argsString .= "true(bool)"; else $argsString .= "false(bool)";
231 } elseif (is_int($arg)) {
233 $argsString .= $arg."(int)";
234 } elseif (is_float($arg)) {
236 $argsString .= $arg."(float)";
237 } elseif ($arg instanceof BaseFrameworkSystem) {
238 // Own object instance
239 $argsString .= $arg->__toString()."(Object)";
240 } elseif (is_object($arg)) {
242 $argsString .= "unknown object(!)";
243 } elseif (is_array($arg)) {
245 $argsString .= "Array(array)";
246 } elseif (is_string($arg)) {
248 $argsString .= "\"".$arg."\"(string)";
249 } elseif (is_null($arg)) {
251 $argsString .= "(null)";
253 // Unknown type (please report!)
254 $argsString .= $arg."(unknown!)";
262 if (substr($argsString, -2, 1) === ",") $argsString = substr($argsString, 0, -2);
264 // Invalid arguments!
265 $argsString = sprintf("!INVALID:%s!", $args);
268 $this->getDebugInstance()->output(sprintf("[%s::%s] Stub! Args: %s",
279 * Private initializer for this class
283 private final function initInstance () {
284 // Is this a system class?
285 if (!in_array($this->__toString(), $this->systemClasses)) {
286 // Add application helper to our class
287 $this->systemclasses[] = $this->getConfigInstance()->readConfig('app_helper_class');
289 // Set debug instance
290 $this->setDebugInstance(DebugMiddleware::createDebugMiddleware($this->getConfigInstance()->readConfig('debug_class')));
292 // Get output instance and set it
293 $outputInstance = ObjectFactory::createObjectByConfiguredName('web_engine', array($this->getConfigInstance()->readConfig('web_content_type')));
294 $this->setWebOutputInstance($outputInstance);
296 // Set the compressor channel
297 $this->setCompressorChannel(CompressorChannel::createCompressorChannel(sprintf("%s%s",
299 $this->getConfigInstance()->readConfig('compressor_base_path')
302 // Initialization done! :D
303 Registry::isInitialized("OK");
304 } elseif ($this->__toString() == "DebugMiddleware") {
305 // Set configuration instance
306 $this->setConfigInstance(FrameworkConfiguration::createFrameworkConfiguration());
311 * Setter for language instance
313 * @param $configInstance The configuration instance which shall
314 * be FrameworkConfiguration
317 public final function setConfigInstance (FrameworkConfiguration $configInstance) {
318 Registry::getRegistry()->addInstance('config', $configInstance);
322 * Getter for configuration instance
324 * @return $cfhInstance - Configuration instance
326 protected final function getConfigInstance () {
327 return Registry::getRegistry()->getInstance('config');
331 * Setter for debug instance
333 * @param $debugInstance The instance for debug output class
336 public final function setDebugInstance (DebugMiddleware $debugInstance) {
337 Registry::getRegistry()->addInstance('debug', $debugInstance);
341 * Getter for debug instance
343 * @return $debug - Instance to class DebugConsoleOutput or DebugWebOutput
345 public final function getDebugInstance () {
346 return Registry::getRegistry()->getInstance('debug');
350 * Setter for web output instance
352 * @param $webInstance The instance for web output class
355 public final function setWebOutputInstance (OutputStreamer $webInstance) {
356 Registry::getRegistry()->addInstance('web_output', $webInstance);
360 * Getter for web output instance
362 * @return $webOutput - Instance to class WebOutput
364 public final function getWebOutputInstance () {
365 return Registry::getRegistry()->getInstance('web_output');
369 * Setter for database instance
371 * @param $dbInstance The instance for the database connection
372 * (forced DatabaseConnection)
375 public final function setDatabaseInstance (DatabaseConnection $dbInstance) {
376 Registry::getRegistry()->addInstance('dbInstance', $dbInstance);
380 * Getter for database layer
382 * @return $dbInstance The database layer instance
384 public final function getDatabaseInstance () {
385 if ((class_exists('Registry')) && (Registry::isInitialized() === true)) {
386 return Registry::getRegistry()->getInstance('dbInstance');
393 * Setter for compressor channel
395 * @param $compressorChannel An instance of CompressorChannel
398 public final function setCompressorChannel (CompressorChannel $compressorChannel) {
399 Registry::getRegistry()->addInstance('compressor', $compressorChannel);
403 * Getter for compressor channel
405 * @return $compressor The compressor channel
407 public final function getCompressorChannel () {
408 return Registry::getRegistry()->getInstance('compressor');
412 * Protected getter for a manageable application helper class
414 * @return $applicationInstance An instance of a manageable application helper class
416 protected final function getApplicationInstance () {
417 return self::$applicationInstance;
421 * Setter for a manageable application helper class
423 * @param $applicationInstance An instance of a manageable application helper class
426 public final function setApplicationInstance (ManageableApplication $applicationInstance) {
427 self::$applicationInstance = $applicationInstance;
431 * Setter for request instance
433 * @param $requestInstance An instance of a Requestable class
436 public final function setRequestInstance (Requestable $requestInstance) {
437 $this->requestInstance = $requestInstance;
441 * Getter for request instance
443 * @return $requestInstance An instance of a Requestable class
445 public final function getRequestInstance () {
446 return $this->requestInstance;
450 * Setter for response instance
452 * @param $responseInstance An instance of a Responseable class
455 public final function setResponseInstance (Responseable $responseInstance) {
456 $this->responseInstance = $responseInstance;
460 * Getter for response instance
462 * @return $responseInstance An instance of a Responseable class
464 public final function getResponseInstance () {
465 return $this->responseInstance;
469 * Getter for $realClass
471 * @return $realClass The name of the real class (not BaseFrameworkSystem)
473 public final function __toString () {
474 return $this->realClass;
478 * Setter for the real class name
480 * @param $realClass Class name (string)
483 public final function setRealClass ($realClass) {
485 $realClass = (string) $realClass;
488 $this->realClass = $realClass;
492 * Generate unique ID from a lot entropy
496 public final function generateUniqueId () {
497 // Is the id set for this class?
498 if (empty($this->uniqueID)) {
500 // Correct missing class name
502 if ($this->__toString() == "") {
503 $this->setRealClass(__CLASS__);
507 // Cache datbase instance
508 $db = $this->getDatabaseInstance();
513 // Generate a unique ID number
514 $tempID = $this->generateIdNumber();
517 // Try to figure out if the ID number is not yet used
519 // Is this a registry?
520 if ($this->__toString() == "Registry") {
521 // Registry, then abort here
523 } elseif (is_object($db)) {
524 $isUsed = $db->isUniqueIdUsed($tempID, true);
526 } catch (FrameworkException $e) {
527 // Catches all and ignores all ;-)
551 $this->setUniqueID($tempID);
553 // Revert maybe corrected class name
555 $this->setRealClass("");
558 // Remove system classes if we are in a system class
559 if ((isset($this->systemClasses)) && (in_array($this->__toString(), $this->systemClasses))) {
560 // This may save some RAM...
561 $this->removeSystemArray();
567 * Generates a new ID number for classes based from the class' real name,
568 * the description and some random data
570 * @return $tempID The new (temporary) ID number
572 private final function generateIdNumber () {
573 return sprintf("%s@%s",
575 md5(sprintf("%s:%s:%s:%s:%s:%s",
577 $this->getObjectDescription(),
579 getenv('REMOTE_ADDR'),
580 getenv('SERVER_ADDR'),
587 * Setter for unique ID
589 * @param $uniqueID The newly generated unique ID number
592 private final function setUniqueID ($uniqueID) {
594 $uniqueID = (string) $uniqueID;
597 $this->uniqueID = $uniqueID;
601 * Getter for unique ID
603 * @return $uniqueID The unique ID of this class
605 public final function getUniqueID () {
606 return $this->uniqueID;
610 * Resets or recreates the unique ID number
614 public final function resetUniqueID() {
615 // Sweet and simple... ;-)
616 $newUniqueID = $this->generateIdNumber();
617 $this->setUniqueID($newUniqueID);
621 * Getter for simulator description
623 * @return $objectDescription The description of this simulation part
625 public final function getObjectDescription () {
626 if (isset($this->objectDescription)) {
627 return $this->objectDescription;
634 * Setter for simulation part description
636 * @param $objectDescription The description as string for this simulation part
639 public final function setObjectDescription ($objectDescription) {
640 $this->objectDescription = (String) $objectDescription;
644 * Validate if given object is the same as current
646 * @param $object An object instance for comparison with this class
647 * @return boolean The result of comparing both's unique ID
649 public final function equals ($object) {
650 return ($this->getUniqueID() == $object->getUniqueID());
654 * Compare if both simulation part description and class name matches
657 * @param $itemInstance An object instance to an other class
658 * @return boolean The result of comparing class name simulation part description
660 public function itemMatches ($itemInstance) {
663 $this->__toString() == $itemInstance->__toString()
665 $this->getObjectDescription() == $itemInstance->getObjectDescription()
671 * Compare class name of this and given class name
673 * @param $class The class name as string from the other class
674 * @return boolean The result of comparing both class names
676 public final function isClass ($class) {
677 return ($this->__toString() == $class);
681 * Stub method (only real cabins shall override it)
683 * @return boolean false = is no cabin, true = is a cabin
685 public function isCabin () {
690 * Stub method for tradeable objects
692 * @return boolean false = is not tradeable by the Merchant class,
693 * true = is a tradeable object
695 public function isTradeable () {
700 * Formats computer generated price values into human-understandable formats
701 * with thousand and decimal seperators.
703 * @param $value The in computer format value for a price
704 * @param $currency The currency symbol (use HTML-valid characters!)
705 * @param $decNum Number of decimals after commata
706 * @return $price The for the current language formated price string
707 * @throws MissingDecimalsThousandsSeperatorException If decimals or
708 * thousands seperator
711 public function formatCurrency ($value, $currency = "€", $decNum = 2) {
712 // Are all required attriutes set?
713 if ((!isset($this->decimals)) || (!isset($this->thousands))) {
714 // Throw an exception
715 throw new MissingDecimalsThousandsSeperatorException($this, self::EXCEPTION_ATTRIBUTES_ARE_MISSING);
719 $value = (float) $value;
721 // Reformat the US number
722 $price = sprintf("%s %s",
723 number_format($value, $decNum, $this->decimals, $this->thousands),
727 // Return as string...
732 * Removes number formating characters
736 public final function removeNumberFormaters () {
737 unset($this->thousands);
738 unset($this->decimals);
742 * Private getter for language instance
744 * @return $langInstance An instance to the language sub-system
746 protected final function getLanguageInstance () {
747 return self::$langInstance;
751 * Setter for language instance
753 * @param $langInstance An instance to the language sub-system
755 * @see LanguageSystem
757 public final function setLanguageInstance (ManageableLanguage $langInstance) {
758 self::$langInstance = $langInstance;
762 * Remove the $systemClasses array from memory
766 public final function removeSystemArray () {
767 unset($this->systemClasses);
771 * Create a file name and path name from the object's unique ID number.
772 * The left part of the ID shall always be a valid class name and the
773 * right part an ID number.
775 * @return $pfn The file name with a prepended path name
776 * @throws NoArrayCreatedException If explode() fails to create an array
777 * @throws InvalidArrayCountException If the array contains less or
778 * more than two elements
780 public final function getPathFileNameFromObject () {
781 // Get the main object's unique ID. We use this as a path/filename combination
782 $pathFile = $this->getUniqueID();
784 // Split it up in path and file name
785 $pathFile = explode("@", $pathFile);
787 // Are there two elements? Index 0 is the path, 1 the file name + global extension
788 if (!is_array($pathFile)) {
790 throw new NoArrayCreatedException(array($this, "pathFile"), self::EXCEPTION_ARRAY_EXPECTED);
791 } elseif (count($pathFile) != 2) {
792 // Invalid ID returned!
793 throw new InvalidArrayCountException(array($this, "pathFile", count($pathFile), 2), self::EXCEPTION_ARRAY_HAS_INVALID_COUNT);
796 // Auto-append missing trailing slash
797 $pathFile[0] = $this->addMissingTrailingSlash($pathFile[0]);
799 // Create the file name and return it
800 $pfn = ($pathFile[0] . $pathFile[1]);
805 * Appends a trailing slash to a string
807 * @param $str A string (maybe) without trailing slash
808 * @return $str A string with an auto-appended trailing slash
810 public final function addMissingTrailingSlash ($str) {
811 // Is there a trailing slash?
812 if (substr($str, -1, 1) != "/") $str .= "/";
817 * Private getter for file IO instance
819 * @return $fileIoInstance An instance to the file I/O sub-system
821 protected final function getFileIoInstance () {
822 return $this->fileIoInstance;
826 * Setter for file I/O instance
828 * @param $fileIoInstance An instance to the file I/O sub-system
831 public final function setFileIoInstance (FileIoHandler $fileIoInstance) {
832 $this->fileIoInstance = $fileIoInstance;
836 * Prepare the template engine (TemplateEngine by default) for a given
837 * application helper instance (ApplicationHelper by default).
839 * @param $appInstance An application helper instance or
840 * null if we shall use the default
841 * @return $tplEngine The template engine instance
842 * @throws NullPointerException If the template engine could not
844 * @throws UnsupportedTemplateEngineException If $tplEngine is an
845 * unsupported template engine
846 * @throws MissingLanguageHandlerException If the language sub-system
847 * is not yet initialized
848 * @throws NullPointerException If the discovered application
849 * instance is still null
851 protected function prepareTemplateEngine (BaseFrameworkSystem $appInstance=null) {
852 // Is the application instance set?
853 if (is_null($appInstance)) {
854 // Get the current instance
855 $appInstance = $this->getApplicationInstance();
858 if (is_null($appInstance)) {
859 // Thrown an exception
860 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
864 // Generate FQFN for all application templates
865 $fqfn = sprintf("%s%s/%s/%s",
867 $this->getConfigInstance()->readConfig('application_path'),
868 strtolower($appInstance->getAppShortName()),
869 $this->getConfigInstance()->readConfig('tpl_base_path')
872 // Are both instances set?
873 if ($appInstance->getLanguageInstance() === null) {
874 // Invalid language instance
875 throw new MissingLanguageHandlerException($appInstance, self::EXCEPTION_MISSING_LANGUAGE_HANDLER);
876 } elseif ($appInstance->getFileIoInstance() === null) {
877 // Invalid language instance
878 throw new MissingFileIoHandlerException($appInstance, self::EXCEPTION_MISSING_FILE_IO_HANDLER);
881 // Initialize the template engine
882 $tplEngine = ObjectFactory::createObjectByConfiguredName('template_class', array($fqfn, $appInstance->getLanguageInstance(), $appInstance->getFileIoInstance()));
884 // Return the prepared instance
889 * Debugs this instance by putting out it's full content
893 public final function debugInstance () {
894 // Generate the output
895 $content = sprintf("<pre>%s</pre>",
896 trim(print_r($this, true))
900 ApplicationEntryPoint::app_die(sprintf("<strong>%s debug output:</strong><div id=\"debug_content\">%s</div>Loaded includes: <div id=\"debug_include_list\">%s</div>",
903 ClassLoader::getInstance()->getPrintableIncludeList()
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: <span id=\"stub_message\">%s</span>", $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) {
954 // Convert all dashes in underscores
955 $str = str_replace("-", "_", $str);
957 // Now use that underscores to get classname parts for hungarian style
958 foreach (explode("_", $str) as $strPart) {
959 // Make the class name part lower case and first upper case
960 $className .= ucfirst(strtolower($strPart));
968 * Outputs a debug backtrace and stops further script execution
972 public function debugBacktrace () {
973 // Sorry, there is no other way getting this nice backtrace
975 debug_print_backtrace();
981 * Setter for search instance
983 * @param $searchInstance Searchable criteria instance
986 public final function setSearchInstance (LocalSearchCriteria $searchInstance) {
987 $this->searchInstance = $searchInstance;
991 * Getter for search instance
993 * @return $searchInstance Searchable criteria instance
995 public final function getSearchInstance () {
996 return $this->searchInstance;
1000 * Setter for resolver instance
1002 * @param $resolverInstance Instance of a command resolver class
1005 public final function setResolverInstance (Resolver $resolverInstance) {
1006 $this->resolverInstance = $resolverInstance;
1010 * Getter for resolver instance
1012 * @return $resolverInstance Instance of a command resolver class
1014 public final function getResolverInstance () {
1015 return $this->resolverInstance;