New feature: Possible for plugins to include their own locale files

application/core/LSCGettextMessageSource.php

@@ -0,0 +1,56 @@
+<?php
+
+/**
+ * Extension of CGettextMessageSource to allow plugins to have
+ * their own localization files
+ *
+ * @since 2016-07-25
+ * @author Olle Haerstedt
+ */
+class LSCGettextMessageSource extends CGettextMessageSource
+{
+	const CACHE_KEY_PREFIX='Yii.LSCGettextMessageSource.';
+
+	/**
+	 * Loads the message translation for the specified language and category.
+	 * @param string $category the message category
+	 * @param string $language the target language
+	 * @return array the loaded messages
+	 */
+	public function loadMessages($category, $language)
+    {
+        // Default catalog to langauge (e.g. de)
+        // TODO: Where is catalog set (except default value)?
+        $this->catalog = $language;
+
+        $messageFile=$this->basePath . DIRECTORY_SEPARATOR . $language . DIRECTORY_SEPARATOR . $this->catalog;
+        if($this->useMoFile)
+        	$messageFile.=self::MO_FILE_EXT;
+        else
+        	$messageFile.=self::PO_FILE_EXT;
+
+		if ($this->cachingDuration > 0 && $this->cacheID!==false && ($cache=Yii::app()->getComponent($this->cacheID))!==null)
+		{
+			$key = self::CACHE_KEY_PREFIX . $messageFile . "." . $category;
+			if (($data=$cache->get($key)) !== false)
+				return unserialize($data);
+		}
+
+		if (is_file($messageFile))
+		{
+			if($this->useMoFile)
+				$file=new CGettextMoFile($this->useBigEndian);
+			else
+				$file=new CGettextPoFile();
+			$messages=$file->load($messageFile,$category);
+			if(isset($cache))
+			{
+				$dependency=new CFileCacheDependency($messageFile);
+				$cache->set($key,serialize($messages),$this->cachingDuration,$dependency);
+			}
+			return $messages;
+		}
+		else
+			return array();
+    }
+}

application/libraries/PluginManager/LimesurveyApi.php

@@ -6,10 +6,10 @@
 use SurveyDynamic;
 
 /**
-* Class exposing a Limesurvey API to plugins.
-* This class is instantiated by the plugin manager,
-* plugins can obtain it by calling getAPI() on the plugin manager.
-*/
+ * Class exposing a Limesurvey API to plugins.
+ * This class is instantiated by the plugin manager,
+ * plugins can obtain it by calling getAPI() on the plugin manager.
+ */
 class LimesurveyApi
 {
     /**
@@ -24,20 +24,24 @@ public function getConfigKey($key, $defaultValue = false)
     {
         return App()->getConfig($key, $defaultValue);
     }
-    
+
     /**
      * Generates the real table name from plugin and tablename.
      * @param iPlugin $plugin
      * @param string $tableName
+     * @return string
      */
     protected function getTableName(iPlugin $plugin, $tableName)
     {
         return App()->getDb()->tablePrefix . strtolower($plugin->getName()) . "_$tableName";
     }
+
     /**
-    * Sets a flash message to be shown to the user.
-    * @param html $message
-    */
+     * Sets a flash message to be shown to the user.
+     *
+     * @param string $message HTML
+     * @return void
+     */
     public function setFlash($message, $key ='api')
     {
         // @todo Remove direct session usage.
@@ -389,5 +393,32 @@ public function pluginIsActive($name)
             throw new Exception("Can't find a plugin with name " . $name);
         }
     }
+
+    /**
+     * Translation for plugin
+     *
+     * @param string $sToTranslate The message that are being translated
+     * @param string $sEscapeMode
+     * @param string $sLanguage
+     * @return string
+     */
+    public function gT($sToTranslate, $sEscapeMode = 'html', $sLanguage = NULL)
+    {
+        $translation = \quoteText(Yii::t('', $sToTranslate, array(), 'pluginMessages', $sLanguage), $sEscapeMode);
+
+        // If we don't have a translation from the plugin, check core translations
+        if ($translation == $sToTranslate)
+        {
+            $translationFromCore = \quoteText(Yii::t('', $sToTranslate, array(), null, $sLanguage), $sEscapeMode);
+
+            if ($translationFromCore != $sToTranslate)
+            {
+                return $translationFromCore;
+            }
+        }
+
+        return $translation;
+
+    }
 
 }

application/libraries/PluginManager/PluginBase.php

@@ -44,6 +44,15 @@ public function __construct(\PluginManager $manager, $id)
         $this->pluginManager = $manager;
         $this->id = $id;
         $this->api = $manager->getAPI();
+
+        // Set plugin specific locale file to locale/<lang>/<lang>.mo
+        \Yii::app()->setComponent('pluginMessages', array(
+            'class' => 'LSCGettextMessageSource',
+            'cachingDuration' => 3600,
+            'forceTranslation' => true,
+            'useMoFile' => true,
+            'basePath' => $this->getDir() . DIRECTORY_SEPARATOR . 'locale'
+        ));
     }
 
     /**
@@ -249,4 +258,17 @@ protected function unsubscribe($event)
         return $this->pluginManager->unsubscribe($this, $event);
     }
 
+    /**
+     * To find the plugin locale file, we need late runtime result of __DIR__.
+     * Solution copied from http://stackoverflow.com/questions/18100689/php-dir-evaluated-runtime-late-binding
+     *
+     * @return string
+     */
+    protected function getDir()
+    {
+        $reflObj = new \ReflectionObject($this);
+        $fileName = $reflObj->getFileName();
+        return dirname($fileName);
+    }
+
 }