3 * The language sub-system for handling language strings being used in the
4 * application and whole framework
6 * @author Roland Haeder <webmaster@ship-simu.org>
8 * @copyright Copyright (c) 2007, 2008 Roland Haeder, 2009 Core Developer Team
9 * @license GNU GPL 3.0 or any newer version
10 * @link http://www.ship-simu.org
12 * This program is free software: you can redistribute it and/or modify
13 * it under the terms of the GNU General Public License as published by
14 * the Free Software Foundation, either version 3 of the License, or
15 * (at your option) any later version.
17 * This program is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU General Public License for more details.
22 * You should have received a copy of the GNU General Public License
23 * along with this program. If not, see <http://www.gnu.org/licenses/>.
25 class LanguageSystem extends BaseFrameworkSystem implements ManageableLanguage, Registerable {
27 * The full-qualified base path for the language include files
29 private $languageBasePath = '';
32 * The 2-char language code
34 private $langCode = 'xx'; // This will later be overwritten!
37 * The array-object for all language strings
39 private $langStrings = null;
42 * An instance of this class
44 private static $thisInstance = null;
47 * Protected constructor
51 protected function __construct () {
52 // Call parent constructor
53 parent::__construct(__CLASS__);
56 $this->removeNumberFormaters();
57 $this->removeSystemArray();
61 * Creates an instance of the class LanguageSystem and prepares it for usage
63 * @param $languageBasePath The local base path for all language strings
64 * @return $langInstance An instance of LanguageSystem
65 * @throws LanguagePathIsEmptyException If the provided $languageBasePath is empty
66 * @throws InvalidLanguagePathStringException If $languageBasePath is no string
67 * @throws LanguagePathIsNoDirectoryException If $languageBasePath is no
68 * directory or not found
69 * @throws LanguagePathReadProtectedException If $languageBasePath is
72 public final static function createLanguageSystem ($languageBasePath) {
74 $langInstance = new LanguageSystem();
76 // Is the base path valid?
77 if (empty($languageBasePath)) {
78 // Language path is empty
79 throw new LanguagePathIsEmptyException($langInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
80 } elseif (!is_string($languageBasePath)) {
82 throw new InvalidLanguagePathStringException(array($langInstance, $languageBasePath), self::EXCEPTION_INVALID_STRING);
83 } elseif (!is_dir($languageBasePath)) {
85 throw new LanguagePathIsNoDirectoryException(array($langInstance, $languageBasePath), self::EXCEPTION_INVALID_PATH_NAME);
86 } elseif (!is_readable($languageBasePath)) {
88 throw new LanguagePathReadProtectedException(array($langInstance, $languageBasePath), self::EXCEPTION_READ_PROTECED_PATH);
92 $langInstance->setLanguageBasePath($languageBasePath);
94 // Initialize the variable stack
95 $langInstance->initLanguageStrings();
97 // Set language code from default config
98 $langInstance->setLanguageCode(FrameworkConfiguration::getInstance()->readConfig('default_lang'));
100 // Remember this instance
101 self::$thisInstance = $langInstance;
103 // Return the prepared instance
104 return $langInstance;
108 * Singleton getter for this instance
110 * @return $thisInstance An instance of this class
112 public final static function getInstance () {
113 return self::$thisInstance;
117 * Setter for base path
119 * @param $languageBasePath The relative base path for all language files
122 protected final function setLanguageBasePath ($languageBasePath) {
124 $this->languageBasePath = (string) $languageBasePath;
128 * Setter for language code
130 * @param $langCode The language code for the current application
133 protected final function setLanguageCode ($langCode) {
135 $langCode = (string) $langCode;
137 // And set it (only 2 chars)
138 $this->langCode = substr($langCode, 0, 2);
142 * Initialize the array-object for all later language strings
146 public function initLanguageStrings () {
147 $this->langStrings = new FrameworkArrayObject("FakedLanguageStrings");
151 * Getter for language code
153 * @return $langCode The language code for the current application
155 public final function getLanguageCode () {
156 return $this->langCode;
160 * Get the plain message from the cache variable for the given message id
162 * @param $messageId The message id we shall find in the cache variable
163 * @return $messageText The plain message text
165 public function getMessage ($messageId) {
166 // Default is missing message text
167 $messageText = sprintf("!%s!",
171 // Try to look it up in the cache variable
172 if ($this->langStrings->offsetExists($messageId)) {
173 // Return the message string
174 $messageText = $this->langStrings->offsetGet($messageId);