Debug mailer finished and debug messages removed:
[shipsimu.git] / inc / classes / main / class_BaseFrameworkSystem.php
index 0707487b3c3ae76f659fa89f8277d0aaf078ac68..4a6eb893e0418d524b38ba71681d6e859dc27db6 100644 (file)
@@ -158,6 +158,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        const EXCEPTION_FILE_NOT_FOUND               = 0x036;
        const EXCEPTION_ASSERTION_FAILED             = 0x037;
        const EXCEPTION_FILE_CANNOT_BE_READ          = 0x038;
+       const EXCEPTION_DATABASE_UPDATED_NOT_ALLOWED = 0x039;
 
        /**
         * In the super constructor these system classes shall be ignored or else
@@ -217,7 +218,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                        $this->resetUniqueID();
                } elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
                        // Already destructed object
-                       $this->getDebugInstance()->output(sprintf("[%s:] The object <strong>%s</strong> is already destroyed.",
+                       $this->debugOutput(sprintf("[%s:] The object <strong>%s</strong> is already destroyed.",
                                __CLASS__, $this->__toString()
                        ));
                }
@@ -284,7 +285,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                }
 
                // Output stub message
-               $this->getDebugInstance()->output(sprintf("[%s-&gt;%s] Stub! Args: %s",
+               $this->debugOutput(sprintf("[%s-&gt;%s] Stub! Args: %s",
                        $this->__toString(),
                        $methodName,
                        $argsString
@@ -955,8 +956,8 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                        if (is_null($appInstance)) {
                                // Thrown an exception
                                throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
-                       }
-               }
+                       } // END - if
+               } // END - if
 
                // Generate FQFN for all application templates
                $fqfn = sprintf("%s%s/%s/%s",
@@ -988,13 +989,20 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * @return      void
         */
        public final function debugInstance () {
+               // Restore the error handler to avoid trouble with missing array elements or undeclared variables
+               restore_error_handler();
+
                // Generate the output
                $content = sprintf("<pre>%s</pre>",
-                       trim(print_r($this, true))
+                       trim(
+                               htmlentities(
+                                       print_r($this, true)
+                               )
+                       )
                );
 
                // Output it
-               ApplicationEntryPoint::app_die(sprintf("<strong>%s debug output:</strong><div id=\"debug_content\">%s</div>Loaded includes: <div id=\"debug_include_list\">%s</div>",
+               ApplicationEntryPoint::app_die(sprintf("<strong>%s debug output:</strong><div id=\"debug_content\">%s</div>\nLoaded includes: <div id=\"debug_include_list\">%s</div>",
                        $this->__toString(),
                        $content,
                        ClassLoader::getInstance()->getPrintableIncludeList()
@@ -1015,7 +1023,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                $methodName = "UnknownClass-&gt;unknownMethod";
                if ((isset($backtrace[1]['class'])) && (isset($backtrace[1]['function']))) {
                        $methodName = $backtrace[1]['class']."-&gt;".$backtrace[1]['function'];
-               }
+               } // END - if
 
                // Construct the full message
                $stubMessage = sprintf("[%s:] Partial stub!",
@@ -1026,12 +1034,12 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                if (!empty($message)) {
                        // Then add it as well
                        $stubMessage .= sprintf(" Message: <span id=\"stub_message\">%s</span>", $message);
-               }
+               } // END - if
 
                // Debug instance is there?
                if (!is_null($this->getDebugInstance())) {
                        // Output stub message
-                       $this->getDebugInstance()->output($stubMessage);
+                       $this->debugOutput($stubMessage);
                } else {
                        // Trigger an error
                        trigger_error($stubMessage."<br />\n");
@@ -1055,10 +1063,10 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * Outputs a debug message wether to debug instance (should be set!) or dies with or pints the message
         *
         * @param       $message        Message we shall send out...
-        * @param       $doPrint        Wether we shall print or die here which last is the default
+        * @param       $doPrint        Wether we shall print or die here which first is the default
         * @return      void
         */
-       public function debugOutput ($message, $doPrint = false) {
+       public function debugOutput ($message, $doPrint = true) {
                // Get debug instance
                $debugInstance = $this->getDebugInstance();
 
@@ -1069,10 +1077,10 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                        if (!$doPrint) die(); // Die here if not printed
                } else {
                        // Put directly out
-                       // DO NOT REWRITE THIS TO app_die() !!!
                        if ($doPrint) {
                                print($message);
                        } else {
+                               // DO NOT REWRITE THIS TO app_die() !!!
                                die($message);
                        }
                }
@@ -1159,6 +1167,106 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                // Return the stamp
                return $readable;
        }
+
+       /**
+        * "Getter" for databse entry
+        *
+        * @return      $entry  An array with database entries
+        * @throws      NullPointerException    If the database result is not found
+        * @throws      InvalidDatabaseResultException  If the database result is invalid
+        */
+       protected final function getDatabaseEntry () {
+               // Is there an instance?
+               if (is_null($this->getResultInstance())) {
+                       // Throw an exception here
+                       throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
+               } // END - if
+
+               // Rewind it
+               $this->getResultInstance()->rewind();
+
+               // Do we have an entry?
+               if (!$this->getResultInstance()->valid()) {
+                       throw new InvalidDatabaseResultException(array($this, $this->getResultInstance()), DatabaseResult::EXCEPTION_INVALID_DATABASE_RESULT);
+               } // END - if
+
+               // Get next entry
+               $this->getResultInstance()->next();
+
+               // Fetch it
+               $entry = $this->getResultInstance()->current();
+
+               // And return it
+               return $entry;
+       }
+
+       /**
+        * Getter for field name
+        *
+        * @param       $fieldName              Field name which we shall get
+        * @return      $fieldValue             Field value from the user
+        * @throws      NullPointerException    If the result instance is null
+        */
+       public final function getField ($fieldName) {
+               // Default field value
+               $fieldValue = null;
+
+               // Get result instance
+               $resultInstance = $this->getResultInstance();
+
+               // Is this instance null?
+               if (is_null($resultInstance)) {
+                       // Then the user instance is no longer valid (expired cookies?)
+                       throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
+               } // END - if
+
+               // Get current array
+               $fieldArray = $resultInstance->current();
+
+               // Does the field exist?
+               if (isset($fieldArray[$fieldName])) {
+                       // Get it
+                       $fieldValue = $fieldArray[$fieldName];
+               } // END - if
+
+               // Return it
+               return $fieldValue;
+       }
+
+       /**
+        * Updates a given field with new value
+        *
+        * @param       $fieldName              Field to update
+        * @param       $fieldValue             New value to store
+        * @return      void
+        * @throws      DatabaseUpdateSupportException  If this class does not support database updates
+        */
+       public function updateDatabaseField ($fieldName, $fieldValue) {
+               // Is updating database fields allowed by interface?
+               if (!$this instanceof Updateable) {
+                       // Update not supported!
+                       throw new DatabaseUpdateSupportException($this, self::EXCEPTION_DATABASE_UPDATED_NOT_ALLOWED);
+               } // END - if
+
+               // Get a critieria instance
+               $searchInstance = ObjectFactory::createObjectByConfiguredName('search_criteria_class');
+
+               // Add search criteria
+               $searchInstance->addCriteria(UserDatabaseWrapper::DB_COLUMN_USERNAME, $this->getUserName());
+               $searchInstance->setLimit(1);
+
+               // Now get another criteria
+               $updateInstance = ObjectFactory::createObjectByConfiguredName('update_criteria_class');
+
+               // And add our both entries
+               $updateInstance->addCriteria($fieldName, $fieldValue);
+
+               // Add the search criteria for searching for the right entry
+               $updateInstance->setSearchInstance($searchInstance);
+
+               // Remember the update in database result
+               $this->getResultInstance()->add2UpdateQueue($updateInstance);
+       }
 }
 
 // [EOF]