Newer
Older
/*+**********************************************************************************
* The contents of this file are subject to the vtiger CRM Public License Version 1.1
* ("License"); You may not use this file except in compliance with the License
* The Original Code is: vtiger CRM Open Source
* The Initial Developer of the Original Code is vtiger.
* Portions created by vtiger are Copyright (C) vtiger.
* All Rights Reserved.
************************************************************************************/
/**
* Class to handler language translations
*/
class Vtiger_Language_Handler {
//Contains module language translations
protected static $languageContainer;
protected static $fileExists = array();
protected static $userLanguage;
/**
* Functions that gets translated string
* @param <String> $key - string which need to be translated
* @param <String> $module - module scope in which the translation need to be check
* @return <String> - translated string
*/
public static function getTranslatedString($key, $module = '', $currentLanguage = '') {
if (empty($currentLanguage)) {
$currentLanguage = self::$userLanguage ? self::$userLanguage : self::getLanguage();
}
//decoding for Start Date & Time and End Date & Time
if (!is_array($key))
$key = decode_html($key);
$translatedString = self::getLanguageTranslatedString($currentLanguage, $key, $module);
// label not found in users language pack, then check in the default language pack(config.inc.php)
if ($translatedString === null) {
$defaultLanguage = vglobal('default_language');
if (!empty($defaultLanguage) && strcasecmp($defaultLanguage, $currentLanguage) !== 0) {
$translatedString = self::getLanguageTranslatedString($defaultLanguage, $key, $module);
}
}
// If translation is not found then return label
if ($translatedString === null) {
$translatedString = $key;
}
return $translatedString;
}
/**
* Function returns language specific translated string
* @param <String> $language - en_us etc
* @param <String> $key - label
* @param <String> $module - module name
* @return <String> translated string or null if translation not found
*/
public static function getLanguageTranslatedString($language, $key, $module = '') {
$moduleStrings = array();
if ($module !== null) {
$module = str_replace(':', '.', $module);
}
if (is_array($module))
return null;
$moduleStrings = self::getModuleStringsFromFile($language, $module);
if (!empty($moduleStrings['languageStrings'][$key])) {
return $moduleStrings['languageStrings'][$key];
}
// Lookup for the translation in base module, in case of sub modules, before ending up with common strings
if ($module != null && strpos($module, '.') > 0) {
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
$baseModule = substr($module, 0, strpos($module, '.'));
if ($baseModule == 'Settings') {
$baseModule = 'Settings.Vtiger';
}
$moduleStrings = self::getModuleStringsFromFile($language, $baseModule);
if (!empty($moduleStrings['languageStrings'][$key])) {
return $moduleStrings['languageStrings'][$key];
}
}
$commonStrings = self::getModuleStringsFromFile($language);
if (!empty($commonStrings['languageStrings'][$key]))
return $commonStrings['languageStrings'][$key];
return null;
}
/**
* Functions that gets translated string for Client side
* @param <String> $key - string which need to be translated
* @param <String> $module - module scope in which the translation need to be check
* @return <String> - translated string
*/
public static function getJSTranslatedString($language, $key, $module = '') {
$moduleStrings = array();
$module = str_replace(':', '.', $module);
$moduleStrings = self::getModuleStringsFromFile($language, $module);
if (!empty($moduleStrings['jsLanguageStrings'][$key])) {
return $moduleStrings['jsLanguageStrings'][$key];
}
// Lookup for the translation in base module, in case of sub modules, before ending up with common strings
if (strpos($module, '.') > 0) {
$baseModule = substr($module, 0, strpos($module, '.'));
if ($baseModule == 'Settings') {
$baseModule = 'Settings.Vtiger';
}
$moduleStrings = self::getModuleStringsFromFile($language, $baseModule);
if (!empty($moduleStrings['jsLanguageStrings'][$key])) {
return $moduleStrings['jsLanguageStrings'][$key];
}
}
$commonStrings = self::getModuleStringsFromFile($language);
if (!empty($commonStrings['jsLanguageStrings'][$key]))
return $commonStrings['jsLanguageStrings'][$key];
return $key;
}
/**
* Function that returns translation strings from file
* @global <array> $languageStrings - language specific string which is used in translations
* @param <String> $module - module Name
* @return <array> - array if module has language strings else returns empty array
*/
public static function getModuleStringsFromFile($language, $module='Vtiger'){
if($module !== null) $module = str_replace(':', '.', $module);
if (!empty(self::$languageContainer[$language][$module])) {
return self::$languageContainer[$language][$module];
}
if(empty(self::$languageContainer[$language][$module])){
$qualifiedName = 'languages.'.$language.'.'.$module;
$file = Vtiger_Loader::resolveNameToPath($qualifiedName);
$languageStrings = $jsLanguageStrings = array();
self::$fileExists[$file] = file_exists($file) ? 'yes' : 'no';
}
if (self::$fileExists[$file] == 'yes') {
checkFileAccessForInclusion($file);
require $file;
self::$languageContainer[$language][$module]['languageStrings'] = $languageStrings;
self::$languageContainer[$language][$module]['jsLanguageStrings'] = $jsLanguageStrings;
}
}
// add custom translation for module from language/custom/$language/$module.php file
$qualifiedCustomName = 'languages.custom.'.$language.'.'.$module;
$file = Vtiger_Loader::resolveNameToPath($qualifiedCustomName);
$languageStrings = $jsLanguageStrings = array();
self::$fileExists[$file] = file_exists($file) ? 'yes' : 'no';
}
if (self::$fileExists[$file] == 'yes') {
checkFileAccessForInclusion($file);
require $file;
self::$languageContainer[$language][$module]['languageStrings'] = array_merge(self::$languageContainer[$language][$module]['languageStrings'],$languageStrings);
self::$languageContainer[$language][$module]['jsLanguageStrings'] = array_merge(self::$languageContainer[$language][$module]['jsLanguageStrings'],$jsLanguageStrings);
}
$return = array();
if(isset(self::$languageContainer[$language][$module])){
$return = self::$languageContainer[$language][$module];
}
return $return;
}
/**
* Function that returns current language
* @return <String> -
*/
public static function getLanguage() {
if (self::$userLanguage) {
return self::$userLanguage;
}
$userModel = Users_Record_Model::getCurrentUserModel();
$language = '';
Prasad
committed
if (!empty($userModel) && $userModel->has('language')) {
$userLang = empty($language) ? vglobal('default_language') : $language;
self::$userLanguage = $userLang;
return $userLang;
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
}
/**
* Function that returns current language short name
* @return <String> -
*/
public static function getShortLanguageName() {
$language = self::getLanguage();
return substr($language, 0, 2);
}
/**
* Function returns module strings
* @param <String> $module - module Name
* @param <String> languageStrings or jsLanguageStrings
* @return <Array>
*/
public static function export($module, $type = 'languageStrings') {
$userSelectedLanguage = self::getLanguage();
$defaultLanguage = vglobal('default_language');
$languages = array($userSelectedLanguage);
//To merge base language and user selected language translations
if ($userSelectedLanguage != $defaultLanguage) {
array_push($languages, $defaultLanguage);
}
$resultantLanguageString = array();
foreach ($languages as $currentLanguage) {
$exportLangString = array();
$moduleStrings = self::getModuleStringsFromFile($currentLanguage, $module);
if (!empty($moduleStrings[$type])) {
$exportLangString = $moduleStrings[$type];
}
// Lookup for the translation in base module, in case of sub modules, before ending up with common strings
if (strpos($module, '.') > 0) {
$baseModule = substr($module, 0, strpos($module, '.'));
if ($baseModule == 'Settings') {
$baseModule = 'Settings.Vtiger';
}
$moduleStrings = self::getModuleStringsFromFile($currentLanguage, $baseModule);
if (!empty($moduleStrings[$type])) {
$exportLangString += $commonStrings[$type];
}
}
$commonStrings = self::getModuleStringsFromFile($currentLanguage);
if (!empty($commonStrings[$type])) {
$exportLangString += $commonStrings[$type];
}
$resultantLanguageString += $exportLangString;
}
return $resultantLanguageString;
}
/**
* Function to returns all language information
* @return <Array>
*/
public static function getAllLanguages() {
return Vtiger_Language::getAll();
}
/**
* Function to get the label name of the Langauge package
* @param <String> $name
*/
public static function getLanguageLabel($name) {
$db = PearDatabase::getInstance();
$languageResult = $db->pquery('SELECT label FROM vtiger_language WHERE prefix = ?', array($name));
if ($db->num_rows($languageResult)) {
return $db->query_result($languageResult, 0, 'label');
}
return false;
}
}
function vtranslate($key, $moduleName = '') {
$unformattedArgs = func_get_args();
if(php7_count($unformattedArgs) > 2){
// slice an array by taking first 2 values into another array.
$formattedArgs = array_slice($unformattedArgs,0,2);
// Make third value as empty
$formattedArgs['2'] = '';
$sliced_part = array_slice($unformattedArgs,2);
foreach ($sliced_part as $key => $value) {
array_push($formattedArgs,$value);
}
$args = $formattedArgs;
} else {
$args = $unformattedArgs;
}
$formattedString = call_user_func_array(array('Vtiger_Language_Handler', 'getTranslatedString'), $args);
if(php7_count($unformattedArgs) > 2){
// Remove first three values from an array (key,modulename,languagecode)
array_shift($args); array_shift($args);array_shift($args);
} else {
// Remove first two values from an array (key,modulename)
array_shift($args); array_shift($args);
}
if(is_array($args) && !empty($args)) {
$formattedString = call_user_func_array('vsprintf', array($formattedString, $args));
}
return $formattedString;
}
function vJSTranslate($key, $moduleName = '') {
$args = func_get_args();
return call_user_func_array(array('Vtiger_Language_Handler', 'getJSTranslatedString'), $args);