Directory prepared, missing variable fixed:
[core.git] / inc / classes / main / class_BaseFrameworkSystem.php
index c085e8e4d4d9667d736f453ad14ed793f8224746..9b153224b9a9398514f4364023f56f2642e7472c 100644 (file)
@@ -5,7 +5,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
+ * @copyright  Copyright (c) 2007, 2008 Roland Haeder, 2009, 2010 Core Developer Team
  * @license            GNU GPL 3.0 or any newer version
  * @link               http://www.ship-simu.org
  *
@@ -88,10 +88,45 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         */
        private $listInstance = null;
 
+       /**
+        * Instance of a menu
+        */
+       private $menuInstance = null;
+
+       /**
+        * Instance of the image
+        */
+       private $imageInstance = null;
+
+       /**
+        * Instance of the stacker
+        */
+       private $stackerInstance = null;
+
+       /**
+        * A Compressor instance
+        */
+       private $compressorInstance = null;
+
+       /**
+        * A Parseable instance
+        */
+       private $parserInstance = null;
+
+       /**
+        * A ProtocolHandler instance
+        */
+       private $protocolInstance = null;
+
+       /**
+        * A database wrapper instance
+        */
+       private $databaseInstance = null;
+
        /**
         * The real class name
         */
-       private $realClass      = 'BaseFrameworkSystem';
+       private $realClass = 'BaseFrameworkSystem';
 
        /**
         * Thousands seperator
@@ -103,6 +138,16 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         */
        private $decimals  = ','; // German
 
+       /**
+        * Socket resource
+        */
+       private $socketResource = false;
+
+       /**
+        * Package data
+        */
+       private $packageData = array();
+
        /***********************
         * Exception codes.... *
         ***********************/
