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;
54 private $realClass = "FrameworkSystem";
57 * A human-readable description for this simulator part
59 private $objectDescription = "Namenlose Framework-Einheit";
62 * The unique ID string for identifying all type of classes
64 private $uniqueID = "";
69 private $thousands = "."; // German
74 private $decimals = ","; // German
77 * The file I/O instance for the template loader
79 private $fileIoInstance = null;
81 /***********************
82 * Exception codes.... *
83 ***********************/
85 const EXCEPTION_IS_NULL_POINTER = 0x001;
86 const EXCEPTION_IS_NO_OBJECT = 0x002;
87 const EXCEPTION_IS_NO_ARRAY = 0x003;
88 const EXCEPTION_MISSING_METHOD = 0x004;
89 const EXCEPTION_CLASSES_NOT_MATCHING = 0x005;
90 const EXCEPTION_INDEX_OUT_OF_BOUNDS = 0x006;
91 const EXCEPTION_DIMENSION_ARRAY_INVALID = 0x007;
92 const EXCEPTION_ITEM_NOT_TRADEABLE = 0x008;
93 const EXCEPTION_ITEM_NOT_IN_PRICE_LIST = 0x009;
94 const EXCEPTION_GENDER_IS_WRONG = 0x00a;
95 const EXCEPTION_BIRTH_DATE_IS_INVALID = 0x00b;
96 const EXCEPTION_EMPTY_STRUCTURES_ARRAY = 0x00c;
97 const EXCEPTION_HAS_ALREADY_PERSONELL_LIST = 0x00d;
98 const EXCEPTION_NOT_ENOUGTH_UNEMPLOYEES = 0x00e;
99 const EXCEPTION_TOTAL_PRICE_NOT_CALCULATED = 0x00f;
100 const EXCEPTION_HARBOR_HAS_NO_SHIPYARDS = 0x010;
101 const EXCEPTION_CONTRACT_PARTNER_INVALID = 0x011;
102 const EXCEPTION_CONTRACT_PARTNER_MISMATCH = 0x012;
103 const EXCEPTION_CONTRACT_ALREADY_SIGNED = 0x013;
104 const EXCEPTION_UNEXPECTED_EMPTY_STRING = 0x014;
105 const EXCEPTION_PATH_NOT_FOUND = 0x015;
106 const EXCEPTION_INVALID_PATH_NAME = 0x016;
107 const EXCEPTION_READ_PROTECED_PATH = 0x017;
108 const EXCEPTION_WRITE_PROTECED_PATH = 0x018;
109 const EXCEPTION_DIR_POINTER_INVALID = 0x019;
110 const EXCEPTION_FILE_POINTER_INVALID = 0x01a;
111 const EXCEPTION_INVALID_DIRECTORY_POINTER = 0x01b;
112 const EXCEPTION_UNEXPECTED_OBJECT = 0x01c;
113 const EXCEPTION_LIMIT_ELEMENT_IS_UNSUPPORTED = 0x01d;
114 const EXCEPTION_GETTER_IS_MISSING = 0x01e;
115 const EXCEPTION_ARRAY_EXPECTED = 0x01f;
116 const EXCEPTION_ARRAY_HAS_INVALID_COUNT = 0x020;
117 const EXCEPTION_ID_IS_INVALID_FORMAT = 0x021;
118 const EXCEPTION_MD5_CHECKSUMS_MISMATCH = 0x022;
119 const EXCEPTION_UNEXPECTED_STRING_SIZE = 0x023;
120 const EXCEPTION_SIMULATOR_ID_INVALID = 0x024;
121 const EXCEPTION_MISMATCHING_COMPRESSORS = 0x025;
122 const EXCEPTION_CONTAINER_ITEM_IS_NULL = 0x026;
123 const EXCEPTION_ITEM_IS_NO_ARRAY = 0x027;
124 const EXCEPTION_CONTAINER_MAYBE_DAMAGED = 0x028;
125 const EXCEPTION_INVALID_STRING = 0x029;
126 const EXCEPTION_VARIABLE_NOT_SET = 0x02a;
127 const EXCEPTION_ATTRIBUTES_ARE_MISSING = 0x02b;
128 const EXCEPTION_ARRAY_ELEMENTS_MISSING = 0x02c;
129 const EXCEPTION_TEMPLATE_ENGINE_UNSUPPORTED = 0x02d;
130 const EXCEPTION_MISSING_LANGUAGE_HANDLER = 0x02e;
131 const EXCEPTION_MISSING_FILE_IO_HANDLER = 0x02f;
132 const EXCEPTION_MISSING_ELEMENT = 0x030;
133 const EXCEPTION_INVALID_COMMAND = 0x031;
134 const EXCEPTION_INVALID_CONTROLLER = 0x032;
135 const EXCEPTION_HEADERS_ALREADY_SENT = 0x033;
136 const EXCEPTION_DEFAUL_CONTROLLER_GONE = 0x034;
137 const EXCEPTION_CLASS_NOT_FOUND = 0x035;
138 const EXCEPTION_REQUIRED_INTERFACE_MISSING = 0x036;
141 * In the super constructor these system classes shall be ignored or else
142 * we would get an endless calling loop.
144 *--------------------------------------------------------------------*
145 * ATTENTION: IF YOU REMOVE ONE OF THEM YOU WILL SHOOT YOUR SERVER!!! *
146 *--------------------------------------------------------------------*
148 private $systemClasses = array(
149 "DebugMiddleware", // Debug middleware output sub-system
150 "Registry", // Object registry
151 "ObjectFactory", // Object factory
152 "DebugWebOutput", // Debug web output sub-system
153 "WebOutput", // Web output sub-system
154 "CompressorChannel", // Compressor sub-system
155 "DebugConsoleOutput", // Debug console output sub-system
156 "DebugErrorLogOutput", // Debug error_log() output sub-system
157 "FrameworkDirectoryPointer", // Directory handler sub-system
158 "NullCompressor", // Null compressor
159 "Bzip2Compressor", // BZIP2 compressor
160 "GzipCompressor", // GZIP compressor
167 * Private super constructor
171 protected function __construct ($class) {
173 $this->setRealClass($class);
175 // Initialize the class if the registry is there
176 if ((class_exists('Registry')) && (Registry::isInitialized() === false)) {
177 $this->initInstance();
182 * Destructor reached...
186 public function __destruct() {
187 // Is this object already destroyed?
188 if ($this->__toString() != "DestructedObject") {
190 if ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
191 $this->getDebugInstance()->output(sprintf("[%s:] Das Objekt <strong>%s</strong> wird zerstört.<br />\n",
192 __CLASS__, $this->__toString()
196 // Destroy all informations about this class but keep some text about it alive
197 $this->setObjectDescription(sprintf("Entferntes Objekt <em>%s</em>", $this->__toString()));
198 $this->setRealClass("DestructedObject");
199 $this->resetUniqueID();
200 } elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
201 // Already destructed object
202 $this->getDebugInstance()->output(sprintf("[%s:] Das Objekt <strong>%s</strong> wurde bereits zerstört.<br />\n",
203 __CLASS__, $this->__toString()
209 * The call method where all non-implemented methods end up
213 public final function __call ($methodName, $args) {
214 // Implode all given arguments
218 $argsString = "NULL";
219 } elseif (is_array($args)) {
220 // Some arguments are there
221 foreach ($args as $arg) {
225 if ($arg) $argsString .= "true(bool)"; else $argsString .= "false(bool)";
226 } elseif (is_int($arg)) {
228 $argsString .= $arg."(int)";
229 } elseif (is_float($arg)) {
231 $argsString .= $arg."(float)";
232 } elseif ($arg instanceof BaseFrameworkSystem) {
233 // Own object instance
234 $argsString .= $arg->__toString()."(Object)";
235 } elseif (is_object($arg)) {
237 $argsString .= "unknown object(!)";
238 } elseif (is_array($arg)) {
240 $argsString .= "Array(array)";
241 } elseif (is_string($arg)) {
243 $argsString .= "\"".$arg."\"(string)";
244 } elseif (is_null($arg)) {
246 $argsString .= "(null)";
248 // Unknown type (please report!)
249 $argsString .= $arg."(unknown!)";
257 if (substr($argsString, -2, 1) === ",") $argsString = substr($argsString, 0, -2);
259 // Invalid arguments!
260 $argsString = sprintf("!INVALID:%s!", $args);
263 $this->getDebugInstance()->output(sprintf("[%s::%s] Stub! Args: %s",
274 * Private initializer for this class
278 private final function initInstance () {
279 // Is this a system class?
280 if (!in_array($this->__toString(), $this->systemClasses)) {
281 // Add application helper to our class
282 $this->systemclasses[] = $this->getConfigInstance()->readConfig('app_helper_class');
284 // Set debug instance
285 $this->setDebugInstance(DebugMiddleware::createDebugMiddleware($this->getConfigInstance()->readConfig('debug_class')));
287 // Get output instance and set it
288 $outputInstance = ObjectFactory::createObjectByConfiguredName('web_engine', array($this->getConfigInstance()->readConfig('web_content_type')));
289 $this->setWebOutputInstance($outputInstance);
291 // Set the compressor channel
292 $this->setCompressorChannel(CompressorChannel::createCompressorChannel(sprintf("%s%s",
294 $this->getConfigInstance()->readConfig('compressor_base_path')
297 // Initialization done! :D
298 Registry::isInitialized("OK");
299 } elseif ($this->__toString() == "DebugMiddleware") {
300 // Set configuration instance
301 $this->setConfigInstance(FrameworkConfiguration::createFrameworkConfiguration());
306 * Setter for language instance
308 * @param $configInstance The configuration instance which shall
309 * be FrameworkConfiguration
312 public final function setConfigInstance (FrameworkConfiguration $configInstance) {
313 Registry::getRegistry()->addInstance('config', $configInstance);
317 * Getter for configuration instance
319 * @return $cfhInstance - Configuration instance
321 protected final function getConfigInstance () {
322 return Registry::getRegistry()->getInstance('config');
326 * Setter for debug instance
328 * @param $debugInstance The instance for debug output class
331 public final function setDebugInstance (DebugMiddleware $debugInstance) {
332 Registry::getRegistry()->addInstance('debug', $debugInstance);
336 * Getter for debug instance
338 * @return $debug - Instance to class DebugConsoleOutput or DebugWebOutput
340 public final function getDebugInstance () {
341 return Registry::getRegistry()->getInstance('debug');
345 * Setter for web output instance
347 * @param $webInstance The instance for web output class
350 public final function setWebOutputInstance (OutputStreamer $webInstance) {
351 Registry::getRegistry()->addInstance('web_output', $webInstance);
355 * Getter for web output instance
357 * @return $webOutput - Instance to class WebOutput
359 public final function getWebOutputInstance () {
360 return Registry::getRegistry()->getInstance('web_output');
364 * Setter for database instance
366 * @param $dbInstance The instance for the database connection
367 * (forced DatabaseConnection)
370 public final function setDatabaseInstance (DatabaseConnection $dbInstance) {
371 Registry::getRegistry()->addInstance('dbInstance', $dbInstance);
375 * Getter for database layer
377 * @return $dbInstance The database layer instance
379 public final function getDatabaseInstance () {
380 if ((class_exists('Registry')) && (Registry::isInitialized() === true)) {
381 return Registry::getRegistry()->getInstance('dbInstance');
388 * Setter for compressor channel
390 * @param $compressorChannel An instance of CompressorChannel
393 public final function setCompressorChannel (CompressorChannel $compressorChannel) {
394 Registry::getRegistry()->addInstance('compressor', $compressorChannel);
398 * Getter for compressor channel
400 * @return $compressor The compressor channel
402 public final function getCompressorChannel () {
403 return Registry::getRegistry()->getInstance('compressor');
407 * Protected getter for a manageable application helper class
409 * @return $applicationInstance An instance of a manageable application helper class
411 protected final function getApplicationInstance () {
412 return self::$applicationInstance;
416 * Setter for a manageable application helper class
418 * @param $applicationInstance An instance of a manageable application helper class
421 public final function setApplicationInstance (ManageableApplication $applicationInstance) {
422 self::$applicationInstance = $applicationInstance;
426 * Setter for request instance
428 * @param $requestInstance An instance of a Requestable class
431 public final function setRequestInstance (Requestable $requestInstance) {
432 $this->requestInstance = $requestInstance;
436 * Getter for request instance
438 * @return $requestInstance An instance of a Requestable class
440 public final function getRequestInstance () {
441 return $this->requestInstance;
445 * Setter for response instance
447 * @param $responseInstance An instance of a Responseable class
450 public final function setResponseInstance (Responseable $responseInstance) {
451 $this->responseInstance = $responseInstance;
455 * Getter for response instance
457 * @return $responseInstance An instance of a Responseable class
459 public final function getResponseInstance () {
460 return $this->responseInstance;
464 * Getter for $realClass
466 * @return $realClass The name of the real class (not BaseFrameworkSystem)
468 public final function __toString () {
469 return $this->realClass;
473 * Setter for the real class name
475 * @param $realClass Class name (string)
478 public final function setRealClass ($realClass) {
480 $realClass = (string) $realClass;
483 $this->realClass = $realClass;
487 * Generate unique ID from a lot entropy
491 public final function generateUniqueId () {
492 // Is the id set for this class?
493 if (empty($this->uniqueID)) {
495 // Correct missing class name
497 if ($this->__toString() == "") {
498 $this->setRealClass(__CLASS__);
502 // Cache datbase instance
503 $db = $this->getDatabaseInstance();
508 // Generate a unique ID number
509 $tempID = $this->generateIdNumber();
512 // Try to figure out if the ID number is not yet used
514 // Is this a registry?
515 if ($this->__toString() == "Registry") {
516 // Registry, then abort here
518 } elseif (is_object($db)) {
519 $isUsed = $db->isUniqueIdUsed($tempID, true);
521 } catch (FrameworkException $e) {
522 // Catches all and ignores all ;-)
546 $this->setUniqueID($tempID);
548 // Revert maybe corrected class name
550 $this->setRealClass("");
553 // Remove system classes if we are in a system class
554 if ((isset($this->systemClasses)) && (in_array($this->__toString(), $this->systemClasses))) {
555 // This may save some RAM...
556 $this->removeSystemArray();
562 * Generates a new ID number for classes based from the class' real name,
563 * the description and some random data
565 * @return $tempID The new (temporary) ID number
567 private final function generateIdNumber () {
568 return sprintf("%s@%s",
570 md5(sprintf("%s:%s:%s:%s:%s:%s",
572 $this->getObjectDescription(),
574 getenv('REMOTE_ADDR'),
575 getenv('SERVER_ADDR'),
582 * Setter for unique ID
584 * @param $uniqueID The newly generated unique ID number
587 private final function setUniqueID ($uniqueID) {
589 $uniqueID = (string) $uniqueID;
592 $this->uniqueID = $uniqueID;
596 * Getter for unique ID
598 * @return $uniqueID The unique ID of this class
600 public final function getUniqueID () {
601 return $this->uniqueID;
605 * Resets or recreates the unique ID number
609 public final function resetUniqueID() {
610 // Sweet and simple... ;-)
611 $newUniqueID = $this->generateIdNumber();
612 $this->setUniqueID($newUniqueID);
616 * Getter for simulator description
618 * @return $objectDescription The description of this simulation part
620 public final function getObjectDescription () {
621 if (isset($this->objectDescription)) {
622 return $this->objectDescription;
629 * Setter for simulation part description
631 * @param $objectDescription The description as string for this simulation part
634 public final function setObjectDescription ($objectDescription) {
635 $this->objectDescription = (String) $objectDescription;
639 * Validate if given object is the same as current
641 * @param $object An object instance for comparison with this class
642 * @return boolean The result of comparing both's unique ID
644 public final function equals ($object) {
645 return ($this->getUniqueID() == $object->getUniqueID());
649 * Compare if both simulation part description and class name matches
652 * @param $itemInstance An object instance to an other class
653 * @return boolean The result of comparing class name simulation part description
655 public function itemMatches ($itemInstance) {
658 $this->__toString() == $itemInstance->__toString()
660 $this->getObjectDescription() == $itemInstance->getObjectDescription()
666 * Compare class name of this and given class name
668 * @param $class The class name as string from the other class
669 * @return boolean The result of comparing both class names
671 public final function isClass ($class) {
672 return ($this->__toString() == $class);
676 * Stub method (only real cabins shall override it)
678 * @return boolean false = is no cabin, true = is a cabin
680 public function isCabin () {
685 * Stub method for tradeable objects
687 * @return boolean false = is not tradeable by the Merchant class,
688 * true = is a tradeable object
690 public function isTradeable () {
695 * Formats computer generated price values into human-understandable formats
696 * with thousand and decimal seperators.
698 * @param $value The in computer format value for a price
699 * @param $currency The currency symbol (use HTML-valid characters!)
700 * @param $decNum Number of decimals after commata
701 * @return $price The for the current language formated price string
702 * @throws MissingDecimalsThousandsSeperatorException If decimals or
703 * thousands seperator
706 public function formatCurrency ($value, $currency = "€", $decNum = 2) {
707 // Are all required attriutes set?
708 if ((!isset($this->decimals)) || (!isset($this->thousands))) {
709 // Throw an exception
710 throw new MissingDecimalsThousandsSeperatorException($this, self::EXCEPTION_ATTRIBUTES_ARE_MISSING);
714 $value = (float) $value;
716 // Reformat the US number
717 $price = sprintf("%s %s",
718 number_format($value, $decNum, $this->decimals, $this->thousands),
722 // Return as string...
727 * Removes number formating characters
731 public final function removeNumberFormaters () {
732 unset($this->thousands);
733 unset($this->decimals);
737 * Private getter for language instance
739 * @return $langInstance An instance to the language sub-system
741 protected final function getLanguageInstance () {
742 return self::$langInstance;
746 * Setter for language instance
748 * @param $langInstance An instance to the language sub-system
750 * @see LanguageSystem
752 public final function setLanguageInstance (ManageableLanguage $langInstance) {
753 self::$langInstance = $langInstance;
757 * Remove the $systemClasses array from memory
761 public final function removeSystemArray () {
762 unset($this->systemClasses);
766 * Create a file name and path name from the object's unique ID number.
767 * The left part of the ID shall always be a valid class name and the
768 * right part an ID number.
770 * @return $pfn The file name with a prepended path name
771 * @throws NoArrayCreatedException If explode() fails to create an array
772 * @throws InvalidArrayCountException If the array contains less or
773 * more than two elements
775 public final function getPathFileNameFromObject () {
776 // Get the main object's unique ID. We use this as a path/filename combination
777 $pathFile = $this->getUniqueID();
779 // Split it up in path and file name
780 $pathFile = explode("@", $pathFile);
782 // Are there two elements? Index 0 is the path, 1 the file name + global extension
783 if (!is_array($pathFile)) {
785 throw new NoArrayCreatedException(array($this, "pathFile"), self::EXCEPTION_ARRAY_EXPECTED);
786 } elseif (count($pathFile) != 2) {
787 // Invalid ID returned!
788 throw new InvalidArrayCountException(array($this, "pathFile", count($pathFile), 2), self::EXCEPTION_ARRAY_HAS_INVALID_COUNT);
791 // Auto-append missing trailing slash
792 $pathFile[0] = $this->addMissingTrailingSlash($pathFile[0]);
794 // Create the file name and return it
795 $pfn = ($pathFile[0] . $pathFile[1]);
800 * Appends a trailing slash to a string
802 * @param $str A string (maybe) without trailing slash
803 * @return $str A string with an auto-appended trailing slash
805 public final function addMissingTrailingSlash ($str) {
806 // Is there a trailing slash?
807 if (substr($str, -1, 1) != "/") $str .= "/";
812 * Private getter for file IO instance
814 * @return $fileIoInstance An instance to the file I/O sub-system
816 protected final function getFileIoInstance () {
817 return $this->fileIoInstance;
821 * Setter for file I/O instance
823 * @param $fileIoInstance An instance to the file I/O sub-system
826 public final function setFileIoInstance (FileIoHandler $fileIoInstance) {
827 $this->fileIoInstance = $fileIoInstance;
831 * Prepare the template engine (TemplateEngine by default) for a given
832 * application helper instance (ApplicationHelper by default).
834 * @param $appInstance An application helper instance or
835 * null if we shall use the default
836 * @return $tplEngine The template engine instance
837 * @throws NullPointerException If the template engine could not
839 * @throws UnsupportedTemplateEngineException If $tplEngine is an
840 * unsupported template engine
841 * @throws MissingLanguageHandlerException If the language sub-system
842 * is not yet initialized
843 * @throws NullPointerException If the discovered application
844 * instance is still null
846 protected function prepareTemplateEngine (BaseFrameworkSystem $appInstance=null) {
847 // Is the application instance set?
848 if (is_null($appInstance)) {
849 // Get the current instance
850 $appInstance = $this->getApplicationInstance();
853 if (is_null($appInstance)) {
854 // Thrown an exception
855 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
859 // Generate FQFN for all application templates
860 $fqfn = sprintf("%s%s/%s/%s",
862 $this->getConfigInstance()->readConfig('application_path'),
863 strtolower($appInstance->getAppShortName()),
864 $this->getConfigInstance()->readConfig('tpl_base_path')
867 // Are both instances set?
868 if ($appInstance->getLanguageInstance() === null) {
869 // Invalid language instance
870 throw new MissingLanguageHandlerException($appInstance, self::EXCEPTION_MISSING_LANGUAGE_HANDLER);
871 } elseif ($appInstance->getFileIoInstance() === null) {
872 // Invalid language instance
873 throw new MissingFileIoHandlerException($appInstance, self::EXCEPTION_MISSING_FILE_IO_HANDLER);
876 // Initialize the template engine
877 $tplEngine = ObjectFactory::createObjectByConfiguredName('template_class', array($fqfn, $appInstance->getLanguageInstance(), $appInstance->getFileIoInstance()));
879 // Return the prepared instance
884 * Debugs this instance by putting out it's full content
888 public final function debugInstance () {
889 // Generate the output
890 $content = sprintf("<pre>%s</pre>",
891 trim(print_r($this, true))
895 ApplicationEntryPoint::app_die(sprintf("<strong>%s debug output:</strong>%s", $this->__toString(), $content));
899 * Output a partial stub message for the caller method
901 * @param $message An optional message to display
904 protected function partialStub ($message = "") {
906 $backtrace = debug_backtrace();
908 // Generate the class::method string
909 $methodName = "UnknownClass::unknownMethod";
910 if ((isset($backtrace[1]['class'])) && (isset($backtrace[1]['function']))) {
911 $methodName = $backtrace[1]['class']."::".$backtrace[1]['function'];
914 // Construct the full message
915 $stubMessage = sprintf("[%s:] Partial stub!",
919 // Is the extra message given?
920 if (!empty($message)) {
921 // Then add it as well
922 $stubMessage .= sprintf(" Message: <u>%s</u>", $message);
925 // Debug instance is there?
926 if (!is_null($this->getDebugInstance())) {
927 // Output stub message
928 $this->getDebugInstance()->output($stubMessage);
931 trigger_error($stubMessage."<br />\n");
936 * Converts e.g. a command from URL to a valid class by keeping out bad characters
938 * @param $str The string, what ever it is needs to be converted
939 * @return $className Generated class name
941 public function convertToClassName ($str) {
945 // Convert all dashes in underscores
946 $str = str_replace("-", "_", $str);
948 // Now use that underscores to get classname parts for hungarian style
949 foreach (explode("_", $str) as $strPart) {
950 // Make the class name part lower case and first upper case
951 $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();
972 * Setter for search instance
974 * @param $searchInstance Searchable criteria instance
977 public final function setSearchInstance (LocalSearchCriteria $searchInstance) {
978 $this->searchInstance = $searchInstance;
982 * Getter for search instance
984 * @return $searchInstance Searchable criteria instance
986 public final function getSearchInstance () {
987 return $this->searchInstance;