inc/classes/main/language/class_LanguageSystem.php

   1 <?php
   2 /**
   3  * The language sub-system for handling language strings being used in the
   4  * application and whole framework
   5  *
   6  * @author              Roland Haeder <webmaster@shipsimu.org>
   7  * @version             0.0.0
   8  * @copyright   Copyright (c) 2007, 2008 Roland Haeder, 2009 - 2015 Core Developer Team
   9  * @license             GNU GPL 3.0 or any newer version
  10  * @link                http://www.shipsimu.org
  11  *
  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.
  16  *
  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.
  21  *
  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/>.
  24  */
  25 class LanguageSystem extends BaseFrameworkSystem implements ManageableLanguage, Registerable {
  26         /**
  27          * The full-qualified base path for the language include files
  28          */
  29         private $languageBasePath = '';
  30
  31         /**
  32          * The 2-char language code
  33          */
  34         private $langCode = 'xx'; // This will later be overwritten!
  35
  36         /**
  37          * The array-object for all language strings
  38          */
  39         private $langStrings = NULL;
  40
  41         /**
  42          * An instance of this class
  43          */
  44         private static $selfInstance = NULL;
  45
  46         /**
  47          * Protected constructor
  48          *
  49          * @return      void
  50          */
  51         protected function __construct () {
  52                 // Call parent constructor
  53                 parent::__construct(__CLASS__);
  54         }
  55
  56         /**
  57          * Creates an instance of the class LanguageSystem and prepares it for usage
  58          *
  59          * @param       $languageBasePath       The local base path for all language strings or emty for auto-detection
  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
  66          *                                                                              read-protected
  67          */
  68         public static final function createLanguageSystem ($languageBasePath = '') {
  69                 // Get a new instance
  70                 $langInstance = new LanguageSystem();
  71
  72                 // Is the base path set?
  73                 if (empty($languageBasePath)) {
  74                         // No, then attempt "auto-dection":
  75                         // 1) Get application
  76                         $applicationInstance = Registry::getRegistry()->getInstance('app');
  77
  78                         // 2) Try to build it
  79                         $languageBasePath = sprintf('%sapplication/%s/language/',
  80                                 $langInstance->getConfigInstance()->getConfigEntry('base_path'),
  81                                 $applicationInstance->getAppShortName()
  82                         );
  83                 } // END - if
  84
  85                 // Is the base path valid?
  86                 if (empty($languageBasePath)) {
  87                         // Language path is empty
  88                         throw new LanguagePathIsEmptyException($langInstance, self::EXCEPTION_UNEXPECTED_EMPTY_STRING);
  89                 } elseif (!is_string($languageBasePath)) {
  90                         // Is not a string
  91                         throw new InvalidLanguagePathStringException(array($langInstance, $languageBasePath), self::EXCEPTION_INVALID_STRING);
  92                 } elseif (!is_dir($languageBasePath)) {
  93                         // Is not a path
  94                         throw new LanguagePathIsNoDirectoryException(array($langInstance, $languageBasePath), self::EXCEPTION_INVALID_PATH_NAME);
  95                 } elseif (!is_readable($languageBasePath)) {
  96                         // Is not readable
  97                         throw new LanguagePathReadProtectedException(array($langInstance, $languageBasePath), self::EXCEPTION_READ_PROTECED_PATH);
  98                 }
  99
 100                 // Set the base path
 101                 $langInstance->setLanguageBasePath($languageBasePath);
 102
 103                 // Initialize the variable stack
 104                 $langInstance->initLanguageStrings();
 105
 106                 // Set language code from default config
 107                 $langInstance->setLanguageCode(FrameworkConfiguration::getSelfInstance()->getConfigEntry('default_lang'));
 108
 109                 // Remember this instance
 110                 self::$selfInstance = $langInstance;
 111
 112                 // Return the prepared instance
 113                 return $langInstance;
 114         }
 115
 116         /**
 117          * Singleton getter for this instance
 118          *
 119          * @return      $selfInstance   An instance of this class
 120          */
 121         public static final function getSelfInstance () {
 122                 return self::$selfInstance;
 123         }
 124
 125         /**
 126          * Setter for base path
 127          *
 128          * @param       $languageBasePath       The relative base path for all language files
 129          * @return      void
 130          */
 131         protected final function setLanguageBasePath ($languageBasePath) {
 132                 // And set it
 133                 $this->languageBasePath = (string) $languageBasePath;
 134         }
 135
 136         /**
 137          * Setter for language code
 138          *
 139          * @param       $langCode       The language code for the current application
 140          * @return      void
 141          */
 142         protected final function setLanguageCode ($langCode) {
 143                 // Cast it
 144                 $langCode = (string) $langCode;
 145
 146                 // And set it (only 2 chars)
 147                 $this->langCode = substr($langCode, 0, 2);
 148         }
 149
 150         /**
 151          * Initialize the array-object for all later language strings
 152          *
 153          * @return      void
 154          */
 155         public function initLanguageStrings () {
 156                 $this->langStrings = new FrameworkArrayObject('FakedLanguageStrings');
 157         }
 158
 159         /**
 160          * Getter for language code
 161          *
 162          * @return      $langCode       The language code for the current application
 163          */
 164         public final function getLanguageCode () {
 165                 return $this->langCode;
 166         }
 167
 168         /**
 169          * Get the plain message from the cache variable for the given message id
 170          *
 171          * @param       $messageId              The message id we shall find in the cache variable
 172          * @return      $messageText    The plain message text
 173          */
 174         public function getMessage ($messageId) {
 175                 // Default is missing message text
 176                 $messageText = sprintf('!%s!',
 177                         $messageId
 178                 );
 179
 180                 // Try to look it up in the cache variable
 181                 if ($this->langStrings->offsetExists($messageId)) {
 182                         // Return the message string
 183                         $messageText = $this->langStrings->offsetGet($messageId);
 184                 } // END - if
 185
 186                 // Return the text
 187                 return $messageText;
 188         }
 189 }
 190
 191 // [EOF]
 192 ?>