@@ -221,7 +266,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                        // Some arguments are there
                        foreach ($args as $arg) {
                                // Add the type
-                               $argsString .= $arg . ' (' . gettype($arg);
+                               $argsString .= $this->replaceControlCharacters($arg) . ' (' . gettype($arg);
 
                                // Add length if type is string
                                if (gettype($arg) == 'string') $argsString .= ', '.strlen($arg);
@@ -330,7 +375,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        /**
         * Setter for resolver instance
         *
-        * @param       $resolverInstance               Instance of a command resolver class
+        * @param       $resolverInstance       Instance of a command resolver class
         * @return      void
         */
        public final function setResolverInstance (Resolver $resolverInstance) {
@@ -340,7 +385,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        /**
         * Getter for resolver instance
         *
-        * @return      $resolverInstance               Instance of a command resolver class
+        * @return      $resolverInstance       Instance of a command resolver class
         */
        public final function getResolverInstance () {
                return $this->resolverInstance;
@@ -413,8 +458,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        /**
         * Setter for database instance
         *
-        * @param               $dbInstance     The instance for the database connection
-        *                                      (forced DatabaseConnection)
+        * @param               $dbInstance     The instance for the database connection (forced DatabaseConnection)
         * @return      void
         */
        public final function setDatabaseInstance (DatabaseConnection $dbInstance) {
@@ -517,7 +561,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
         *
         * @return      $realClass The name of the real class (not BaseFrameworkSystem)
         */
-       public final function __toString () {
+       public function __toString () {
                return $this->realClass;
        }
 
@@ -551,7 +595,18 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                ));
 
                // Return the result
-               return $result;
+               return $equals;
+       }
+
+       /**
+        * Generates a generic hash code of this class. You should really overwrite
+        * this method with your own hash code generator code. But keep KISS in mind.
+        *
+        * @return      $hashCode       A generic hash code respresenting this whole class
+        */
+       public function hashCode () {
+               // Simple hash code
+               return crc32($this->__toString());
        }
 
        /**
@@ -674,7 +729,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                }
 
                // Initialize the template engine
-               $templateInstance = ObjectFactory::createObjectByConfiguredName('template_class', array($appInstance));
+               $templateInstance = ObjectFactory::createObjectByConfiguredName('web_template_class', array($appInstance));
 
                // Return the prepared instance
                return $templateInstance;
@@ -716,6 +771,25 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                ));
        }
 
+       /**
+        * Replaces control characters with printable output
+        *
+        * @param       $str    String with control characters
+        * @return      $str    Replaced string
+        */
+       protected function replaceControlCharacters ($str) {
+               // Replace them
+               $str = str_replace(
+                       "\r", '[r]', str_replace(
+                       "\n", '[n]', str_replace(
+                       "\t", '[t]',
+                       $str
+               )));
+
+               // Return it
+               return $str;
+       }
+
        /**
         * Output a partial stub message for the caller method
         *
@@ -885,7 +959,7 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                        $readable = $this->getLanguageInstance()->getMessage('null_timestamp');
                } else {
                        switch ($this->getLanguageInstance()->getLanguageCode()) {
-                               case "de": // German format is a bit different to default
+                               case 'de': // German format is a bit different to default
                                        // Split the GMT stamp up
                                        $dateTime  = explode(' ', $timestamp  );
                                        $dateArray = explode('-', $dateTime[0]);
@@ -905,13 +979,35 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                                default: // Default is pass-through
                                        $readable = $timestamp;
                                        break;
-                       }
+                       } // END - switch
                }
 
                // Return the stamp
                return $readable;
        }
 
+       /**
+        * Filter a given number into a localized number
+        *
+        * @param       $value          The raw value from e.g. database
+        * @return      $localized      Localized value
+        */
+       public function doFilterFormatNumber ($value) {
+               // Generate it from config and localize dependencies
+               switch ($this->getLanguageInstance()->getLanguageCode()) {
+                       case 'de': // German format is a bit different to default
+                               $localized = number_format($value, $this->getConfigInstance()->getConfigEntry('decimals'), ',', '.');
+                               break;
+
+                       default: // US, etc.
+                               $localized = number_format($value, $this->getConfigInstance()->getConfigEntry('decimals'), '.', ',');
+                               break;
+               } // END - switch
+
+               // Return it
+               return $localized;
+       }
+
        /**
         * "Getter" for databse entry
         *
@@ -1062,17 +1158,6 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
                }
        }
 
-       /**
-        * Generates a generic hash code of this class. You should really overwrite
-        * this method with your own hash code generator code. But keep KISS in mind.
-        *
-        * @return      $hashCode       A generic hash code respresenting this whole class
-        */
-       public function hashCode () {
-               // Simple hash code
-               return crc32($this->__toString());
-       }
-
        /**
         * Checks wether the given PHP extension is loaded
         *
@@ -1183,6 +1268,177 @@ class BaseFrameworkSystem extends stdClass implements FrameworkInterface {
        protected final function getListInstance () {
                return $this->listInstance;
        }
+
+       /**
+        * Setter for the menu instance
+        *
+        * @param       $menuInstance   A RenderableMenu instance
+        * @return      void
+        */
+       protected final function setMenuInstance (RenderableMenu $menuInstance) {
+               $this->menuInstance = $menuInstance;
+       }
+
+       /**
+        * Getter for the menu instance
+        *
+        * @return      $menuInstance   A RenderableMenu instance
+        */
+       protected final function getMenuInstance () {
+               return $this->menuInstance;
+       }
+
+       /**
+        * Setter for image instance
+        *
+        * @param       $imageInstance  An instance of an image
+        * @return      void
+        */
+       public final function setImageInstance (BaseImage $imageInstance) {
+               $this->imageInstance = $imageInstance;
+       }
+
+       /**
+        * Getter for image instance
+        *
+        * @return      $imageInstance  An instance of an image
+        */
+       public final function getImageInstance () {
+               return $this->imageInstance;
+       }
+
+       /**
+        * Setter for stacker instance
+        *
+        * @param       $stackerInstance        An instance of an stacker
+        * @return      void
+        */
+       public final function setStackerInstance (Stackable $stackerInstance) {
+               $this->stackerInstance = $stackerInstance;
+       }
+
+       /**
+        * Getter for stacker instance
+        *
+        * @return      $stackerInstance        An instance of an stacker
+        */
+       public final function getStackerInstance () {
+               return $this->stackerInstance;
+       }
+
+       /**
+        * Setter for compressor instance
+        *
+        * @param       $compressorInstance     An instance of an compressor
+        * @return      void
+        */
+       public final function setCompressorInstance (Compressor $compressorInstance) {
+               $this->compressorInstance = $compressorInstance;
+       }
+
+       /**
+        * Getter for compressor instance
+        *
+        * @return      $compressorInstance     An instance of an compressor
+        */
+       public final function getCompressorInstance () {
+               return $this->compressorInstance;
+       }
+
+       /**
+        * Setter for Parseable instance
+        *
+        * @param       $parserInstance An instance of an Parseable
+        * @return      void
+        */
+       public final function setParserInstance (Parseable $parserInstance) {
+               $this->parserInstance = $parserInstance;
+       }
+
+       /**
+        * Getter for Parseable instance
+        *
+        * @return      $parserInstance An instance of an Parseable
+        */
+       public final function getParserInstance () {
+               return $this->parserInstance;
+       }
+
+       /**
+        * Setter for ProtocolHandler instance
+        *
+        * @param       $protocolInstance       An instance of an ProtocolHandler
+        * @return      void
+        */
+       public final function setProtocolInstance (ProtocolHandler $protocolInstance) {
+               $this->protocolInstance = $protocolInstance;
+       }
+
+       /**
+        * Getter for ProtocolHandler instance
+        *
+        * @return      $protocolInstance       An instance of an ProtocolHandler
+        */
+       public final function getProtocolInstance () {
+               return $this->protocolInstance;
+       }
+
+       /**
+        * Setter for BaseDatabaseWrapper instance
+        *
+        * @param       $wrapperInstance        An instance of an BaseDatabaseWrapper
+        * @return      void
+        */
+       public final function setWrapperInstance (BaseDatabaseWrapper $wrapperInstance) {
+               $this->wrapperInstance = $wrapperInstance;
+       }
+
+       /**
+        * Getter for BaseDatabaseWrapper instance
+        *
+        * @return      $wrapperInstance        An instance of an BaseDatabaseWrapper
+        */
+       public final function getWrapperInstance () {
+               return $this->wrapperInstance;
+       }
+
+       /**
+        * Setter for socket resource
+        *
+        * @param       $socketResource         A valid socket resource
+        * @return      void
+        */
+       public final function setSocketResource ($socketResource) {
+               $this->socketResource = $socketResource;
+       }
+
+       /**
+        * Getter for socket resource
+        *
+        * @return      $socketResource         A valid socket resource
+        */
+       public function getSocketResource () {
+               return $this->socketResource;
+       }
+
+       /**
+        * Setter for raw package Data
+        *
+        * @param       $packageData    Raw package Data
+        * @return      void
+        */
+       public final function setPackageData (array $packageData) {
+               $this->packageData = $packageData;
+       }
+
+       /**
+        * Getter for raw package Data
+        *
+        * @return      $packageData    Raw package Data
+        */
+       public function getPackageData () {
+               return $this->packageData;
+       }
 }
 
 // [EOF]