Changeset 4698 for extensions/AMetaData/JpegMetaData/Common/Locale.class.php

Timestamp:

Jan 17, 2010, 7:05:35 PM (14 years ago)

Author:

grum

Message:

[Plugin:AMetaData] Finished to comment the JpegMetaData classes and rename some methods

File:

• extensions/AMetaData/JpegMetaData/Common/Locale.class.php (modified) (3 diffs)

extensions/AMetaData/JpegMetaData/Common/Locale.class.php

@@ -35 +35 @@
  * The Locale class is used for tag translation, reading the .mo files
  *
+ * There is one directory per language, the directories tree must respect this
+ * structure
+ *
+ * --\ Locale                           => main directory for languages
+ *     |
+ *     +--\ en_UK                       => language
+ *     |    |
+ *     |    +--\ LC_MESSAGES
+ *     |         |
+ *     |         +--\ Tag.mo            => names & values translations
+ *     |         +--\ TadDesc.mo        => descriptions translations
+ *     |
+ *     +--\ fr_FR
+ *          |
+ *          +--\ LC_MESSAGES
+ *               |
+ *               +--\ Tag.mo
+ *               +--\ TadDesc.mo
+ *
+ *
  * -----------------------------------------------------------------------------
  *
+ * .. Notes ..
+ *
+ * This class don't use the PHP gettext functions, but the php-gettext extension
+ * ==> See files in External/php-gettext for more information about this project
+ *
+ *
+ *
+ * This class provides theses public functions :
+ *  - (static) setLanguage
+ *  - (static) getLanguage
+ *  - (static) get
+ *  - (static) getDesc
  *
  * -----------------------------------------------------------------------------
@@ -44 +76 @@
 require_once(JPEG_METADATA_DIR."External/php-gettext/gettext.inc");
 
-$supported_locales = array('en_UK');
+/**
+ * $supported_locales is a global variable need by the php-gettext package.
+ * the array is automatically initialized with the setLanguage() function
+ */
+$supported_locales = array();
+
+/**
+ * assume a default language is set in any case...
+ */
+Locale::setLanguage();
+
 
 class Locale
@@ -51 +93 @@
   const JMD_TAGDESC = "TagDesc";
 
-  static function set($language)
+  static private $language = "";
+
+  /**
+   * This function is used to set the locale language.
+   * If no language is given, assume the default "en_UK" language
+   *
+   * If there is no translation file for the the given language, assume the
+   * default "en_UK" language
+   *
+   * @param String $language : the language
+   * @return String : the defined language
+   */
+  static function setLanguage($language="en_UK")
   {
-    T_setlocale(LC_MESSAGES, $language);
+    global $supported_locales;
 
+    /*
+     * Scan the Locale directory.
+     * Any directory with a sub directory "LC_MESSAGES" is considered as a
+     * supported locale language
+     */
+    $directory=scandir(JPEG_METADATA_DIR."Locale");
+    foreach($directory as $key => $file)
+    {
+      if(is_dir(JPEG_METADATA_DIR."Locale/".$file) and
+         $file!='.' and
+         $file!='..' and
+         file_exists(JPEG_METADATA_DIR."Locale/".$file."/LC_MESSAGES/Tag.mo"))
+         $supported_locales[]=$file;
+
+    }
+
+    /*
+     * if the desired language doesn't exist, apply the en_UK locale
+     * (assuming the en_UK exists and was not deleted)
+     */
+    if(!in_array($language, $supported_locales))
+      self::$language='en_UK';
+    else
+      self::$language=$language;
+
+    /*
+     * set the locale
+     */
+    T_setlocale(LC_MESSAGES, self::$language);
+
+    /*
+     * set one domain "TAG" for tags name&values, and one domaine "TAGDESC" for
+     * tags description
+     */
     T_bindtextdomain(self::JMD_TAG, dirname(dirname(__FILE__))."/Locale");
     T_bindtextdomain(self::JMD_TAGDESC, dirname(dirname(__FILE__))."/Locale");
+
+    return(self::$language);
   }
 
-  static function get($tagName)
+  /**
+   * returns the defined current language
+   *
+   * @return String
+   */
+  static function getLanguage()
   {
-    return(@T_dgettext(self::JMD_TAG, $tagName));
+    return(self::$language);
   }
 
+  /**
+   * returns the translation in current language for the given key
+   *
+   * @return String
+   */
+  static function get($key)
+  {
+    return(@T_dgettext(self::JMD_TAG, $key));
+  }
+
+  /**
+   * returns the description in current language for the given tagName
+   *
+   * @return String
+   */
   static function getDesc($tagName)
   {