Typo fixed
[core.git] / inc / classes / main / class_BaseFrameworkSystem.php
index acea78ded4ebb8c49137d5e5648f86ea11c55906..fafe6b0310e0d9dcfe400acb403d4409e1870167 100644 (file)
@@ -76,17 +76,17 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        /**
         * The real class name
         */
-       private $realClass      = "FrameworkSystem";
+       private $realClass      = 'FrameworkSystem';
 
        /**
         * Thousands seperator
         */
-       private $thousands = "."; // German
+       private $thousands = '.'; // German
 
        /**
         * Decimal seperator
         */
-       private $decimals  = ","; // German
+       private $decimals  = ','; // German
 
        /***********************
         * Exception codes.... *
@@ -161,20 +161,19 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         *---------------------------------------------------------------------*
         */
        private $systemClasses = array(
-               "DebugMiddleware",                              // Debug middleware output sub-system
-               "Registry",                                             // Object registry
-               "ObjectFactory",                                // Object factory
-               "DebugWebOutput",                               // Debug web output sub-system
-               "WebOutput",                                    // Web output sub-system
-               "CompressorChannel",                    // Compressor sub-system
-               "DebugConsoleOutput",                   // Debug console output sub-system
-               "DebugErrorLogOutput",                  // Debug error_log() output sub-system
-               "FrameworkDirectoryPointer",    // Directory handler sub-system
-               "NullCompressor",                               // Null compressor
-               "Bzip2Compressor",                              // BZIP2 compressor
-               "GzipCompressor",                               // GZIP compressor
+               'DebugMiddleware',                              // Debug middleware output sub-system
+               'Registry',                                             // Object registry
+               'ObjectFactory',                                // Object factory
+               'DebugWebOutput',                               // Debug web output sub-system
+               'WebOutput',                                    // Web output sub-system
+               'CompressorChannel',                    // Compressor sub-system
+               'DebugConsoleOutput',                   // Debug console output sub-system
+               'DebugErrorLogOutput',                  // Debug error_log() output sub-system
+               'FrameworkDirectoryPointer',    // Directory handler sub-system
+               'NullCompressor',                               // Null compressor
+               'Bzip2Compressor',                              // BZIP2 compressor
+               'GzipCompressor',                               // GZIP compressor
        );
