]> git.mxchange.org Git - shipsimu.git/blobdiff - inc/classes/main/class_BaseFrameworkSystem.php
Simple exception handler and error handler added, profile update added with stubs
[shipsimu.git] / inc / classes / main / class_BaseFrameworkSystem.php
index 1ccb1c2c765fdb5d588fad9b0a122e9cd0676dc2..9432fa656ccb117cc29bf1dd6c58e01a308da587 100644 (file)
  */
 class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        /**
-        * The instance to the debug output handler (should be DebugConsoleOutput or DebugWebOutput)
-        *
-        * @see         DebugConsoleOutput
-        * @see         DebugWebOutput
-        */
-       private static $debug       = null;
-
-       /**
-        * The instance to the web output handler (should be WebOutput)
-        *
-        * @see         WebOutput
+        * Instance to an application helper class
         */
-       private static $webOutput   = null;
+       private static $applicationInstance = null;
 
        /**
-        * The instance to the compression layer which should be CompressorChannel
+        * The language instance for the template loader
         */
-       private static $compressor  = null;
+       private static $langInstance = null;
 
        /**
-        * The configuration instance which shall be FrameworkConfiguration
+        * Instance of a request class
         */
-       private static $cfgInstance = null;
+       private $requestInstance = null;
 
        /**
-        * The instance to the database layer which should be DatabaseConnection
+        * Instance of a response class
         */
-       private $dbInstance  = null;
+       private $responseInstance = null;
 
        /**
-        * Instance to an application helper class
+        * Search criteria instance
         */
-       private $applicationInstance = null;
+       private $searchInstance = null;
 
        /**
         * The real class name
@@ -83,15 +73,10 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         */
        private $decimals  = ","; // German
 
-       /**
-        * The language instance for the template loader
-        */
-       private $langInstance = null;
-
        /**
         * The file I/O instance for the template loader
         */
-       private $fileIOInstance = null;
+       private $fileIoInstance = null;
 
        /***********************
         * Exception codes.... *
@@ -150,6 +135,9 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        const EXCEPTION_HEADERS_ALREADY_SENT         = 0x033;
        const EXCEPTION_DEFAUL_CONTROLLER_GONE       = 0x034;
        const EXCEPTION_CLASS_NOT_FOUND              = 0x035;
+       const EXCEPTION_REQUIRED_INTERFACE_MISSING   = 0x036;
+       const EXCEPTION_FATAL_ERROR                  = 0x037;
+       const EXCEPTION_FILE_NOT_FOUND               = 0x038;
 
        /**
         * In the super constructor these system classes shall be ignored or else
@@ -161,17 +149,22 @@ 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
-               "CompressorChannel",                    // Compressor sub-system
                "FrameworkDirectoryPointer",    // Directory handler sub-system
                "NullCompressor",                               // Null compressor
                "Bzip2Compressor",                              // BZIP2 compressor
                "GzipCompressor",                               // GZIP compressor
-               "WebOutput",                                    // Web output sub-system
        );
 
+       /* No longer used:
+       */
+
        /**
         * Private super constructor
         *
@@ -181,8 +174,10 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                // Set real class
                $this->setRealClass($class);
 
-               // Init this instance
-               $this->initInstance($class);
+               // Initialize the class if the registry is there
+               if ((class_exists('Registry')) && (Registry::isInitialized() === false)) {
+                       $this->initInstance();
+               }
        }
 
        /**
@@ -236,7 +231,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                                } elseif (is_float($arg)) {
                                        // Floating point
                                        $argsString .= $arg."(float)";
-                               } elseif ($arg instanceof BaseFramework) {
+                               } elseif ($arg instanceof BaseFrameworkSystem) {
                                        // Own object instance
                                        $argsString .= $arg->__toString()."(Object)";
                                } elseif (is_object($arg)) {
@@ -248,6 +243,9 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                                } elseif (is_string($arg)) {
                                        // String
                                        $argsString .= "\"".$arg."\"(string)";
+                               } elseif (is_null($arg)) {
+                                       // Null
+                                       $argsString .= "(null)";
                                } else {
                                        // Unknown type (please report!)
                                        $argsString .= $arg."(unknown!)";
@@ -275,71 +273,46 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        }
 
        /**
-        * Initializes the instance
+        * Private initializer for this class
         *
         * @return      void
         */
