3 * The simulator system class is the super class of all other classes. This
4 * class handles saving of games etc.
6 * @author Roland Haeder <webmaster@ship-simu.org>
8 * @copyright Copyright (c) 2007, 2008 Roland Haeder, this is free software
9 * @license GNU GPL 3.0 or any newer version
10 * @link http://www.ship-simu.org
12 * This program is free software: you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation, either version 3 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
27 * Instance to an application helper class
29 private static $applicationInstance = null;
32 * The language instance for the template loader
34 private static $langInstance = null;
39 private static $debugInstance = null;
42 * Instance of a request class
44 private $requestInstance = null;
47 * Instance of a response class
49 private $responseInstance = null;
52 * Search criteria instance
54 private $searchInstance = null;
57 * The file I/O instance for the template loader
59 private $fileIoInstance = null;
64 private $resolverInstance = null;
67 * Template engine instance
69 private $templateInstance = null;
72 * Database result instance
74 private $resultInstance = null;
77 * Instance for user class
79 private $userInstance = null;
84 private $realClass = "FrameworkSystem";
89 private $thousands = "."; // German
94 private $decimals = ","; // German
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_HEADERS_ALREADY_SENT = 0x031;
149 const EXCEPTION_DEFAULT_CONTROLLER_GONE = 0x032;
150 const EXCEPTION_CLASS_NOT_FOUND = 0x033;
151 const EXCEPTION_REQUIRED_INTERFACE_MISSING = 0x034;
152 const EXCEPTION_FATAL_ERROR = 0x035;
153 const EXCEPTION_FILE_NOT_FOUND = 0x036;
154 const EXCEPTION_ASSERTION_FAILED = 0x037;
155 const EXCEPTION_FILE_CANNOT_BE_READ = 0x038;
156 const EXCEPTION_DATABASE_UPDATED_NOT_ALLOWED = 0x039;
159 * In the super constructor these system classes shall be ignored or else
160 * we would get an endless calling loop.
162 *---------------------------------------------------------------------*
163 * ATTENTION: IF YOU REMOVE ONE OF THEM YOU WILL RUN YOUR SERVER IN AN *
165 *---------------------------------------------------------------------*
167 private $systemClasses = array(
168 "DebugMiddleware", // Debug middleware output sub-system
169 "Registry", // Object registry
170 "ObjectFactory", // Object factory
171 "DebugWebOutput", // Debug web output sub-system
172 "WebOutput", // Web output sub-system
173 "CompressorChannel", // Compressor sub-system
174 "DebugConsoleOutput", // Debug console output sub-system
175 "DebugErrorLogOutput", // Debug error_log() output sub-system
176 "FrameworkDirectoryPointer", // Directory handler sub-system
177 "NullCompressor", // Null compressor
178 "Bzip2Compressor", // BZIP2 compressor
179 "GzipCompressor", // GZIP compressor
186 * Private super constructor
188 * @param $className Name of the class
191 protected function __construct ($className) {
193 $this->setRealClass($className);
195 // Initialize the class if the registry is there
196 if ((class_exists('Registry')) && (Registry::isInitialized() === false)) {
197 $this->initInstance();
202 * Destructor reached...
205 * @todo This is old code. Do we still need this old lost code?
207 public function __destruct() {
208 // Is this object already destroyed?
209 if ($this->__toString() != 'DestructedObject') {
210 // Destroy all informations about this class but keep some text about it alive
211 $this->setRealClass('DestructedObject');
212 } elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
213 // Already destructed object
214 $this->debugOutput(sprintf("[%s:] The object <strong>%s</strong> is already destroyed.",
215 __CLASS__, $this->__toString()
221 * The call method where all non-implemented methods end up
225 public final function __call ($methodName, $args) {
226 // Implode all given arguments
230 $argsString = "NULL";
231 } elseif (is_array($args)) {
232 // Some arguments are there
233 foreach ($args as $arg) {
235 $argsString .= $arg." (".gettype($arg);
237 // Add length if type is string
238 if (gettype($arg) == 'string') $argsString .= ", ".strlen($arg);
241 $argsString .= "), ";
245 if (substr($argsString, -2, 1) === ",") {
246 $argsString = substr($argsString, 0, -2);
249 // Invalid arguments!
250 $argsString = sprintf("!INVALID:%s!", $args);
253 // Output stub message
254 $this->debugOutput(sprintf("[%s->%s] Stub! Args: %s",
265 * Private initializer for this class
269 private final function initInstance () {
270 // Is this a system class?
271 if (!in_array($this->__toString(), $this->systemClasses)) {
272 // Add application helper to our class
273 $this->systemclasses[] = $this->getConfigInstance()->readConfig('app_helper_class');
275 // Set debug instance
276 $this->setDebugInstance(DebugMiddleware::createDebugMiddleware($this->getConfigInstance()->readConfig('debug_class')));
278 // Get output instance and set it
279 $outputInstance = ObjectFactory::createObjectByConfiguredName('web_engine', array($this->getConfigInstance()->readConfig('web_content_type')));
280 $this->setWebOutputInstance($outputInstance);
282 // Set the compressor channel
283 $this->setCompressorChannel(CompressorChannel::createCompressorChannel(sprintf("%s%s",
284 $this->getConfigInstance()->readConfig('base_path'),
285 $this->getConfigInstance()->readConfig('compressor_base_path')
288 // Initialization done! :D
289 Registry::isInitialized('OK');
290 } elseif ($this->__toString() == 'DebugMiddleware') {
291 // Set configuration instance
292 $this->setConfigInstance(FrameworkConfiguration::createFrameworkConfiguration());
297 * Setter for database result instance
299 * @param $resultInstance An instance of a database result class
301 * @todo SearchableResult and UpdateableResult shall have a super interface to use here
303 protected final function setResultInstance (SearchableResult $resultInstance) {
304 $this->resultInstance = $resultInstance;
308 * Getter for database result instance
310 * @return $resultInstance An instance of a database result class
312 public final function getResultInstance () {
313 return $this->resultInstance;
317 * Setter for template engine instances
319 * @param $templateInstance An instance of a template engine class
322 protected final function setTemplateInstance (CompileableTemplate $templateInstance) {
323 $this->templateInstance = $templateInstance;
327 * Getter for template engine instances
329 * @return $templateInstance An instance of a template engine class
331 protected final function getTemplateInstance () {
332 return $this->templateInstance;
336 * Setter for search instance
338 * @param $searchInstance Searchable criteria instance
341 public final function setSearchInstance (LocalSearchCriteria $searchInstance) {
342 $this->searchInstance = $searchInstance;
346 * Getter for search instance
348 * @return $searchInstance Searchable criteria instance
350 public final function getSearchInstance () {
351 return $this->searchInstance;
355 * Setter for resolver instance
357 * @param $resolverInstance Instance of a command resolver class
360 public final function setResolverInstance (Resolver $resolverInstance) {
361 $this->resolverInstance = $resolverInstance;
365 * Getter for resolver instance
367 * @return $resolverInstance Instance of a command resolver class
369 public final function getResolverInstance () {
370 return $this->resolverInstance;
374 * Setter for language instance
376 * @param $configInstance The configuration instance which shall
377 * be FrameworkConfiguration
380 public final function setConfigInstance (FrameworkConfiguration $configInstance) {
381 Registry::getRegistry()->addInstance('config', $configInstance);
385 * Getter for configuration instance
387 * @return $cfgInstance Configuration instance
389 public final function getConfigInstance () {
390 $cfgInstance = Registry::getRegistry()->getInstance('config');
395 * Setter for debug instance
397 * @param $debugInstance The instance for debug output class
400 public final function setDebugInstance (DebugMiddleware $debugInstance) {
401 self::$debugInstance = $debugInstance;
405 * Getter for debug instance
407 * @return $debugInstance Instance to class DebugConsoleOutput or DebugWebOutput
409 public final function getDebugInstance () {
410 return self::$debugInstance;
414 * Setter for web output instance
416 * @param $webInstance The instance for web output class
419 public final function setWebOutputInstance (OutputStreamer $webInstance) {
420 Registry::getRegistry()->addInstance('web_output', $webInstance);
424 * Getter for web output instance
426 * @return $webOutput - Instance to class WebOutput
428 public final function getWebOutputInstance () {
429 return Registry::getRegistry()->getInstance('web_output');
433 * Setter for database instance
435 * @param $dbInstance The instance for the database connection
436 * (forced DatabaseConnection)
439 public final function setDatabaseInstance (DatabaseConnection $dbInstance) {
440 Registry::getRegistry()->addInstance('dbInstance', $dbInstance);
444 * Getter for database layer
446 * @return $dbInstance The database layer instance
448 public final function getDatabaseInstance () {
449 // Default is invalid db instance
452 // Is the registry there and initialized?
453 if ((class_exists('Registry')) && (Registry::isInitialized() === true)) {
454 $dbInstance = Registry::getRegistry()->getInstance('dbInstance');
462 * Setter for compressor channel
464 * @param $compressorChannel An instance of CompressorChannel
467 public final function setCompressorChannel (CompressorChannel $compressorChannel) {
468 Registry::getRegistry()->addInstance('compressor', $compressorChannel);
472 * Getter for compressor channel
474 * @return $compressor The compressor channel
476 public final function getCompressorChannel () {
477 return Registry::getRegistry()->getInstance('compressor');
481 * Protected getter for a manageable application helper class
483 * @return $applicationInstance An instance of a manageable application helper class
485 protected final function getApplicationInstance () {
486 return self::$applicationInstance;
490 * Setter for a manageable application helper class
492 * @param $applicationInstance An instance of a manageable application helper class
495 public final function setApplicationInstance (ManageableApplication $applicationInstance) {
496 self::$applicationInstance = $applicationInstance;
500 * Setter for request instance
502 * @param $requestInstance An instance of a Requestable class
505 public final function setRequestInstance (Requestable $requestInstance) {
506 $this->requestInstance = $requestInstance;
510 * Getter for request instance
512 * @return $requestInstance An instance of a Requestable class
514 public final function getRequestInstance () {
515 return $this->requestInstance;
519 * Setter for response instance
521 * @param $responseInstance An instance of a Responseable class
524 public final function setResponseInstance (Responseable $responseInstance) {
525 $this->responseInstance = $responseInstance;
529 * Getter for response instance
531 * @return $responseInstance An instance of a Responseable class
533 public final function getResponseInstance () {
534 return $this->responseInstance;
538 * Getter for $realClass
540 * @return $realClass The name of the real class (not BaseFrameworkSystem)
542 public final function __toString () {
543 return $this->realClass;
547 * Setter for the real class name
549 * @param $realClass Class name (string)
552 public final function setRealClass ($realClass) {
554 $realClass = (string) $realClass;
557 $this->realClass = $realClass;
561 * Compare class name of this and given class name
563 * @param $className The class name as string from the other class
564 * @return boolean The result of comparing both class names
566 public final function isClass ($className) {
567 return ($this->__toString() == $className);
571 * Stub method (only real cabins shall override it)
573 * @return boolean false = is no cabin, true = is a cabin
575 public function isCabin () {
580 * Stub method for tradeable objects
582 * @return boolean false = is not tradeable by the Merchant class,
583 * true = is a tradeable object
585 public function isTradeable () {
590 * Formats computer generated price values into human-understandable formats
591 * with thousand and decimal seperators.
593 * @param $value The in computer format value for a price
594 * @param $currency The currency symbol (use HTML-valid characters!)
595 * @param $decNum Number of decimals after commata
596 * @return $price The for the current language formated price string
597 * @throws MissingDecimalsThousandsSeperatorException If decimals or
598 * thousands seperator
601 public function formatCurrency ($value, $currency = "€", $decNum = 2) {
602 // Are all required attriutes set?
603 if ((!isset($this->decimals)) || (!isset($this->thousands))) {
604 // Throw an exception
605 throw new MissingDecimalsThousandsSeperatorException($this, self::EXCEPTION_ATTRIBUTES_ARE_MISSING);
609 $value = (float) $value;
611 // Reformat the US number
612 $price = sprintf("%s %s",
613 number_format($value, $decNum, $this->decimals, $this->thousands),
617 // Return as string...
622 * Removes number formating characters
626 public final function removeNumberFormaters () {
627 unset($this->thousands);
628 unset($this->decimals);
632 * Private getter for language instance
634 * @return $langInstance An instance to the language sub-system
636 protected final function getLanguageInstance () {
637 return self::$langInstance;
641 * Setter for language instance
643 * @param $langInstance An instance to the language sub-system
645 * @see LanguageSystem
647 public final function setLanguageInstance (ManageableLanguage $langInstance) {
648 self::$langInstance = $langInstance;
652 * Remove the $systemClasses array from memory
656 public final function removeSystemArray () {
657 unset($this->systemClasses);
661 * Appends a trailing slash to a string
663 * @param $str A string (maybe) without trailing slash
664 * @return $str A string with an auto-appended trailing slash
666 public final function addMissingTrailingSlash ($str) {
667 // Is there a trailing slash?
668 if (substr($str, -1, 1) != "/") $str .= "/";
673 * Private getter for file IO instance
675 * @return $fileIoInstance An instance to the file I/O sub-system
677 protected final function getFileIoInstance () {
678 return $this->fileIoInstance;
682 * Setter for file I/O instance
684 * @param $fileIoInstance An instance to the file I/O sub-system
687 public final function setFileIoInstance (FileIoHandler $fileIoInstance) {
688 $this->fileIoInstance = $fileIoInstance;
692 * Prepare the template engine (WebTemplateEngine by default) for a given
693 * application helper instance (ApplicationHelper by default).
695 * @param $appInstance An application helper instance or
696 * null if we shall use the default
697 * @return $templateInstance The template engine instance
698 * @throws NullPointerException If the template engine could not
700 * @throws UnsupportedTemplateEngineException If $templateInstance is an
701 * unsupported template engine
702 * @throws MissingLanguageHandlerException If the language sub-system
703 * is not yet initialized
704 * @throws NullPointerException If the discovered application
705 * instance is still null
707 protected function prepareTemplateInstance (BaseFrameworkSystem $appInstance=null) {
708 // Is the application instance set?
709 if (is_null($appInstance)) {
710 // Get the current instance
711 $appInstance = $this->getApplicationInstance();
714 if (is_null($appInstance)) {
715 // Thrown an exception
716 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
720 // Generate FQFN for all application templates
721 $fqfn = sprintf("%s%s/%s",
722 $this->getConfigInstance()->readConfig('application_path'),
723 strtolower($appInstance->getAppShortName()),
724 $this->getConfigInstance()->readConfig('tpl_base_path')
727 // Are both instances set?
728 if ($appInstance->getLanguageInstance() === null) {
729 // Invalid language instance
730 throw new MissingLanguageHandlerException($appInstance, self::EXCEPTION_MISSING_LANGUAGE_HANDLER);
731 } elseif ($appInstance->getFileIoInstance() === null) {
732 // Invalid language instance
733 throw new MissingFileIoHandlerException($appInstance, self::EXCEPTION_MISSING_FILE_IO_HANDLER);
736 // Initialize the template engine
737 $templateInstance = ObjectFactory::createObjectByConfiguredName('template_class', array($fqfn, $appInstance->getLanguageInstance(), $appInstance->getFileIoInstance()));
739 // Return the prepared instance
740 return $templateInstance;
744 * Debugs this instance by putting out it's full content
748 public final function debugInstance () {
749 // Restore the error handler to avoid trouble with missing array elements or undeclared variables
750 restore_error_handler();
752 // Generate the output
753 $content = sprintf("<pre>%s</pre>",
762 ApplicationEntryPoint::app_die(sprintf("<strong>%s debug output:</strong><div id=\"debug_content\">%s</div>\nLoaded includes: <div id=\"debug_include_list\">%s</div>",
765 ClassLoader::getInstance()->getPrintableIncludeList()
770 * Output a partial stub message for the caller method
772 * @param $message An optional message to display
775 protected function partialStub ($message = "") {
777 $backtrace = debug_backtrace();
779 // Generate the class::method string
780 $methodName = "UnknownClass->unknownMethod";
781 if ((isset($backtrace[1]['class'])) && (isset($backtrace[1]['function']))) {
782 $methodName = $backtrace[1]['class']."->".$backtrace[1]['function'];
785 // Construct the full message
786 $stubMessage = sprintf("[%s:] Partial stub!",
790 // Is the extra message given?
791 if (!empty($message)) {
792 // Then add it as well
793 $stubMessage .= sprintf(" Message: <span id=\"stub_message\">%s</span>", $message);
796 // Debug instance is there?
797 if (!is_null($this->getDebugInstance())) {
798 // Output stub message
799 $this->debugOutput($stubMessage);
802 trigger_error($stubMessage."<br />\n");
807 * Outputs a debug backtrace and stops further script execution
811 public function debugBackTrace () {
812 // Sorry, there is no other way getting this nice backtrace
814 debug_print_backtrace();
820 * Outputs a debug message wether to debug instance (should be set!) or dies with or pints the message
822 * @param $message Message we shall send out...
823 * @param $doPrint Wether we shall print or die here which first is the default
826 public function debugOutput ($message, $doPrint = true) {
827 // Get debug instance
828 $debugInstance = $this->getDebugInstance();
830 // Is the debug instance there?
831 if (is_object($debugInstance)) {
832 // Use debug output handler
833 $debugInstance->output($message);
834 if (!$doPrint) die(); // Die here if not printed
840 // DO NOT REWRITE THIS TO app_die() !!!
847 * Converts e.g. a command from URL to a valid class by keeping out bad characters
849 * @param $str The string, what ever it is needs to be converted
850 * @return $className Generated class name
852 public function convertToClassName ($str) {
856 // Convert all dashes in underscores
857 $str = str_replace("-", "_", $str);
859 // Now use that underscores to get classname parts for hungarian style
860 foreach (explode("_", $str) as $strPart) {
861 // Make the class name part lower case and first upper case
862 $className .= ucfirst(strtolower($strPart));
870 * Marks up the code by adding e.g. line numbers
872 * @param $phpCode Unmarked PHP code
873 * @return $markedCode Marked PHP code
875 public function markupCode ($phpCode) {
880 $errorArray = error_get_last();
882 // Init the code with error message
883 if (is_array($errorArray)) {
885 $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>",
886 basename($errorArray['file']),
888 $errorArray['message'],
893 // Add line number to the code
894 foreach (explode("\n", $phpCode) as $lineNo => $code) {
896 $markedCode .= sprintf("<span id=\"code_line\">%s</span>: %s\n",
898 htmlentities($code, ENT_QUOTES)
907 * Filter a given GMT timestamp (non Uni* stamp!) to make it look more
908 * beatiful for web-based front-ends. If null is given a message id
909 * null_timestamp will be resolved and returned.
911 * @param $timestamp Timestamp to prepare (filter) for display
912 * @return $readable A readable timestamp
914 public function doFilterFormatTimestamp ($timestamp) {
915 // Default value to return
918 // Is the timestamp null?
919 if (is_null($timestamp)) {
920 // Get a message string
921 $readable = $this->getLanguageInstance()->getMessage('null_timestamp');
923 switch ($this->getLanguageInstance()->getLanguageCode()) {
924 case "de": // German format is a bit different to default
925 // Split the GMT stamp up
926 $dateTime = explode(" ", $timestamp);
927 $dateArray = explode("-", $dateTime[0]);
928 $timeArray = explode(":", $dateTime[1]);
930 // Construct the timestamp
931 $readable = sprintf($this->getConfigInstance()->readConfig('german_date_time'),
941 default: // Default is pass-through
942 $readable = $timestamp;
952 * "Getter" for databse entry
954 * @return $entry An array with database entries
955 * @throws NullPointerException If the database result is not found
956 * @throws InvalidDatabaseResultException If the database result is invalid
958 protected final function getDatabaseEntry () {
959 // Is there an instance?
960 if (is_null($this->getResultInstance())) {
961 // Throw an exception here
962 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
966 $this->getResultInstance()->rewind();
968 // Do we have an entry?
969 if (!$this->getResultInstance()->valid()) {
970 throw new InvalidDatabaseResultException(array($this, $this->getResultInstance()), DatabaseResult::EXCEPTION_INVALID_DATABASE_RESULT);
974 $this->getResultInstance()->next();
977 $entry = $this->getResultInstance()->current();
984 * Getter for field name
986 * @param $fieldName Field name which we shall get
987 * @return $fieldValue Field value from the user
988 * @throws NullPointerException If the result instance is null
990 public final function getField ($fieldName) {
991 // Default field value
994 // Get result instance
995 $resultInstance = $this->getResultInstance();
997 // Is this instance null?
998 if (is_null($resultInstance)) {
999 // Then the user instance is no longer valid (expired cookies?)
1000 throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
1003 // Get current array
1004 $fieldArray = $resultInstance->current();
1006 // Does the field exist?
1007 if (isset($fieldArray[$fieldName])) {
1009 $fieldValue = $fieldArray[$fieldName];
1017 * Protected setter for user instance
1019 * @param $userInstance An instance of a user class
1022 protected final function setUserInstance (ManageableAccount $userInstance) {
1023 $this->userInstance = $userInstance;
1027 * Getter for user instance
1029 * @return $userInstance An instance of a user class
1031 public final function getUserInstance () {
1032 return $this->userInstance;