-
        /**
         * Protected super constructor
         *
@@ -209,7 +208,8 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                } elseif ((defined('DEBUG_DESTRUCTOR')) && (is_object($this->getDebugInstance()))) {
                        // Already destructed object
                        $this->debugOutput(sprintf("[%s:] The object <span class=\"object_name\">%s</span> is already destroyed.",
-                               __CLASS__, $this->__toString()
+                               __CLASS__,
+                               $this->__toString()
                        ));
                }
        }
@@ -221,30 +221,30 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         */
        public final function __call ($methodName, $args) {
                // Implode all given arguments
-               $argsString = "";
+               $argsString = '';
                if (empty($args)) {
                        // No arguments
-                       $argsString = "NULL";
+                       $argsString = 'NULL';
                } elseif (is_array($args)) {
                        // 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);
+                               if (gettype($arg) == 'string') $argsString .= ', '.strlen($arg);
 
                                // Closing bracket
-                               $argsString .= "), ";
+                               $argsString .= '), ';
                        } // END - foreach
 
                        // Remove last comma
-                       if (substr($argsString, -2, 1) === ",") {
+                       if (substr($argsString, -2, 1) == ',') {
                                $argsString = substr($argsString, 0, -2);
                        } // END - if
                } else {
                        // Invalid arguments!
-                       $argsString = sprintf("!INVALID:%s!", $args);
+                       $argsString = '!INVALID:' . gettype($args) . '!';
                }
 
                // Output stub message
@@ -280,10 +280,10 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                        $this->setWebOutputInstance($outputInstance);
 
                        // Set the compressor channel
-                       $this->setCompressorChannel(CompressorChannel::createCompressorChannel(sprintf("%s%s",
-                               $this->getConfigInstance()->readConfig('base_path'),
+                       $this->setCompressorChannel(CompressorChannel::createCompressorChannel(
+                               $this->getConfigInstance()->readConfig('base_path').
                                $this->getConfigInstance()->readConfig('compressor_base_path')
-                       )));
+                       ));
 
                        // Initialization done! :D
                        Registry::isInitialized('OK');
@@ -403,11 +403,11 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        /**
         * Getter for configuration instance
         *
-        * @return      $cfgInstance    Configuration instance
+        * @return      $configInstance         Configuration instance
         */
        public final function getConfigInstance () {
-               $cfgInstance = Registry::getRegistry()->getInstance('config');
-               return $cfgInstance;
+               $configInstance = Registry::getRegistry()->getInstance('config');
+               return $configInstance;
        }
 
        /**
@@ -623,7 +623,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         *                                                                                              thousands seperator
         *                                                                                              is missing
         */
-       public function formatCurrency ($value, $currency = "&euro;", $decNum = 2) {
+       public function formatCurrency ($value, $currency = '&euro;', $decNum = 2) {
                // Are all required attriutes set?
                if ((!isset($this->decimals)) || (!isset($this->thousands))) {
                        // Throw an exception
@@ -634,10 +634,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                $value = (float) $value;
 
                // Reformat the US number
-               $price = sprintf("%s %s",
-                       number_format($value, $decNum, $this->decimals, $this->thousands),
-                       $currency
-               );
+               $price = number_format($value, $decNum, $this->decimals, $this->thousands) . $currency;
 
                // Return as string...
                return $price;
@@ -691,7 +688,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         */
        public final function addMissingTrailingSlash ($str) {
                // Is there a trailing slash?
-               if (substr($str, -1, 1) != "/") $str .= "/";
+               if (substr($str, -1, 1) != '/') $str .= '/';
                return $str;
        }
 
@@ -772,12 +769,12 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * @param       $message        Optional message to show in debug output
         * @return      void
         */
-       public final function debugInstance ($message = "") {
+       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 = "";
+               $content = '';
 
                // Is a message set?
                if (!empty($message)) {
@@ -808,12 +805,12 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * @param       $message        An optional message to display
         * @return      void
         */
-       protected function partialStub ($message = "") {
+       protected function partialStub ($message = '') {
                // Get the backtrace
                $backtrace = debug_backtrace();
 
                // Generate the class::method string
-               $methodName = "UnknownClass-&gt;unknownMethod";
+               $methodName = 'UnknownClass-&gt;unknownMethod';
                if ((isset($backtrace[1]['class'])) && (isset($backtrace[1]['function']))) {
                        $methodName = $backtrace[1]['class']."-&gt;".$backtrace[1]['function'];
                } // END - if
@@ -887,13 +884,13 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         */
        public function convertToClassName ($str) {
                // Init class name
-               $className = "";
+               $className = '';
 
                // Convert all dashes in underscores
-               $str = str_replace("-", "_", $str);
+               $str = $this->convertDashesToUnderscores($str);
 
                // Now use that underscores to get classname parts for hungarian style
-               foreach (explode("_", $str) as $strPart) {
+               foreach (explode('_', $str) as $strPart) {
                        // Make the class name part lower case and first upper case
                        $className .= ucfirst(strtolower($strPart));
                } // END - foreach
@@ -902,6 +899,20 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                return $className;
        }
 
+       /**
+        * Converts dashes to underscores, e.g. useable for configuration entries
+        *
+        * @param       $str    The string with maybe dashes inside
+        * @return      $str    The converted string with no dashed, but underscores
+        */
+       public final function convertDashesToUnderscores ($str) {
+               // Convert them all
+               $str = str_replace('-', '_', $str);
+
+               // Return converted string
+               return $str;
+       }
+
        /**
         * Marks up the code by adding e.g. line numbers
         *
@@ -910,7 +921,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         */
        public function markupCode ($phpCode) {
                // Init marked code
-               $markedCode = "";
+               $markedCode = '';
 
                // Get last error
                $errorArray = error_get_last();
@@ -949,7 +960,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         */
        public function doFilterFormatTimestamp ($timestamp) {
                // Default value to return
-               $readable = "???";
+               $readable = '???';
 
                // Is the timestamp null?
                if (is_null($timestamp)) {
@@ -959,9 +970,9 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                        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]);
+                                       $dateTime  = explode(' ', $timestamp  );
+                                       $dateArray = explode('-', $dateTime[0]);
+                                       $timeArray = explode(':', $dateTime[1]);
 
                                        // Construct the timestamp
                                        $readable = sprintf($this->getConfigInstance()->readConfig('german_date_time'),