Copyright upgraded to 2010

[core.git] / inc / classes / main / language / class_LanguageSystem.php

diff --git a/inc/classes/main/language/class_LanguageSystem.php b/inc/classes/main/language/class_LanguageSystem.php
index c1d66e4f3c5b2ebbaf14932f452df4b86b8091b0..ca189a4c4bafa5c0021f686ff4b491ab48d17e41 100644 (file)
--- a/inc/classes/main/language/class_LanguageSystem.php
+++ b/inc/classes/main/language/class_LanguageSystem.php
@@ -5,7 +5,7 @@
  *
  * @author             Roland Haeder <webmaster@ship-simu.org>
  * @version            0.0.0
- * @copyright  Copyright (c) 2007 - 2009 Roland Haeder, this is free software
+ * @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
  *
@@ -26,12 +26,12 @@ class LanguageSystem extends BaseFrameworkSystem implements ManageableLanguage,
        /**
         * The full-qualified base path for the language include files
         */
-       private $basePath = '';
+       private $languageBasePath = '';
 
        /**
         * The 2-char language code
         */
-       private $langCode = "xx"; // This will later be overwritten!
+       private $langCode = 'xx'; // This will later be overwritten!
 
        /**
         * The array-object for all language strings
@@ -51,51 +51,47 @@ class LanguageSystem extends BaseFrameworkSystem implements ManageableLanguage,
        protected function __construct () {
                // Call parent constructor
                parent::__construct(__CLASS__);
-
-               // Clean up a little
-               $this->removeNumberFormaters();
-               $this->removeSystemArray();
        }
 
        /**
         * Creates an instance of the class LanguageSystem and prepares it for usage
         *
-        * @param       $basePath               The local base path for all language strings
+        * @param       $languageBasePath       The local base path for all language strings
         * @return      $langInstance   An instance of LanguageSystem
-        * @throws      LanguagePathIsEmptyException            If the provided $basePath is empty
-        * @throws      InvalidLanguagePathStringException      If $basePath is no string
-        * @throws      LanguagePathIsNoDirectoryException      If $basePath is no
+        * @throws      LanguagePathIsEmptyException    If the provided $languageBasePath is empty
+        * @throws      InvalidLanguagePathStringException      If $languageBasePath is no string
+        * @throws      LanguagePathIsNoDirectoryException      If $languageBasePath is no
         *                                                                              directory or not found
-        * @throws      LanguagePathReadProtectedException      If $basePath is
+        * @throws      LanguagePathReadProtectedException      If $languageBasePath is
         *                                                                              read-protected
         */
-       public final static function createLanguageSystem ($basePath) {
+       public final static function createLanguageSystem ($languageBasePath) {
                // Get a new instance
                $langInstance = new LanguageSystem();
 
                // Is the base path valid?
-               if (empty($basePath)) {
+               if (empty($languageBasePath)) {
                        // Language path is empty
                        throw new LanguagePathIsEmptyException($langInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
-               } elseif (!is_string($basePath)) {
+               } elseif (!is_string($languageBasePath)) {
                        // Is not a string
-                       throw new InvalidLanguagePathStringException(array($langInstance, $basePath), self::EXCEPTION_INVALID_STRING);
-               } elseif (!is_dir($basePath)) {
+                       throw new InvalidLanguagePathStringException(array($langInstance, $languageBasePath), self::EXCEPTION_INVALID_STRING);
+               } elseif (!is_dir($languageBasePath)) {
                        // Is not a path
-                       throw new LanguagePathIsNoDirectoryException(array($langInstance, $basePath), self::EXCEPTION_INVALID_PATH_NAME);
-               } elseif (!is_readable($basePath)) {
+                       throw new LanguagePathIsNoDirectoryException(array($langInstance, $languageBasePath), self::EXCEPTION_INVALID_PATH_NAME);
+               } elseif (!is_readable($languageBasePath)) {
                        // Is not readable
-                       throw new LanguagePathReadProtectedException(array($langInstance, $basePath), self::EXCEPTION_READ_PROTECED_PATH);
+                       throw new LanguagePathReadProtectedException(array($langInstance, $languageBasePath), self::EXCEPTION_READ_PROTECED_PATH);
                }
 
                // Set the base path
-               $langInstance->setBasePath($basePath);
+               $langInstance->setLanguageBasePath($languageBasePath);
 
                // Initialize the variable stack
                $langInstance->initLanguageStrings();
 
                // Set language code from default config
-               $langInstance->setLanguageCode(FrameworkConfiguration::getInstance()->readConfig('default_lang'));
+               $langInstance->setLanguageCode(FrameworkConfiguration::getInstance()->getConfigEntry('default_lang'));
 
                // Remember this instance
                self::$thisInstance = $langInstance;
@@ -107,7 +103,7 @@ class LanguageSystem extends BaseFrameworkSystem implements ManageableLanguage,
        /**
         * Singleton getter for this instance
         *
-        * @return      $thisInstance           An instance of this class
+        * @return      $thisInstance   An instance of this class
         */
        public final static function getInstance () {
                return self::$thisInstance;
@@ -116,18 +112,18 @@ class LanguageSystem extends BaseFrameworkSystem implements ManageableLanguage,
        /**
         * Setter for base path
         *
-        * @param               $basePath               The local base path for all templates
+        * @param       $languageBasePath       The relative base path for all language files
         * @return      void
         */
-       protected final function setBasePath ($basePath) {
+       protected final function setLanguageBasePath ($languageBasePath) {
                // And set it
-               $this->basePath = (string) $basePath;
+               $this->languageBasePath = (string) $languageBasePath;
        }
 
        /**
         * Setter for language code
         *
-        * @param               $langCode               The language code for the current application
+        * @param       $langCode       The language code for the current application
         * @return      void
         */
        protected final function setLanguageCode ($langCode) {
@@ -150,7 +146,7 @@ class LanguageSystem extends BaseFrameworkSystem implements ManageableLanguage,
        /**
         * Getter for language code
         *
-        * @return      $langCode               The language code for the current application
+        * @return      $langCode       The language code for the current application
         */
        public final function getLanguageCode () {
                return $this->langCode;