diff options
author | diosmosis <benakamoorthi@fastmail.fm> | 2013-10-25 18:49:33 +0400 |
---|---|---|
committer | diosmosis <benakamoorthi@fastmail.fm> | 2013-10-25 18:49:42 +0400 |
commit | 145fcb57614297bc9be5cbb9597c0820416640be (patch) | |
tree | 616e20edb4eb8665f67444c739347930789dbaf1 /core/Translate.php | |
parent | 6d4d87e81984e68a7f792ea964e9464a9d984231 (diff) |
Refs #4200 revised event docs for core/* files.
Diffstat (limited to 'core/Translate.php')
-rw-r--r-- | core/Translate.php | 43 |
1 files changed, 30 insertions, 13 deletions
diff --git a/core/Translate.php b/core/Translate.php index f7e9808ad8..7b1dfb1e47 100644 --- a/core/Translate.php +++ b/core/Translate.php @@ -101,9 +101,25 @@ class Translate $lang = Common::getRequestVar('language', '', 'string'); /** - * This event is triggered to identify the language code, such as 'en', for the current user. You can use - * it for instance to detect the users language by using a third party API such as a CMS. The language that - * is set in the request URL is passed as an argument. + * Triggered when the current user's language is requested. + * + * By default the current language is determined by the **language** query + * parameter. Plugins can override this logic by subscribing to this event. + * + * **Example** + * + * public function getLanguage(&$lang) + * { + * $client = new My3rdPartyAPIClient(); + * $thirdPartyLang = $client->getLanguageForUser(Piwik::getCurrentUserLogin()); + * + * if (!empty($thirdPartyLang)) { + * $lang = $thirdPartyLang; + * } + * } + * + * @param string &$lang The language that should be used for the user. Will be + * initialized to the value of the **language** query parameter. */ Piwik::postEvent('User.getLanguage', array(&$lang)); @@ -160,19 +176,20 @@ class Translate $result = array(); /** - * This event is called before generating the JavaScript code that allows other JavaScript - * to access Piwik i18n strings. Plugins should handle this event to specify which translations - * should be available to JavaScript code. + * Triggered before generating the JavaScript code that allows i18n strings to be used + * in the browser. Plugins should subscribe to this event to specify which translations + * should be available in JavaScript code. * * Event handlers should add whole translation keys, ie, keys that include the plugin name. - * For example: + * + * **Example** * - * ``` - * public function getClientSideTranslationKeys(&$result) - * { - * $result[] = "MyPlugin_MyTranslation"; - * } - * ``` + * public function getClientSideTranslationKeys(&$result) + * { + * $result[] = "MyPlugin_MyTranslation"; + * } + * + * @param array &$result The whole list of client side translation keys. */ Piwik::postEvent('Translate.getClientSideTranslationKeys', array(&$result)); |