]> git.mxchange.org Git - shipsimu.git/blobdiff - inc/classes/main/class_BaseFrameworkSystem.php
Typos fixed and special command resolver are now possible
[shipsimu.git] / inc / classes / main / class_BaseFrameworkSystem.php
index e0716d7ade32f511558a1b5f28b25e56fd164c62..0c490f1ee7d1d7362552cd75eb3a2548df527264 100644 (file)
@@ -83,16 +83,6 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         */
        private $realClass      = "FrameworkSystem";
 
-       /**
-        * A human-readable description for this simulator part
-        */
-       private $objectDescription      = "Namenlose Framework-Einheit";
-
-       /**
-        * The unique ID string for identifying all type of classes
-        */
-       private $uniqueID = "";
-
        /**
         * Thousands seperator
         */
@@ -202,8 +192,9 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                // Set real class
                $this->setRealClass($className);
 
-               // Initialize the class if the registry is there
+               // Initialize the class if class Registry is there
                if ((class_exists('Registry')) && (Registry::isInitialized() === false)) {
+                       // Initialize the registry automatically
                        $this->initInstance();
                } // END - if
        }
@@ -218,12 +209,10 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                // Is this object already destroyed?
                if ($this->__toString() != 'DestructedObject') {
                        // Destroy all informations about this class but keep some text about it alive
-                       $this->setObjectDescription(sprintf("Removed object <em>%s</em>", $this->__toString()));
                        $this->setRealClass('DestructedObject');
-                       $this->resetUniqueID();
                } elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
                        // Already destructed object
-                       $this->debugOutput(sprintf("[%s:] The object <strong>%s</strong> is already destroyed.",
+                       $this->debugOutput(sprintf("[%s:] The object <span class=\"object_name\">%s</span> is already destroyed.",
                                __CLASS__, $this->__toString()
                        ));
                }
@@ -244,7 +233,13 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                        // Some arguments are there
                        foreach ($args as $arg) {
                                // Add the type
-                               $argsString .= $arg." (".gettype($arg)."), ";
+                               $argsString .= $arg." (".gettype($arg);
+
+                               // Add length if type is string
+                               if (gettype($arg) == 'string') $argsString .= ", ".strlen($arg);
+
+                               // Closing bracket
+                               $argsString .= "), ";
                        } // END - foreach
 
                        // Remove last comma
@@ -275,6 +270,9 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        private final function initInstance () {
                // Is this a system class?
                if (!in_array($this->__toString(), $this->systemClasses)) {
+                       // Set configuration instance
+                       $this->setConfigInstance(FrameworkConfiguration::getInstance());
+
                        // Add application helper to our class
                        $this->systemclasses[] = $this->getConfigInstance()->readConfig('app_helper_class');
 
@@ -287,7 +285,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 
                        // Set the compressor channel
                        $this->setCompressorChannel(CompressorChannel::createCompressorChannel(sprintf("%s%s",
-                               PATH,
+                               $this->getConfigInstance()->readConfig('base_path'),
                                $this->getConfigInstance()->readConfig('compressor_base_path')
                        )));
 
@@ -295,7 +293,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                        Registry::isInitialized('OK');
                } elseif ($this->__toString() == 'DebugMiddleware') {
                        // Set configuration instance
-                       $this->setConfigInstance(FrameworkConfiguration::createFrameworkConfiguration());
+                       $this->setConfigInstance(FrameworkConfiguration::getInstance());
                }
        }
 
@@ -563,181 +561,6 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                $this->realClass = $realClass;
        }
 