-       public function initInstance ($class) {
-               // Get the current (singleton) configuration instance
-               $this->setConfigInstance(FrameworkConfiguration::createFrameworkConfiguration());
-
-               // Is the class weather debug nor compressor channel?
-               if (!in_array($class, $this->systemClasses)) {
-                       // Initialize debug instance
-                       if (is_null($this->getDebugInstance())) {
-                               // Set the debug output system if it is not debug class ;)
-                               $this->setDebugInstance(DebugMiddleware::createDebugMiddleware($this->getConfigInstance()->readConfig('debug_engine')));
-                       }
-
-                       // Initialize web instance
-                       if (is_null($this->getWebOutputInstance())) {
-                               // Generate the eval() command
-                               $eval = sprintf("\$this->setWebOutputInstance(%s::create%s(\"%s\"));",
-                                       $this->getConfigInstance()->readConfig('web_engine'),
-                                       $this->getConfigInstance()->readConfig('web_engine'),
-                                       $this->getConfigInstance()->readConfig('web_content_type')
-                               );
-
-                               // Debug message
-                               if (defined('DEBUG_EVAL')) $this->getDebugInstance()->output(sprintf("[%s:] Constructed PHP command: <pre><em>%s</em></pre><br />\n",
-                                       $this->__toString(),
-                                       htmlentities($eval)
-                               ));
-
-                               // Run the command
-                               eval($eval);
-                       }
-
-                       // Initialize compressor channel
-                       if (is_null($this->getCompressorChannel())) {
-                               // Set the compressor channel
-                               $this->setCompressorChannel(CompressorChannel::createCompressorChannel(sprintf("%s%s",
-                                       PATH,
-                                       $this->getConfigInstance()->readConfig('compressor_base_path')
-                               )));
-                       }
-
-                       // Initialize database middleware
-                       if (is_null($this->getDatabaseInstance())) {
-                               // Get the middleware instance
-                               $db = DatabaseConnection::getInstance();
-                               if (is_object($db)) {
-                                       // Set the database middleware
-                                       $this->setDatabaseInstance($db);
-                               }
-                       }
+       private final function initInstance () {
+               // Is this a system class?
+               if (!in_array($this->__toString(), $this->systemClasses)) {
+                       // Add application helper to our class
+                       $this->systemclasses[] = $this->getConfigInstance()->readConfig('app_helper_class');
+
+                       // Set debug instance
+                       $this->setDebugInstance(DebugMiddleware::createDebugMiddleware($this->getConfigInstance()->readConfig('debug_class')));
+
+                       // Get output instance and set it
+                       $outputInstance = ObjectFactory::createObjectByConfiguredName('web_engine', array($this->getConfigInstance()->readConfig('web_content_type')));
+                       $this->setWebOutputInstance($outputInstance);
+
+                       // Set the compressor channel
+                       $this->setCompressorChannel(CompressorChannel::createCompressorChannel(sprintf("%s%s",
+                               PATH,
+                               $this->getConfigInstance()->readConfig('compressor_base_path')
+                       )));
+
+                       // Initialization done! :D
+                       Registry::isInitialized("OK");
+               } elseif ($this->__toString() == "DebugMiddleware") {
+                       // Set configuration instance
+                       $this->setConfigInstance(FrameworkConfiguration::createFrameworkConfiguration());
                }
        }
 
        /**
         * Setter for language instance
         *
-        * @param       $configInstance The configuration instance which shall
-        *                                                      be FrameworkConfiguration
+        * @param       $configInstance         The configuration instance which shall
+        *                                                              be FrameworkConfiguration
         * @return      void
         */
        public final function setConfigInstance (FrameworkConfiguration $configInstance) {
-               self::$cfgInstance = $configInstance;
+               Registry::getRegistry()->addInstance('config', $configInstance);
        }
 
        /**
@@ -348,7 +321,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * @return      $cfhInstance - Configuration instance
         */
        protected final function getConfigInstance () {
-               return self::$cfgInstance;
+               return Registry::getRegistry()->getInstance('config');
        }
 
        /**
@@ -358,7 +331,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * @return      void
         */
        public final function setDebugInstance (DebugMiddleware $debugInstance) {
-               self::$debug = $debugInstance;
+               Registry::getRegistry()->addInstance('debug', $debugInstance);
        }
 
        /**
@@ -367,7 +340,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * @return      $debug - Instance to class DebugConsoleOutput or DebugWebOutput
         */
        public final function getDebugInstance () {
-               return self::$debug;
+               return Registry::getRegistry()->getInstance('debug');
        }
 
        /**
@@ -377,7 +350,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * @return      void
         */
        public final function setWebOutputInstance (OutputStreamer $webInstance) {
-               self::$webOutput = $webInstance;
+               Registry::getRegistry()->addInstance('web_output', $webInstance);
        }
 
        /**
@@ -386,18 +359,107 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * @return      $webOutput - Instance to class WebOutput
         */
        public final function getWebOutputInstance () {
-               return self::$webOutput;
+               return Registry::getRegistry()->getInstance('web_output');
        }
 
        /**
-        * Static setter for database instance
+        * Setter for database instance
         *
         * @param               $dbInstance     The instance for the database connection
         *                                      (forced DatabaseConnection)
         * @return      void
         */
        public final function setDatabaseInstance (DatabaseConnection $dbInstance) {
-               $this->dbInstance = $dbInstance;
+               Registry::getRegistry()->addInstance('dbInstance', $dbInstance);
+       }
+
+       /**
+        * Getter for database layer
+        *
+        * @return      $dbInstance     The database layer instance
+        */
+       public final function getDatabaseInstance () {
+               if ((class_exists('Registry')) && (Registry::isInitialized() === true)) {
+                       return Registry::getRegistry()->getInstance('dbInstance');
+               } else {
+                       return null;
+               }
+       }
+
+       /**
+        * Setter for compressor channel
+        *
+        * @param               $compressorChannel      An instance of CompressorChannel
+        * @return      void
+        */
+       public final function setCompressorChannel (CompressorChannel $compressorChannel) {
+               Registry::getRegistry()->addInstance('compressor', $compressorChannel);
+       }
+
+       /**
+        * Getter for compressor channel
+        *
+        * @return      $compressor     The compressor channel
+        */
+       public final function getCompressorChannel () {
+               return Registry::getRegistry()->getInstance('compressor');
+       }
+
+       /**
+        * Protected getter for a manageable application helper class
+        *
+        * @return      $applicationInstance    An instance of a manageable application helper class
+        */
+       protected final function getApplicationInstance () {
+               return self::$applicationInstance;
+       }
+
+       /**
+        * Setter for a manageable application helper class
+        *
+        * @param       $applicationInstance    An instance of a manageable application helper class
+        * @return      void
+        */
+       public final function setApplicationInstance (ManageableApplication $applicationInstance) {
+               self::$applicationInstance = $applicationInstance;
+       }
+
+       /**
+        * Setter for request instance
+        *
+        * @param       $requestInstance        An instance of a Requestable class
+        * @return      void
+        */
+       public final function setRequestInstance (Requestable $requestInstance) {
+               $this->requestInstance = $requestInstance;
+       }
+
+       /**
+        * Getter for request instance
+        *
+        * @return      $requestInstance        An instance of a Requestable class
+        */
+       public final function getRequestInstance () {
+               return $this->requestInstance;
+       }
+
+       /**
+        * Setter for response instance
+        *
+        * @param       $responseInstance       An instance of a Responseable class
+        * @return      void
+        */
+       public final function setResponseInstance (Responseable $responseInstance) {
+               $this->responseInstance = $responseInstance;
+       }
+
+       /**
+        * Getter for response instance
+        *
+        * @return      $responseInstance       An instance of a Responseable class
+        */
+       public final function getResponseInstance () {
+               return $this->responseInstance;
        }
 
        /**
@@ -428,8 +490,8 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         *
         * @return      void
         */
-       public final function createUniqueID () {
-               // Existiert noch keine?
+       public final function generateUniqueId () {
+               // Is the id set for this class?
                if (empty($this->uniqueID)) {
 
                        // Correct missing class name
@@ -439,7 +501,10 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                                $corrected = true;
                        }
 
-                       // Neue ID erstellen
+                       // Cache datbase instance
+                       $db = $this->getDatabaseInstance();
+
+                       // Generate new id
                        $tempID = false;
                        while (true) {
                                // Generate a unique ID number
@@ -448,8 +513,12 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
 
                                // Try to figure out if the ID number is not yet used
                                try {
-                                       if (is_object($this->getDatabaseInstance())) {
-                                               $isUsed = $this->getDatabaseInstance()->isUniqueIdUsed($tempID, true);
+                                       // 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 ;-)
@@ -460,10 +529,10 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                                                $tempID !== false
                                        ) && (
                                                (
-                                                       $this->getDatabaseInstance() === null
+                                                       $db === null
                                                ) || (
                                                        (
-                                                               is_object($this->getDatabaseInstance())
+                                                               is_object($db)
                                                        ) && (
                                                                !$isUsed
                                                        )
@@ -628,10 +697,10 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * Formats computer generated price values into human-understandable formats
         * with thousand and decimal seperators.
         *
-        * @param               $value  The in computer format value for a price
-        * @param               $currency       The currency symbol (use HTML-valid characters!)
-        * @param               $decNum Number of decimals after commata
-        * @return      $price  The for the current language formated price string
+        * @param       $value          The in computer format value for a price
+        * @param       $currency       The currency symbol (use HTML-valid characters!)
+        * @param       $decNum         Number of decimals after commata
+        * @return      $price          The for the current language formated price string
         * @throws      MissingDecimalsThousandsSeperatorException      If decimals or
         *                                                                                              thousands seperator
         *                                                                                              is missing
@@ -667,31 +736,23 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        }
 
        /**
-        * Getter for database layer
+        * Private getter for language instance
         *
-        * @return      $dbInstance     The database layer instance
+        * @return      $langInstance   An instance to the language sub-system
         */
-       public final function getDatabaseInstance () {
-               return $this->dbInstance;
+       protected final function getLanguageInstance () {
+               return self::$langInstance;
        }
 
        /**
-        * Setter for compressor channel
+        * Setter for language instance
         *
-        * @param               $compressorChannel      An instance of CompressorChannel
+        * @param       $langInstance   An instance to the language sub-system
         * @return      void
+        * @see         LanguageSystem
         */
-       public final function setCompressorChannel (CompressorChannel $compressorChannel) {
-               self::$compressor = $compressorChannel;
-       }
-
-       /**
-        * Getter for compressor channel
-        *
-        * @return      $compressor     The compressor channel
-        */
-       public final function getCompressorChannel () {
-               return self::$compressor;
+       public final function setLanguageInstance (ManageableLanguage $langInstance) {
+               self::$langInstance = $langInstance;
        }
 
        /**
@@ -749,62 +810,23 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                return $str;
        }
 
-       /**
-        * Private getter for language instance
-        *
-        * @return      $langInstance   An instance to the language sub-system
-        */
-       protected final function getLanguageInstance () {
-               return $this->langInstance;
-       }
-
-       /**
-        * Setter for language instance
-        *
-        * @param       $langInstance   An instance to the language sub-system
-        * @return      void
-        * @see         LanguageSystem
-        */
-       public final function setLanguageInstance (ManageableLanguage $langInstance) {
-               $this->langInstance = $langInstance;
-       }
-
        /**
         * Private getter for file IO instance
         *
-        * @return      $fileIOInstance An instance to the file I/O sub-system
+        * @return      $fileIoInstance An instance to the file I/O sub-system
         */
        protected final function getFileIoInstance () {
-               return $this->fileIOInstance;
+               return $this->fileIoInstance;
        }
 
        /**
         * Setter for file I/O instance
         *
-        * @param       $fileIOInstance An instance to the file I/O sub-system
-        * @return      void
-        */
-       public final function setFileIoInstance (FileIoHandler $fileIOInstance) {
-               $this->fileIOInstance = $fileIOInstance;
-       }
-
-       /**
-        * Protected getter for a manageable application helper class
-        *
-        * @return      $applicationInstance    An instance of a manageable application helper class
-        */
-       protected final function getApplicationInstance () {
-               return $this->applicationInstance;
-       }
-
-       /**
-        * Setter for a manageable application helper class
-        *
-        * @param       $applicationInstance    An instance of a manageable application helper class
+        * @param       $fileIoInstance An instance to the file I/O sub-system
         * @return      void
         */
-       public final function setApplicationInstance (ManageableApplication $applicationInstance) {
-               $this->applicationInstance = $applicationInstance;
+       public final function setFileIoInstance (FileIoHandler $fileIoInstance) {
+               $this->fileIoInstance = $fileIoInstance;
        }
 
        /**
@@ -854,36 +876,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                }
 
                // Initialize the template engine
-               $tplEngine = null;
-               $eval = sprintf("\$tplEngine = %s::create%s(
-       \"%s\",
-       \$appInstance->getLanguageInstance(),
-       \$appInstance->getFileIoInstance()
-);",
-                       $this->getConfigInstance()->readConfig('tpl_engine'),
-                       $this->getConfigInstance()->readConfig('tpl_engine'),
-                       $fqfn
-               );
-
-               // Debug message
-               if ((!is_null($this->getDebugInstance())) && (defined('DEBUG_EVAL'))) {
-                       $this->getDebugInstance()->output(sprintf("[%s:] Constructed PHP command: <pre><em>%s</em></pre><br />\n",
-                               $this->__toString(),
-                               htmlentities($eval)
-                       ));
-               }
-
-               // Run the command
-               eval($eval);
-
-               // Is it a valid instance?
-               if (is_null($tplEngine)) {
-                       // No class returned
-                       throw new NullPointerException($this, self::EXCEPTION_IS_NULL_POINTER);
-               } elseif (!$tplEngine instanceof CompileableTemplate) {
-                       // Not an object! ;-(
-                       throw new UnsupportedTemplateEngineException($tplEngine, self::EXCEPTION_TEMPLATE_ENGINE_UNSUPPORTED);
-               }
+               $tplEngine = ObjectFactory::createObjectByConfiguredName('template_class', array($fqfn, $appInstance->getLanguageInstance(), $appInstance->getFileIoInstance()));
 
                // Return the prepared instance
                return $tplEngine;
@@ -928,7 +921,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                // Is the extra message given?
                if (!empty($message)) {
                        // Then add it as well
-                       $stubMessage .= sprintf(" Message: <u>%s</u>", $message);
+                       $stubMessage .= sprintf(" Message: <span id=\"stub_message\">%s</span>", $message);
                }
 
                // Debug instance is there?
@@ -948,10 +941,19 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         * @return      $className      Generated class name
         */
        public function convertToClassName ($str) {
+               // Init class name
                $className = "";
+
+               // Convert all dashes in underscores
+               $str = str_replace("-", "_", $str);
+
+               // Now use that underscores to get classname parts for hungarian style
                foreach (explode("_", $str) as $strPart) {
+                       // Make the class name part lower case and first upper case
                        $className .= ucfirst(strtolower($strPart));
-               }
+               } // END - foreach
+
+               // Return class name
                return $className;
        }
 
@@ -967,6 +969,25 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                print "</pre>";
                exit;
        }
+
+       /**
+        * Setter for search instance
+        *
+        * @param       $searchInstance         Searchable criteria instance
+        * @return      void
+        */
+       public final function setSearchInstance (LocalSearchCriteria $searchInstance) {
+               $this->searchInstance = $searchInstance;
+       }
+
+       /**
+        * Getter for search instance
+        *
+        * @return      $searchInstance         Searchable criteria instance
+        */
+       public final function getSearchInstance () {
+               return $this->searchInstance;
+       }
 }
 
 // [EOF]