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, 2009 - 2011 Core Developer Team
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 of a request class
29 private $requestInstance = null;
32 * Instance of a response class
34 private $responseInstance = null;
37 * Search criteria instance
39 private $searchInstance = null;
42 * Update criteria instance
44 private $updateInstance = null;
47 * The file I/O instance for the template loader
49 private $fileIoInstance = null;
54 private $resolverInstance = null;
57 * Template engine instance
59 private $templateInstance = null;
62 * Database result instance
64 private $resultInstance = null;
67 * Instance for user class
69 private $userInstance = null;
72 * A controller instance
74 private $controllerInstance = null;
79 private $rngInstance = null;
82 * Instance of a crypto helper
84 private $cryptoInstance = null;
87 * Instance of an Iterator class
89 private $iteratorInstance = null;
92 * Instance of the list
94 private $listInstance = null;
99 private $menuInstance = null;
102 * Instance of the image
104 private $imageInstance = null;
107 * Instance of the stacker
109 private $stackerInstance = null;
112 * A Compressor instance
114 private $compressorInstance = null;
117 * A Parseable instance
119 private $parserInstance = null;
122 * A ProtocolHandler instance
124 private $protocolInstance = null;
127 * A database wrapper instance
129 private $databaseInstance = null;
132 * A helper instance for the form
134 private $helperInstance = null;
137 * An instance of a source
139 private $sourceInstance = null;
142 * The real class name
144 private $realClass = 'BaseFrameworkSystem';
147 * Thousands seperator
149 private $thousands = '.'; // German
154 private $decimals = ','; // German
159 private $socketResource = false;
164 private $packageData = array();
166 /***********************
167 * Exception codes.... *
168 ***********************/
169 // @todo Try to clean these constants up
170 const EXCEPTION_IS_NULL_POINTER = 0x001;
171 const EXCEPTION_IS_NO_OBJECT = 0x002;
172 const EXCEPTION_IS_NO_ARRAY = 0x003;
173 const EXCEPTION_MISSING_METHOD = 0x004;
174 const EXCEPTION_CLASSES_NOT_MATCHING = 0x005;
175 const EXCEPTION_INDEX_OUT_OF_BOUNDS = 0x006;
176 const EXCEPTION_DIMENSION_ARRAY_INVALID = 0x007;
177 const EXCEPTION_ITEM_NOT_TRADEABLE = 0x008;
178 const EXCEPTION_ITEM_NOT_IN_PRICE_LIST = 0x009;
179 const EXCEPTION_GENDER_IS_WRONG = 0x00a;
180 const EXCEPTION_BIRTH_DATE_IS_INVALID = 0x00b;
181 const EXCEPTION_EMPTY_STRUCTURES_ARRAY = 0x00c;
182 const EXCEPTION_HAS_ALREADY_PERSONELL_LIST = 0x00d;
183 const EXCEPTION_NOT_ENOUGTH_UNEMPLOYEES = 0x00e;
184 const EXCEPTION_TOTAL_PRICE_NOT_CALCULATED = 0x00f;
185 const EXCEPTION_HARBOR_HAS_NO_SHIPYARDS = 0x010;
186 const EXCEPTION_CONTRACT_PARTNER_INVALID = 0x011;
187 const EXCEPTION_CONTRACT_PARTNER_MISMATCH = 0x012;
188 const EXCEPTION_CONTRACT_ALREADY_SIGNED = 0x013;
189 const EXCEPTION_UNEXPECTED_EMPTY_STRING = 0x014;
190 const EXCEPTION_PATH_NOT_FOUND = 0x015;
191 const EXCEPTION_INVALID_PATH_NAME = 0x016;
192 const EXCEPTION_READ_PROTECED_PATH = 0x017;
193 const EXCEPTION_WRITE_PROTECED_PATH = 0x018;
194 const EXCEPTION_DIR_POINTER_INVALID = 0x019;
195 const EXCEPTION_FILE_POINTER_INVALID = 0x01a;
196 const EXCEPTION_INVALID_RESOURCE = 0x01b;
197 const EXCEPTION_UNEXPECTED_OBJECT = 0x01c;
198 const EXCEPTION_LIMIT_ELEMENT_IS_UNSUPPORTED = 0x01d;
199 const EXCEPTION_GETTER_IS_MISSING = 0x01e;
200 const EXCEPTION_ARRAY_EXPECTED = 0x01f;
201 const EXCEPTION_ARRAY_HAS_INVALID_COUNT = 0x020;
202 const EXCEPTION_ID_IS_INVALID_FORMAT = 0x021;
203 const EXCEPTION_MD5_CHECKSUMS_MISMATCH = 0x022;
204 const EXCEPTION_UNEXPECTED_STRING_SIZE = 0x023;
205 const EXCEPTION_SIMULATOR_ID_INVALID = 0x024;
206 const EXCEPTION_MISMATCHING_COMPRESSORS = 0x025;
207 const EXCEPTION_CONTAINER_ITEM_IS_NULL = 0x026;
208 const EXCEPTION_ITEM_IS_NO_ARRAY = 0x027;
209 const EXCEPTION_CONTAINER_MAYBE_DAMAGED = 0x028;
210 const EXCEPTION_INVALID_STRING = 0x029;
211 const EXCEPTION_VARIABLE_NOT_SET = 0x02a;
212 const EXCEPTION_ATTRIBUTES_ARE_MISSING = 0x02b;
213 const EXCEPTION_ARRAY_ELEMENTS_MISSING = 0x02c;
214 const EXCEPTION_TEMPLATE_ENGINE_UNSUPPORTED = 0x02d;
215 const EXCEPTION_MISSING_ELEMENT = 0x030;
216 const EXCEPTION_HEADERS_ALREADY_SENT = 0x031;
217 const EXCEPTION_DEFAULT_CONTROLLER_GONE = 0x032;
218 const EXCEPTION_CLASS_NOT_FOUND = 0x033;
219 const EXCEPTION_REQUIRED_INTERFACE_MISSING = 0x034;
220 const EXCEPTION_FATAL_ERROR = 0x035;
221 const EXCEPTION_FILE_NOT_FOUND = 0x036;
222 const EXCEPTION_ASSERTION_FAILED = 0x037;
223 const EXCEPTION_FILE_CANNOT_BE_READ = 0x038;
224 const EXCEPTION_DATABASE_UPDATED_NOT_ALLOWED = 0x039;
225 const EXCEPTION_FILTER_CHAIN_INTERCEPTED = 0x040;
228 * Protected super constructor
230 * @param $className Name of the class
233 protected function __construct ($className) {
235 $this->setRealClass($className);
237 // Set configuration instance if no registry ...
238 if (!$this instanceof Register) {
239 // ... because registries doesn't need to be configured
240 $this->setConfigInstance(FrameworkConfiguration::getInstance());
245 * Destructor reached...
249 public function __destruct() {
250 // Flush any updated entries to the database
251 $this->flushPendingUpdates();
253 // Is this object already destroyed?
254 if ($this->__toString() != 'DestructedObject') {
255 // Destroy all informations about this class but keep some text about it alive
256 $this->setRealClass('DestructedObject');
257 } elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
258 // Already destructed object
259 $this->debugOutput(sprintf("[%s:] The object <span class=\"object_name\">%s</span> is already destroyed.",
267 * The __call() method where all non-implemented methods end up
269 * @param $methodName Name of the missing method
270 * @args $args Arguments passed to the method
273 public final function __call ($methodName, $args) {
274 // Implode all given arguments
278 $argsString = 'NULL';
279 } elseif (is_array($args)) {
280 // Some arguments are there
281 foreach ($args as $arg) {
283 $argsString .= $this->replaceControlCharacters($arg) . ' (' . gettype($arg);
285 // Add length if type is string
286 if (is_string($arg)) {
287 $argsString .= ', '.strlen($arg);
291 $argsString .= '), ';
295 if (substr($argsString, -2, 1) == ',') {
296 $argsString = substr($argsString, 0, -2);
299 // Invalid arguments!
300 $argsString = '!INVALID:' . gettype($args) . '!';
303 // Output stub message
304 $this->debugOutput(sprintf("[%s->%s] Stub! Args: %s",
315 * Getter for $realClass
317 * @return $realClass The name of the real class (not BaseFrameworkSystem)
319 public function __toString () {
320 return $this->realClass;
324 * Magic function to catch setting of missing but set class fields/attributes
326 * @param $name Name of the field/attribute
327 * @param $value Value to store
330 public final function __set ($name, $value) {
331 $this->debugBackTrace(sprintf("Tried to set a missing field. name=%s, value[%s]=%s",
339 * Magic function to catch getting of missing fields/attributes
341 * @param $name Name of the field/attribute
344 public final function __get ($name) {
345 $this->debugBackTrace(sprintf("Tried to get a missing field. name=%s",
351 * Setter for database result instance
353 * @param $resultInstance An instance of a database result class
355 * @todo SearchableResult and UpdateableResult shall have a super interface to use here
357 protected final function setResultInstance (SearchableResult $resultInstance) {
358 $this->resultInstance = $resultInstance;
362 * Getter for database result instance
364 * @return $resultInstance An instance of a database result class
366 public final function getResultInstance () {
367 return $this->resultInstance;
371 * Setter for template engine instances
373 * @param $templateInstance An instance of a template engine class
376 protected final function setTemplateInstance (CompileableTemplate $templateInstance) {
377 $this->templateInstance = $templateInstance;
381 * Getter for template engine instances
383 * @return $templateInstance An instance of a template engine class
385 protected final function getTemplateInstance () {
386 return $this->templateInstance;
390 * Setter for search instance
392 * @param $searchInstance Searchable criteria instance
395 public final function setSearchInstance (LocalSearchCriteria $searchInstance) {
396 $this->searchInstance = $searchInstance;
400 * Getter for search instance
402 * @return $searchInstance Searchable criteria instance
404 public final function getSearchInstance () {
405 return $this->searchInstance;
409 * Setter for update instance
411 * @param $updateInstance Searchable criteria instance
414 public final function setUpdateInstance (LocalUpdateCriteria $updateInstance) {
415 $this->updateInstance = $updateInstance;
419 * Getter for update instance
421 * @return $updateInstance Updateable criteria instance
423 public final function getUpdateInstance () {
424 return $this->updateInstance;
428 * Setter for resolver instance
430 * @param $resolverInstance Instance of a command resolver class
433 public final function setResolverInstance (Resolver $resolverInstance) {
434 $this->resolverInstance = $resolverInstance;
438 * Getter for resolver instance
440 * @return $resolverInstance Instance of a command resolver class
442 public final function getResolverInstance () {
443 return $this->resolverInstance;
447 * Setter for language instance
449 * @param $configInstance The configuration instance which shall
450 * be FrameworkConfiguration
453 public final function setConfigInstance (FrameworkConfiguration $configInstance) {
454 Registry::getRegistry()->addInstance('config', $configInstance);
458 * Getter for configuration instance
460 * @return $configInstance Configuration instance
462 public final function getConfigInstance () {
463 $configInstance = Registry::getRegistry()->getInstance('config');
464 return $configInstance;
468 * Setter for debug instance
470 * @param $debugInstance The instance for debug output class
473 public final function setDebugInstance (DebugMiddleware $debugInstance) {
474 Registry::getRegistry()->addInstance('debug', $debugInstance);
478 * Getter for debug instance
480 * @return $debugInstance Instance to class DebugConsoleOutput or DebugWebOutput
482 public final function getDebugInstance () {
483 // Get debug instance
484 $debugInstance = Registry::getRegistry()->getInstance('debug');
487 return $debugInstance;
491 * Setter for web output instance
493 * @param $webInstance The instance for web output class
496 public final function setWebOutputInstance (OutputStreamer $webInstance) {
497 Registry::getRegistry()->addInstance('web_output', $webInstance);
501 * Getter for web output instance
503 * @return $webOutputInstance - Instance to class WebOutput
505 public final function getWebOutputInstance () {
506 $webOutputInstance = Registry::getRegistry()->getInstance('web_output');
507 return $webOutputInstance;
511 * Setter for database instance
513 * @param $dbInstance The instance for the database connection (forced DatabaseConnection)
516 public final function setDatabaseInstance (DatabaseConnection $dbInstance) {
517 Registry::getRegistry()->addInstance('db_instance', $dbInstance);
521 * Getter for database layer
523 * @return $dbInstance The database layer instance
525 public final function getDatabaseInstance () {
527 $dbInstance = Registry::getRegistry()->getInstance('db_instance');
534 * Setter for compressor channel
536 * @param $compressorInstance An instance of CompressorChannel
539 public final function setCompressorChannel (CompressorChannel $compressorInstance) {
540 Registry::getRegistry()->addInstance('compressor', $compressorInstance);
544 * Getter for compressor channel
546 * @return $compressorInstance The compressor channel
548 public final function getCompressorChannel () {
549 $compressorInstance = Registry::getRegistry()->getInstance('compressor');
550 return $compressorInstance;
554 * Protected getter for a manageable application helper class
556 * @return $applicationInstance An instance of a manageable application helper class
558 protected final function getApplicationInstance () {
559 $applicationInstance = Registry::getRegistry()->getInstance('application');
560 return $applicationInstance;
564 * Setter for a manageable application helper class
566 * @param $applicationInstance An instance of a manageable application helper class
569 public final function setApplicationInstance (ManageableApplication $applicationInstance) {
570 Registry::getRegistry()->addInstance('application', $applicationInstance);
574 * Setter for request instance
576 * @param $requestInstance An instance of a Requestable class
579 public final function setRequestInstance (Requestable $requestInstance) {
580 $this->requestInstance = $requestInstance;
584 * Getter for request instance
586 * @return $requestInstance An instance of a Requestable class
588 public final function getRequestInstance () {
589 return $this->requestInstance;
593 * Setter for response instance
595 * @param $responseInstance An instance of a Responseable class
598 public final function setResponseInstance (Responseable $responseInstance) {
599 $this->responseInstance = $responseInstance;
603 * Getter for response instance
605 * @return $responseInstance An instance of a Responseable class
607 public final function getResponseInstance () {
608 return $this->responseInstance;
612 * Setter for the real class name
614 * @param $realClass Class name (string)
617 public final function setRealClass ($realClass) {
619 $realClass = (string) $realClass;
622 $this->realClass = $realClass;
626 * Checks wether an object equals this object. You should overwrite this
627 * method to implement own equality checks
629 * @param $objectInstance An instance of a FrameworkInterface object
630 * @return $equals Wether both objects equals
632 public function equals (FrameworkInterface $objectInstance) {
635 $this->__toString() == $objectInstance->__toString()
637 $this->hashCode() == $objectInstance->hashCode()
645 * Generates a generic hash code of this class. You should really overwrite
646 * this method with your own hash code generator code. But keep KISS in mind.
648 * @return $hashCode A generic hash code respresenting this whole class
650 public function hashCode () {
652 return crc32($this->__toString());
656 * Formats computer generated price values into human-understandable formats
657 * with thousand and decimal seperators.
659 * @param $value The in computer format value for a price
660 * @param $currency The currency symbol (use HTML-valid characters!)
661 * @param $decNum Number of decimals after commata
662 * @return $price The for the current language formated price string
663 * @throws MissingDecimalsThousandsSeperatorException If decimals or
664 * thousands seperator
667 public function formatCurrency ($value, $currency = '€', $decNum = 2) {
668 // Are all required attriutes set?
669 if ((!isset($this->decimals)) || (!isset($this->thousands))) {
670 // Throw an exception
671 throw new MissingDecimalsThousandsSeperatorException($this, self::EXCEPTION_ATTRIBUTES_ARE_MISSING);
675 $value = (float) $value;
677 // Reformat the US number
678 $price = number_format($value, $decNum, $this->decimals, $this->thousands) . $currency;
680 // Return as string...
685 * Private getter for language instance
687 * @return $langInstance An instance to the language sub-system
689 protected final function getLanguageInstance () {
690 $langInstance = Registry::getRegistry()->getInstance('language');
691 return $langInstance;
695 * Setter for language instance
697 * @param $langInstance An instance to the language sub-system
699 * @see LanguageSystem
701 public final function setLanguageInstance (ManageableLanguage $langInstance) {
702 Registry::getRegistry()->addInstance('language', $langInstance);
706 * Appends a trailing slash to a string
708 * @param $str A string (maybe) without trailing slash
709 * @return $str A string with an auto-appended trailing slash
711 public final function addMissingTrailingSlash ($str) {
712 // Is there a trailing slash?
713 if (substr($str, -1, 1) != '/') {
717 // Return string with trailing slash
722 * Private getter for file IO instance
724 * @return $fileIoInstance An instance to the file I/O sub-system
726 protected final function getFileIoInstance () {
727 return $this->fileIoInstance;
731 * Setter for file I/O instance
733 * @param $fileIoInstance An instance to the file I/O sub-system
736 public final function setFileIoInstance (FileIoHandler $fileIoInstance) {
737 $this->fileIoInstance = $fileIoInstance;
741 * Prepare the template engine (WebTemplateEngine by default) for a given
742 * application helper instance (ApplicationHelper by default).
744 * @param $applicationInstance An application helper instance or
745 * null if we shall use the default
746 * @return $templateInstance The template engine instance
747 * @throws NullPointerException If the discovered application
748 * instance is still null
750 protected function prepareTemplateInstance (ManageableApplication $applicationInstance = null) {
751 // Is the application instance set?
752 if (is_null($applicationInstance)) {
753 // Get the current instance
754 $applicationInstance = $this->getApplicationInstance();
757 if (is_null($applicationInstance)) {
758 // Thrown an exception
759 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
763 // Initialize the template engine
764 $templateInstance = ObjectFactory::createObjectByConfiguredName('web_template_class');
766 // Return the prepared instance
767 return $templateInstance;
771 * Debugs this instance by putting out it's full content
773 * @param $message Optional message to show in debug output
776 public final function debugInstance ($message = '') {
777 // Restore the error handler to avoid trouble with missing array elements or undeclared variables
778 restore_error_handler();
784 if (!empty($message)) {
786 $content = sprintf("<div class=\"debug_message\">Message: %s</div>\n", $message);
789 // Generate the output
790 $content .= sprintf("<pre>%s</pre>",
799 ApplicationEntryPoint::app_die(sprintf("<div class=\"debug_header\">%s debug output:</div><div class=\"debug_content\">%s</div>\nLoaded includes: <div class=\"debug_include_list\">%s</div>",
802 ClassLoader::getInstance()->getPrintableIncludeList()
807 * Replaces control characters with printable output
809 * @param $str String with control characters
810 * @return $str Replaced string
812 protected function replaceControlCharacters ($str) {
815 "\r", '[r]', str_replace(
816 "\n", '[n]', str_replace(
826 * Output a partial stub message for the caller method
828 * @param $message An optional message to display
831 protected function partialStub ($message = '') {
833 $backtrace = debug_backtrace();
835 // Generate the class::method string
836 $methodName = 'UnknownClass->unknownMethod';
837 if ((isset($backtrace[1]['class'])) && (isset($backtrace[1]['function']))) {
838 $methodName = $backtrace[1]['class'] . '->' . $backtrace[1]['function'];
841 // Construct the full message
842 $stubMessage = sprintf("[%s:] Partial stub!",
846 // Is the extra message given?
847 if (!empty($message)) {
848 // Then add it as well
849 $stubMessage .= sprintf(" Message: <span id=\"stub_message\">%s</span>", $message);
852 // Debug instance is there?
853 if (!is_null($this->getDebugInstance())) {
854 // Output stub message
855 $this->debugOutput($stubMessage);
858 trigger_error($stubMessage . "<br />\n");
863 * Outputs a debug backtrace and stops further script execution
865 * @param $message An optional message to output
868 public function debugBackTrace ($message = '') {
869 // Sorry, there is no other way getting this nice backtrace
870 if (!empty($message)) {
872 printf("Message: %s<br />\n", $message);
876 debug_print_backtrace();
882 * Outputs a debug message wether to debug instance (should be set!) or dies with or pints the message
884 * @param $message Message we shall send out...
885 * @param $doPrint Wether we shall print or die here which first is the default
888 public function debugOutput ($message, $doPrint = true) {
889 // Get debug instance
890 $debugInstance = $this->getDebugInstance();
892 // Is the debug instance there?
893 if (is_object($debugInstance)) {
894 // Use debug output handler
895 $debugInstance->output($message);
897 if ($doPrint === false) {
898 // Die here if not printed
903 if ($doPrint === true) {
906 // DO NOT REWRITE THIS TO app_die() !!!
913 * Converts e.g. a command from URL to a valid class by keeping out bad characters
915 * @param $str The string, what ever it is needs to be converted
916 * @return $className Generated class name
918 public function convertToClassName ($str) {
922 // Convert all dashes in underscores
923 $str = $this->convertDashesToUnderscores($str);
925 // Now use that underscores to get classname parts for hungarian style
926 foreach (explode('_', $str) as $strPart) {
927 // Make the class name part lower case and first upper case
928 $className .= ucfirst(strtolower($strPart));
936 * Converts dashes to underscores, e.g. useable for configuration entries
938 * @param $str The string with maybe dashes inside
939 * @return $str The converted string with no dashed, but underscores
941 public final function convertDashesToUnderscores ($str) {
943 $str = str_replace('-', '_', $str);
945 // Return converted string
950 * Marks up the code by adding e.g. line numbers
952 * @param $phpCode Unmarked PHP code
953 * @return $markedCode Marked PHP code
955 public function markupCode ($phpCode) {
960 $errorArray = error_get_last();
962 // Init the code with error message
963 if (is_array($errorArray)) {
965 $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>",
966 basename($errorArray['file']),
968 $errorArray['message'],
973 // Add line number to the code
974 foreach (explode("\n", $phpCode) as $lineNo => $code) {
976 $markedCode .= sprintf("<span id=\"code_line\">%s</span>: %s\n",
978 htmlentities($code, ENT_QUOTES)
987 * Filter a given GMT timestamp (non Uni* stamp!) to make it look more
988 * beatiful for web-based front-ends. If null is given a message id
989 * null_timestamp will be resolved and returned.
991 * @param $timestamp Timestamp to prepare (filter) for display
992 * @return $readable A readable timestamp
994 public function doFilterFormatTimestamp ($timestamp) {
995 // Default value to return
998 // Is the timestamp null?
999 if (is_null($timestamp)) {
1000 // Get a message string
1001 $readable = $this->getLanguageInstance()->getMessage('null_timestamp');
1003 switch ($this->getLanguageInstance()->getLanguageCode()) {
1004 case 'de': // German format is a bit different to default
1005 // Split the GMT stamp up
1006 $dateTime = explode(' ', $timestamp );
1007 $dateArray = explode('-', $dateTime[0]);
1008 $timeArray = explode(':', $dateTime[1]);
1010 // Construct the timestamp
1011 $readable = sprintf($this->getConfigInstance()->getConfigEntry('german_date_time'),
1021 default: // Default is pass-through
1022 $readable = $timestamp;
1032 * Filter a given number into a localized number
1034 * @param $value The raw value from e.g. database
1035 * @return $localized Localized value
1037 public function doFilterFormatNumber ($value) {
1038 // Generate it from config and localize dependencies
1039 switch ($this->getLanguageInstance()->getLanguageCode()) {
1040 case 'de': // German format is a bit different to default
1041 $localized = number_format($value, $this->getConfigInstance()->getConfigEntry('decimals'), ',', '.');
1044 default: // US, etc.
1045 $localized = number_format($value, $this->getConfigInstance()->getConfigEntry('decimals'), '.', ',');
1054 * "Getter" for databse entry
1056 * @return $entry An array with database entries
1057 * @throws NullPointerException If the database result is not found
1058 * @throws InvalidDatabaseResultException If the database result is invalid
1060 protected final function getDatabaseEntry () {
1061 // Is there an instance?
1062 if (is_null($this->getResultInstance())) {
1063 // Throw an exception here
1064 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
1068 $this->getResultInstance()->rewind();
1070 // Do we have an entry?
1071 if ($this->getResultInstance()->valid() === false) {
1072 throw new InvalidDatabaseResultException(array($this, $this->getResultInstance()), DatabaseResult::EXCEPTION_INVALID_DATABASE_RESULT);
1076 $this->getResultInstance()->next();
1079 $entry = $this->getResultInstance()->current();
1086 * Getter for field name
1088 * @param $fieldName Field name which we shall get
1089 * @return $fieldValue Field value from the user
1090 * @throws NullPointerException If the result instance is null
1092 public final function getField ($fieldName) {
1093 // Default field value
1096 // Get result instance
1097 $resultInstance = $this->getResultInstance();
1099 // Is this instance null?
1100 if (is_null($resultInstance)) {
1101 // Then the user instance is no longer valid (expired cookies?)
1102 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
1105 // Get current array
1106 $fieldArray = $resultInstance->current();
1107 //* DEBUG: */ $this->debugOutput($fieldName.':<pre>'.print_r($fieldArray, true).'</pre>');
1109 // Does the field exist?
1110 if (isset($fieldArray[$fieldName])) {
1112 $fieldValue = $fieldArray[$fieldName];
1120 * Protected setter for user instance
1122 * @param $userInstance An instance of a user class
1125 protected final function setUserInstance (ManageableAccount $userInstance) {
1126 $this->userInstance = $userInstance;
1130 * Getter for user instance
1132 * @return $userInstance An instance of a user class
1134 public final function getUserInstance () {
1135 return $this->userInstance;
1139 * Setter for controller instance (this surely breaks a bit the MVC patterm)
1141 * @param $controllerInstance An instance of the controller
1144 public final function setControllerInstance (Controller $controllerInstance) {
1145 $this->controllerInstance = $controllerInstance;
1149 * Getter for controller instance (this surely breaks a bit the MVC patterm)
1151 * @return $controllerInstance An instance of the controller
1153 public final function getControllerInstance () {
1154 return $this->controllerInstance;
1158 * Flushs all pending updates to the database layer
1162 public function flushPendingUpdates () {
1163 // Get result instance
1164 $resultInstance = $this->getResultInstance();
1166 // Do we have data to update?
1167 if ((is_object($resultInstance)) && ($resultInstance->ifDataNeedsFlush())) {
1168 // Get wrapper class name config entry
1169 $configEntry = $resultInstance->getUpdateInstance()->getWrapperConfigEntry();
1171 // Create object instance
1172 $wrapperInstance = ObjectFactory::createObjectByConfiguredName($configEntry);
1174 // Yes, then send the whole result to the database layer
1175 $wrapperInstance->doUpdateByResult($this->getResultInstance());
1180 * Outputs a deprecation warning to the developer.
1182 * @param $message The message we shall output to the developer
1184 * @todo Write a logging mechanism for productive mode
1186 public function deprecationWarning ($message) {
1187 // Is developer mode active?
1188 if (defined('DEVELOPER')) {
1189 // Debug instance is there?
1190 if (!is_null($this->getDebugInstance())) {
1191 // Output stub message
1192 $this->debugOutput($message);
1195 trigger_error($message . "<br />\n");
1198 // @TODO Finish this part!
1199 $this->partialStub('Developer mode inactive. Message:' . $message);
1204 * Checks wether the given PHP extension is loaded
1206 * @param $phpExtension The PHP extension we shall check
1207 * @return $isLoaded Wether the PHP extension is loaded
1209 public final function isPhpExtensionLoaded ($phpExtension) {
1211 $isLoaded = in_array($phpExtension, get_loaded_extensions());
1218 * Setter for RNG instance
1220 * @param $rngInstance An instance of a random number generator (RNG)
1223 protected final function setRngInstance (RandomNumberGenerator $rngInstance) {
1224 $this->rngInstance = $rngInstance;
1228 * Getter for RNG instance
1230 * @return $rngInstance An instance of a random number generator (RNG)
1232 public final function getRngInstance () {
1233 return $this->rngInstance;
1237 * Setter for Cryptable instance
1239 * @param $cryptoInstance An instance of a Cryptable class
1242 protected final function setCryptoInstance (Cryptable $cryptoInstance) {
1243 $this->cryptoInstance = $cryptoInstance;
1247 * Getter for Cryptable instance
1249 * @return $cryptoInstance An instance of a Cryptable class
1251 public final function getCryptoInstance () {
1252 return $this->cryptoInstance;
1256 * Setter for Iterator instance
1258 * @param $iteratorInstance An instance of an Iterator
1261 protected final function setIteratorInstance (Iterator $iteratorInstance) {
1262 $this->iteratorInstance = $iteratorInstance;
1266 * Getter for Iterator instance
1268 * @return $iteratorInstance An instance of an Iterator
1270 public final function getIteratorInstance () {
1271 return $this->iteratorInstance;
1275 * "Getter" as a time() replacement but with milliseconds. You should use this
1276 * method instead of the encapsulated getimeofday() function.
1278 * @return $milliTime Timestamp with milliseconds
1280 public function getMilliTime () {
1281 // Get the time of day as float
1282 $milliTime = gettimeofday(true);
1289 * Idles (sleeps) for given milliseconds
1291 * @return $hasSlept Wether it goes fine
1293 public function idle ($milliSeconds) {
1294 // Sleep is fine by default
1297 // Idle so long with found function
1298 if (function_exists('time_sleep_until')) {
1299 // Get current time and add idle time
1300 $sleepUntil = $this->getMilliTime() + abs($milliSeconds) / 1000;
1302 // New PHP 5.1.0 function found
1303 $hasSlept = time_sleep_until($sleepUntil);
1305 // My Sun Station doesn't have that function even with latest PHP
1307 usleep($milliSeconds * 1000);
1315 * Setter for the list instance
1317 * @param $listInstance A list of Listable
1320 protected final function setListInstance (Listable $listInstance) {
1321 $this->listInstance = $listInstance;
1325 * Getter for the list instance
1327 * @return $listInstance A list of Listable
1329 protected final function getListInstance () {
1330 return $this->listInstance;
1334 * Setter for the menu instance
1336 * @param $menuInstance A RenderableMenu instance
1339 protected final function setMenuInstance (RenderableMenu $menuInstance) {
1340 $this->menuInstance = $menuInstance;
1344 * Getter for the menu instance
1346 * @return $menuInstance A RenderableMenu instance
1348 protected final function getMenuInstance () {
1349 return $this->menuInstance;
1353 * Setter for image instance
1355 * @param $imageInstance An instance of an image
1358 public final function setImageInstance (BaseImage $imageInstance) {
1359 $this->imageInstance = $imageInstance;
1363 * Getter for image instance
1365 * @return $imageInstance An instance of an image
1367 public final function getImageInstance () {
1368 return $this->imageInstance;
1372 * Setter for stacker instance
1374 * @param $stackerInstance An instance of an stacker
1377 public final function setStackerInstance (Stackable $stackerInstance) {
1378 $this->stackerInstance = $stackerInstance;
1382 * Getter for stacker instance
1384 * @return $stackerInstance An instance of an stacker
1386 public final function getStackerInstance () {
1387 return $this->stackerInstance;
1391 * Setter for compressor instance
1393 * @param $compressorInstance An instance of an compressor
1396 public final function setCompressorInstance (Compressor $compressorInstance) {
1397 $this->compressorInstance = $compressorInstance;
1401 * Getter for compressor instance
1403 * @return $compressorInstance An instance of an compressor
1405 public final function getCompressorInstance () {
1406 return $this->compressorInstance;
1410 * Setter for Parseable instance
1412 * @param $parserInstance An instance of an Parseable
1415 public final function setParserInstance (Parseable $parserInstance) {
1416 $this->parserInstance = $parserInstance;
1420 * Getter for Parseable instance
1422 * @return $parserInstance An instance of an Parseable
1424 public final function getParserInstance () {
1425 return $this->parserInstance;
1429 * Setter for ProtocolHandler instance
1431 * @param $protocolInstance An instance of an ProtocolHandler
1434 public final function setProtocolInstance (ProtocolHandler $protocolInstance) {
1435 $this->protocolInstance = $protocolInstance;
1439 * Getter for ProtocolHandler instance
1441 * @return $protocolInstance An instance of an ProtocolHandler
1443 public final function getProtocolInstance () {
1444 return $this->protocolInstance;
1448 * Setter for BaseDatabaseWrapper instance
1450 * @param $wrapperInstance An instance of an BaseDatabaseWrapper
1453 public final function setWrapperInstance (BaseDatabaseWrapper $wrapperInstance) {
1454 $this->wrapperInstance = $wrapperInstance;
1458 * Getter for BaseDatabaseWrapper instance
1460 * @return $wrapperInstance An instance of an BaseDatabaseWrapper
1462 public final function getWrapperInstance () {
1463 return $this->wrapperInstance;
1467 * Setter for socket resource
1469 * @param $socketResource A valid socket resource
1472 public final function setSocketResource ($socketResource) {
1473 $this->socketResource = $socketResource;
1477 * Getter for socket resource
1479 * @return $socketResource A valid socket resource
1481 public function getSocketResource () {
1482 return $this->socketResource;
1486 * Setter for helper instance
1488 * @param $helperInstance An instance of a helper class
1491 protected final function setHelperInstance (Helper $helperInstance) {
1492 $this->helperInstance = $helperInstance;
1496 * Getter for helper instance
1498 * @return $helperInstance An instance of a helper class
1500 public final function getHelperInstance () {
1501 return $this->helperInstance;
1505 * Setter for a Sourceable instance
1507 * @param $sourceInstance The Sourceable instance
1510 protected final function setSourceInstance (Sourceable $sourceInstance) {
1511 $this->sourceInstance = $sourceInstance;
1515 * Getter for a Sourceable instance
1517 * @param $sourceInstance The Sourceable instance
1519 protected final function getSourceInstance () {
1520 return $this->sourceInstance;
1524 * Setter for raw package Data
1526 * @param $packageData Raw package Data
1529 public final function setPackageData (array $packageData) {
1530 $this->packageData = $packageData;
1534 * Getter for raw package Data
1536 * @return $packageData Raw package Data
1538 public function getPackageData () {
1539 return $this->packageData;