-       /**
-        * Generate unique ID from a lot entropy
-        *
-        * @return      void
-        */
-       public final function generateUniqueId () {
-               // Is the id set for this class?
-               if (empty($this->uniqueID)) {
-
-                       // Correct missing class name
-                       $corrected = false;
-                       if ($this->__toString() == "") {
-                               $this->setRealClass(__CLASS__);
-                               $corrected = true;
-                       }
-
-                       // Cache datbase instance
-                       $db = $this->getDatabaseInstance();
-
-                       // Generate new id
-                       $tempID = false;
-                       while (true) {
-                               // Generate a unique ID number
-                               $tempID = $this->generateIdNumber();
-                               $isUsed = false;
-
-                               // Try to figure out if the ID number is not yet used
-                               try {
-                                       // Is this a registry?
-                                       if ($this->__toString() == "Registry") {
-                                               // Registry, then abort here
-                                               break;
-                                       } elseif (is_object($db)) {
-                                               $isUsed = $db->isUniqueIdUsed($tempID, true);
-                                       }
-                               } catch (FrameworkException $e) {
-                                       // Catches all and ignores all ;-)
-                               }
-
-                               if (
-                                       (
-                                               $tempID !== false
-                                       ) && (
-                                               (
-                                                       $db === null
-                                               ) || (
-                                                       (
-                                                               is_object($db)
-                                                       ) && (
-                                                               !$isUsed
-                                                       )
-                                               )
-                                       )
-                               ) {
-                                       // Abort the loop
-                                       break;
-                               }
-                       } // END - while
-
-                       // Apply the new ID
-                       $this->setUniqueID($tempID);
-
-                       // Revert maybe corrected class name
-                       if ($corrected) {
-                               $this->setRealClass("");
-                       }
-
-                       // Remove system classes if we are in a system class
-                       if ((isset($this->systemClasses)) && (in_array($this->__toString(), $this->systemClasses))) {
-                               // This may save some RAM...
-                               $this->removeSystemArray();
-                       }
-               }
-       }
-
-       /**
-        * Generates a new ID number for classes based from the class' real name,
-        * the description and some random data
-        *
-        * @return      $tempID The new (temporary) ID number
-        */
-       private final function generateIdNumber () {
-               return sprintf("%s@%s",
-                       $this->__toString(),
-                       md5(sprintf("%s:%s:%s:%s:%s:%s",
-                               $this->__toString(),
-                               $this->getObjectDescription(),
-                               time(),
-                               getenv('REMOTE_ADDR'),
-                               getenv('SERVER_ADDR'),
-                               mt_rand()
-                       ))
-               );
-       }
-
-       /**
-        * Setter for unique ID
-        *
-        * @param               $uniqueID               The newly generated unique ID number
-        * @return      void
-        */
-       private final function setUniqueID ($uniqueID) {
-               // Cast to string
-               $uniqueID = (string) $uniqueID;
-
-               // Set the ID number
-               $this->uniqueID = $uniqueID;
-       }
-
-       /**
-        * Getter for unique ID
-        *
-        * @return      $uniqueID               The unique ID of this class
-        */
-       public final function getUniqueID () {
-               return $this->uniqueID;
-       }
-
-       /**
-        * Resets or recreates the unique ID number
-        *
-        * @return      void
-        */
-       public final function resetUniqueID() {
-               // Sweet and simple... ;-)
-               $newUniqueID = $this->generateIdNumber();
-               $this->setUniqueID($newUniqueID);
-       }
-
-       /**
-        * Getter for simulator description
-        *
-        * @return      $objectDescription      The description of this simulation part
-        */
-       public final function getObjectDescription () {
-               return $this->objectDescription;
-       }
-
-       /**
-        * Setter for simulation part description
-        *
-        * @param               $objectDescription      The description as string for this simulation part
-        * @return      void
-        */
-       public final function setObjectDescription ($objectDescription) {
-               $this->objectDescription = (String) $objectDescription;
-       }
-
-       /**
-        * Validate if given object is the same as current
-        *
-        * @param       $object An object instance for comparison with this class
-        * @return      boolean The result of comparing both's unique ID
-        */
-       public final function equals (FrameworkInterface $object) {
-               return ($this->getUniqueID() == $object->getUniqueID());
-       }
-
-       /**
-        * Compare if both simulation part description and class name matches
-        * (shall be enough)
-        *
-        * @param       $itemInstance   An object instance to an other class
-        * @return      boolean                 The result of comparing class name simulation part description
-        */
-       public function itemMatches ($itemInstance) {
-               return (
-                       (
-                               $this->__toString()   == $itemInstance->__toString()
-                       ) && (
-                               $this->getObjectDescription() == $itemInstance->getObjectDescription()
-                       )
-               );
-       }
-
        /**
         * Compare class name of this and given class name
         *
@@ -752,6 +575,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * Stub method (only real cabins shall override it)
         *
         * @return      boolean false = is no cabin, true = is a cabin
+        * @deprecated
         */
        public function isCabin () {
                return false;
@@ -762,6 +586,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         *
         * @return      boolean false = is not tradeable by the Merchant class,
         *                                      true  = is a tradeable object
+        * @deprecated
         */
        public function isTradeable () {
                return false;
@@ -838,40 +663,6 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                unset($this->systemClasses);
        }
 
-       /**
-        * Create a file name and path name from the object's unique ID number.
-        * The left part of the ID shall always be a valid class name and the
-        * right part an ID number.
-        *
-        * @return      $pfn    The file name with a prepended path name
-        * @throws      NoArrayCreatedException         If explode() fails to create an array
-        * @throws      InvalidArrayCountException      If the array contains less or
-        *                                                                              more than two elements
-        */
-       public final function getPathFileNameFromObject () {
-               // Get the main object's unique ID. We use this as a path/filename combination
-               $pathFile = $this->getUniqueID();
-
-               // Split it up in path and file name
-               $pathFile = explode("@", $pathFile);
-
-               // Are there two elements? Index 0 is the path, 1 the file name + global extension
-               if (!is_array($pathFile)) {
-                       // No array found
-                       throw new NoArrayCreatedException(array($this, 'pathFile'), self::EXCEPTION_ARRAY_EXPECTED);
-               } elseif (count($pathFile) != 2) {
-                       // Invalid ID returned!
-                       throw new InvalidArrayCountException(array($this, 'pathFile', count($pathFile), 2), self::EXCEPTION_ARRAY_HAS_INVALID_COUNT);
-               }
-
-               // Auto-append missing trailing slash
-               $pathFile[0] = $this->addMissingTrailingSlash($pathFile[0]);
-
-               // Create the file name and return it
-               $pfn = ($pathFile[0] . $pathFile[1]);
-               return $pfn;
-       }
-
        /**
         * Appends a trailing slash to a string
         *
@@ -933,8 +724,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                } // END - if
 
                // Generate FQFN for all application templates
-               $fqfn = sprintf("%s%s/%s/%s",
-                       PATH,
+               $fqfn = sprintf("%s%s/%s",
                        $this->getConfigInstance()->readConfig('application_path'),
                        strtolower($appInstance->getAppShortName()),
                        $this->getConfigInstance()->readConfig('tpl_base_path')
@@ -959,14 +749,24 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        /**
         * Debugs this instance by putting out it's full content
         *
+        * @param       $message        Optional message to show in debug output
         * @return      void
         */
-       public final function debugInstance () {
+       public final function debugInstance ($message = "") {
                // Restore the error handler to avoid trouble with missing array elements or undeclared variables
                restore_error_handler();
 
+               // Init content
+               $content = "";
+
+               // Is a message set?
+               if (!empty($message)) {
+                       // Construct message
+                       $content = sprintf("<div class=\"debug_message\">Message: %s</div>\n", $message);
+               } // END - if
+
                // Generate the output
-               $content = sprintf("<pre>%s</pre>",
+               $content .= sprintf("<pre>%s</pre>",
                        trim(
                                htmlentities(
                                        print_r($this, true)
@@ -975,7 +775,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                );
 
                // Output it
-               ApplicationEntryPoint::app_die(sprintf("<strong>%s debug output:</strong><div id=\"debug_content\">%s</div>\nLoaded includes: <div id=\"debug_include_list\">%s</div>",
+               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>",
                        $this->__toString(),
                        $content,
                        ClassLoader::getInstance()->getPrintableIncludeList()
@@ -1026,9 +826,9 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         */
        public function debugBackTrace () {
                // Sorry, there is no other way getting this nice backtrace
-               print "<pre>\n";
+               print("<pre>\n");
                debug_print_backtrace();
-               print "</pre>";
+               print("</pre>");
                exit;
        }
 
@@ -1047,7 +847,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                if (is_object($debugInstance)) {
                        // Use debug output handler
                        $debugInstance->output($message);
-                       if (!$doPrint) die(); // Die here if not printed
+                       if ($doPrint === false) die(); // Die here if not printed
                } else {
                        // Put directly out
                        if ($doPrint) {
@@ -1089,11 +889,13 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * @return      $markedCode             Marked PHP code
         */
        public function markupCode ($phpCode) {
+               // Init marked code
+               $markedCode = "";
+
                // Get last error
                $errorArray = error_get_last();
 
                // Init the code with error message
-               $markedCode = "";
                if (is_array($errorArray)) {
                        // Get error infos
                        $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>",
@@ -1105,10 +907,10 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                } // END - if
 
                // Add line number to the code
-               foreach (explode("\n", $phpCode) as $lineNo=>$code) {
+               foreach (explode("\n", $phpCode) as $lineNo => $code) {
                        // Add line numbers
                        $markedCode .= sprintf("<span id=\"code_line\">%s</span>: %s\n",
-                               ($lineNo+1),
+                               ($lineNo + 1),
                                htmlentities($code, ENT_QUOTES)
                        );
                } // END - foreach
@@ -1118,9 +920,9 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        }
 
        /**
-        * Filter a given timestamp to make it look more beatifull for web-based
-        * front-ends. If null is given a message id null_timestamp will be
-        * resolved and returned.
+        * Filter a given GMT timestamp (non Uni* stamp!) to make it look more
+        * beatiful for web-based front-ends. If null is given a message id
+        * null_timestamp will be resolved and returned.
         *
         * @param       $timestamp      Timestamp to prepare (filter) for display
         * @return      $readable       A readable timestamp
@@ -1134,7 +936,28 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                        // Get a message string
                        $readable = $this->getLanguageInstance()->getMessage('null_timestamp');
                } else {
-                       $this->partialStub("Do further analysis on timestamp {$timestamp}.");
+                       switch ($this->getLanguageInstance()->getLanguageCode()) {
+                               case "de": // German format is a bit different to default
+                                       // Split the GMT stamp up
+                                       $dateTime = explode(" ", $timestamp);
+                                       $dateArray = explode("-", $dateTime[0]);
+                                       $timeArray = explode(":", $dateTime[1]);
+
+                                       // Construct the timestamp
+                                       $readable = sprintf($this->getConfigInstance()->readConfig('german_date_time'),
+                                               $dateArray[0],
+                                               $dateArray[1],
+                                               $dateArray[2],
+                                               $timeArray[0],
+                                               $timeArray[1],
+                                               $timeArray[2]
+                                       );
+                                       break;
+
+                               default: // Default is pass-through
+                                       $readable = $timestamp;
+                                       break;
+                       }
                }
 
                // Return the stamp
@@ -1159,7 +982,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                $this->getResultInstance()->rewind();
 
                // Do we have an entry?
-               if (!$this->getResultInstance()->valid()) {
+               if ($this->getResultInstance()->valid() === false) {
                        throw new InvalidDatabaseResultException(array($this, $this->getResultInstance()), DatabaseResult::EXCEPTION_INVALID_DATABASE_RESULT);
                } // END - if