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, 2010 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__);
57 * Creates an instance of the class LanguageSystem and prepares it for usage
59 * @param $languageBasePath The local base path for all language strings
60 * @return $langInstance An instance of LanguageSystem
61 * @throws LanguagePathIsEmptyException If the provided $languageBasePath is empty
62 * @throws InvalidLanguagePathStringException If $languageBasePath is no string
63 * @throws LanguagePathIsNoDirectoryException If $languageBasePath is no
64 * directory or not found
65 * @throws LanguagePathReadProtectedException If $languageBasePath is
68 public static final function createLanguageSystem ($languageBasePath) {
70 $langInstance = new LanguageSystem();
72 // Is the base path valid?
73 if (empty($languageBasePath)) {
74 // Language path is empty
75 throw new LanguagePathIsEmptyException($langInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
76 } elseif (!is_string($languageBasePath)) {
78 throw new InvalidLanguagePathStringException(array($langInstance, $languageBasePath), self::EXCEPTION_INVALID_STRING);
79 } elseif (!is_dir($languageBasePath)) {
81 throw new LanguagePathIsNoDirectoryException(array($langInstance, $languageBasePath), self::EXCEPTION_INVALID_PATH_NAME);
82 } elseif (!is_readable($languageBasePath)) {
84 throw new LanguagePathReadProtectedException(array($langInstance, $languageBasePath), self::EXCEPTION_READ_PROTECED_PATH);
88 $langInstance->setLanguageBasePath($languageBasePath);
90 // Initialize the variable stack
91 $langInstance->initLanguageStrings();
93 // Set language code from default config
94 $langInstance->setLanguageCode(FrameworkConfiguration::getInstance()->getConfigEntry('default_lang'));
96 // Remember this instance
97 self::$thisInstance = $langInstance;
99 // Return the prepared instance
100 return $langInstance;
104 * Singleton getter for this instance
106 * @return $thisInstance An instance of this class
108 public static final function getInstance () {
109 return self::$thisInstance;
113 * Setter for base path
115 * @param $languageBasePath The relative base path for all language files
118 protected final function setLanguageBasePath ($languageBasePath) {
120 $this->languageBasePath = (string) $languageBasePath;
124 * Setter for language code
126 * @param $langCode The language code for the current application
129 protected final function setLanguageCode ($langCode) {
131 $langCode = (string) $langCode;
133 // And set it (only 2 chars)
134 $this->langCode = substr($langCode, 0, 2);
138 * Initialize the array-object for all later language strings
142 public function initLanguageStrings () {
143 $this->langStrings = new FrameworkArrayObject("FakedLanguageStrings");
147 * Getter for language code
149 * @return $langCode The language code for the current application
151 public final function getLanguageCode () {
152 return $this->langCode;
156 * Get the plain message from the cache variable for the given message id
158 * @param $messageId The message id we shall find in the cache variable
159 * @return $messageText The plain message text
161 public function getMessage ($messageId) {
162 // Default is missing message text
163 $messageText = sprintf("!%s!",
167 // Try to look it up in the cache variable
168 if ($this->langStrings->offsetExists($messageId)) {
169 // Return the message string
170 $messageText = $this->langStrings->offsetGet($messageId);