CRM/Core/I18n.php

   1 <?php
   2 /*
   3  +--------------------------------------------------------------------+
   4  | Copyright CiviCRM LLC. All rights reserved.                        |
   5  |                                                                    |
   6  | This work is published under the GNU AGPLv3 license with some      |
   7  | permitted exceptions and without any warranty. For full license    |
   8  | and copyright information, see https://civicrm.org/licensing       |
   9  +--------------------------------------------------------------------+
  10  */
  11
  12 /**
  13  *
  14  * @package CRM
  15  * @copyright CiviCRM LLC https://civicrm.org/licensing
  16  */
  17 class CRM_Core_I18n {
  18
  19   /**
  20    * Constants for communication preferences.
  21    *
  22    * @var int
  23    */
  24   const NONE = 'none', AUTO = 'auto';
  25
  26   /**
  27    * @var callable|null
  28    *   A callback function which handles SQL string encoding.
  29    *   Set NULL to use the default, CRM_Core_DAO::escapeString().
  30    *   This is used by `ts(..., [escape=>sql])`.
  31    *
  32    * This option is not intended for general consumption. It is only intended
  33    * for certain pre-boot/pre-install contexts.
  34    *
  35    * You might ask, "Why on Earth does string-translation have an opinion on
  36    * SQL escaping?" Good question!
  37    */
  38   public static $SQL_ESCAPER = NULL;
  39
  40   /**
  41    * Escape a string if a mode is specified, otherwise return string unmodified.
  42    *
  43    * @param string $text
  44    * @param string $mode
  45    * @return string
  46    */
  47   protected static function escape($text, $mode) {
  48     switch ($mode) {
  49       case 'sql':
  50         if (self::$SQL_ESCAPER == NULL) {
  51           return CRM_Core_DAO::escapeString($text);
  52         }
  53         else {
  54           return call_user_func(self::$SQL_ESCAPER, $text);
  55         }
  56
  57       case 'js':
  58         return substr(json_encode($text, JSON_UNESCAPED_SLASHES | JSON_UNESCAPED_UNICODE | JSON_HEX_TAG | JSON_HEX_AMP | JSON_HEX_APOS | JSON_HEX_QUOT), 1, -1);
  59     }
  60     return $text;
  61   }
  62
  63   /**
  64    * A PHP-gettext instance for string translation;
  65    * should stay null if the strings are not to be translated (en_US).
  66    * @var object
  67    */
  68   private $_phpgettext = NULL;
  69
  70   /**
  71    * Whether we are using native gettext or not.
  72    * @var bool
  73    */
  74   private $_nativegettext = FALSE;
  75
  76   /**
  77    * Gettext cache for extension domains/streamers, depending on if native or phpgettext.
  78    * - native gettext: we cache the value for textdomain()
  79    * - phpgettext: we cache the file streamer.
  80    * @var array
  81    */
  82   private $_extensioncache = [];
  83
  84   /**
  85    * @var string
  86    */
  87   private $locale;
  88
  89   /**
  90    * A locale-based constructor that shouldn't be called from outside of this class (use singleton() instead).
  91    *
  92    * @param string $locale
  93    *   the base of this certain object's existence.
  94    *
  95    * @return \CRM_Core_I18n
  96    */
  97   public function __construct($locale) {
  98     $this->locale = $locale;
  99     if ($locale != '' and $locale != 'en_US') {
 100       if (defined('CIVICRM_GETTEXT_NATIVE') && CIVICRM_GETTEXT_NATIVE && function_exists('gettext')) {
 101         // Note: the file hierarchy for .po must be, for example: l10n/fr_FR/LC_MESSAGES/civicrm.mo
 102
 103         $this->_nativegettext = TRUE;
 104         $this->setNativeGettextLocale($locale);
 105         return;
 106       }
 107
 108       // Otherwise, use PHP-gettext
 109       $this->setPhpGettextLocale($locale);
 110     }
 111   }
 112
 113   /**
 114    * Returns whether gettext is running natively or using PHP-Gettext.
 115    *
 116    * @return bool
 117    *   True if gettext is native
 118    */
 119   public function isNative() {
 120     return $this->_nativegettext;
 121   }
 122
 123   /**
 124    * Set native locale for getText.
 125    *
 126    * @param string $locale
 127    */
 128   protected function setNativeGettextLocale($locale) {
 129
 130     $locale .= '.utf8';
 131     putenv("LANG=$locale");
 132
 133     // CRM-11833 Avoid LC_ALL because of LC_NUMERIC and potential DB error.
 134     setlocale(LC_TIME, $locale);
 135     setlocale(LC_MESSAGES, $locale);
 136     setlocale(LC_CTYPE, $locale);
 137
 138     bindtextdomain('civicrm', CRM_Core_I18n::getResourceDir());
 139     bind_textdomain_codeset('civicrm', 'UTF-8');
 140     textdomain('civicrm');
 141
 142     $this->_phpgettext = new CRM_Core_I18n_NativeGettext();
 143     $this->_extensioncache['civicrm'] = 'civicrm';
 144
 145   }
 146
 147   /**
 148    * Set getText locale.
 149    *
 150    * @param string $locale
 151    */
 152   protected function setPhpGettextLocale($locale) {
 153
 154     // we support both the old file hierarchy format and the new:
 155     // pre-4.5:  civicrm/l10n/xx_XX/civicrm.mo
 156     // post-4.5: civicrm/l10n/xx_XX/LC_MESSAGES/civicrm.mo
 157     require_once 'PHPgettext/streams.php';
 158     require_once 'PHPgettext/gettext.php';
 159
 160     $mo_file = CRM_Core_I18n::getResourceDir() . $locale . DIRECTORY_SEPARATOR . 'LC_MESSAGES' . DIRECTORY_SEPARATOR . 'civicrm.mo';
 161
 162     if (!file_exists($mo_file)) {
 163       // fallback to pre-4.5 mode
 164       $mo_file = CRM_Core_I18n::getResourceDir() . $locale . DIRECTORY_SEPARATOR . 'civicrm.mo';
 165     }
 166
 167     $streamer = new FileReader($mo_file);
 168     $this->_phpgettext = new gettext_reader($streamer);
 169     $this->_extensioncache['civicrm'] = $this->_phpgettext;
 170
 171   }
 172
 173   /**
 174    * Return languages available in this instance of CiviCRM.
 175    *
 176    * @param bool $justEnabled
 177    *   whether to return all languages or just the enabled ones.
 178    *
 179    * @return array
 180    *   Array of code/language name mappings
 181    */
 182   public static function languages($justEnabled = FALSE) {
 183     static $all = NULL;
 184     static $enabled = NULL;
 185
 186     if (!$all) {
 187       $all = CRM_Contact_BAO_Contact::buildOptions('preferred_language');
 188
 189       // get labels
 190       $rows = [];
 191       $labels = [];
 192       CRM_Core_OptionValue::getValues(['name' => 'languages'], $rows);
 193       foreach ($rows as $id => $row) {
 194         $labels[$row['name']] = $row['label'];
 195       }
 196
 197       // check which ones are available; add them to $all if not there already
 198       $codes = [];
 199       if (is_dir(CRM_Core_I18n::getResourceDir()) && $dir = opendir(CRM_Core_I18n::getResourceDir())) {
 200         while ($filename = readdir($dir)) {
 201           if (preg_match('/^[a-z][a-z]_[A-Z][A-Z]$/', $filename)) {
 202             $codes[] = $filename;
 203             if (!isset($all[$filename])) {
 204               $all[$filename] = $labels[$filename] ?? "($filename)";
 205             }
 206           }
 207         }
 208         closedir($dir);
 209       }
 210
 211       // drop the unavailable languages (except en_US)
 212       foreach (array_keys($all) as $code) {
 213         if ($code == 'en_US') {
 214           continue;
 215         }
 216         if (!in_array($code, $codes)) {
 217           unset($all[$code]);
 218         }
 219       }
 220
 221       asort($all);
 222     }
 223
 224     if ($enabled === NULL) {
 225       $languageLimit = Civi::settings()->get('languageLimit');
 226       $enabled = [];
 227       if ($languageLimit) {
 228         foreach ($all as $code => $name) {
 229           if (array_key_exists($code, $languageLimit)) {
 230             $enabled[$code] = $name;
 231           }
 232         }
 233       }
 234     }
 235
 236     return $justEnabled ? $enabled : $all;
 237   }
 238
 239   /**
 240    * Return the available UI languages
 241    * @return array|string
 242    *   array(string languageCode => string languageName) if !$justCodes
 243    */
 244   public static function uiLanguages($justCodes = FALSE) {
 245     // In multilang we only allow the languages that are configured in db
 246     // Otherwise, the languages configured in uiLanguages
 247     $settings = Civi::settings();
 248     if (CRM_Core_I18n::isMultiLingual()) {
 249       $codes = array_keys((array) $settings->get('languageLimit'));
 250     }
 251     else {
 252       $codes = $settings->get('uiLanguages');
 253       if (!$codes) {
 254         $codes = [$settings->get('lcMessages')];
 255       }
 256     }
 257     return $justCodes ? $codes
 258         : CRM_Utils_Array::subset(CRM_Core_I18n::languages(), $codes);
 259   }
 260
 261   /**
 262    * Replace arguments in a string with their values. Arguments are represented by % followed by their number.
 263    *
 264    * @param string $str
 265    *   source string.
 266    *
 267    * @return string
 268    *   modified string
 269    */
 270   public function strarg($str) {
 271     $tr = [];
 272     $p = 0;
 273     for ($i = 1; $i < func_num_args(); $i++) {
 274       $arg = func_get_arg($i);
 275       if (is_array($arg)) {
 276         foreach ($arg as $aarg) {
 277           $tr['%' . ++$p] = $aarg;
 278         }
 279       }
 280       else {
 281         $tr['%' . ++$p] = $arg;
 282       }
 283     }
 284     return strtr($str, $tr);
 285   }
 286
 287   /**
 288    * Get the directory for l10n resources.
 289    *
 290    * @return string
 291    */
 292   public static function getResourceDir() {
 293     return CRM_Utils_File::addTrailingSlash(\Civi::paths()->getPath('[civicrm.l10n]/.'));
 294   }
 295
 296   /**
 297    * Smarty block function, provides gettext support for smarty.
 298    *
 299    * The block content is the text that should be translated.
 300    *
 301    * Any parameter that is sent to the function will be represented as %n in the translation text,
 302    * where n is 1 for the first parameter. The following parameters are reserved:
 303    *   - escape - sets escape mode:
 304    *       - 'html' for HTML escaping, this is the default.
 305    *       - 'js' for javascript escaping.
 306    *       - 'no'/'off'/0 - turns off escaping
 307    *   - plural - The plural version of the text (2nd parameter of ngettext())
 308    *   - count - The item count for plural mode (3rd parameter of ngettext())
 309    *   - context - gettext context of that string (for homonym handling)
 310    *
 311    * @param string $text
 312    *   the original string.
 313    * @param array $params
 314    *   The params of the translation (if any).
 315    *   - domain: string|array a list of translation domains to search (in order)
 316    *   - context: string
 317    *   - skip_translation: flag (do only escape/replacement, skip the actual translation)
 318    *
 319    * @return string
 320    *   the translated string
 321    */
 322   public function crm_translate($text, $params = []) {
 323     $escape = $params['escape'] ?? NULL;
 324     unset($params['escape']);
 325
 326     // sometimes we need to {ts}-tag a string, but don’t want to
 327     // translate it in the template (like civicrm_navigation.tpl),
 328     // because we handle the translation in a different way (CRM-6998)
 329     // in such cases we return early, only doing SQL/JS escaping
 330     if (isset($params['skip']) and $params['skip']) {
 331       return self::escape($text, $escape);
 332     }
 333
 334     $plural = $count = NULL;
 335     if (isset($params['plural'])) {
 336       $plural = $params['plural'];
 337       unset($params['plural']);
 338       if (isset($params['count'])) {
 339         $count = $params['count'];
 340       }
 341     }
 342
 343     if (isset($params['context'])) {
 344       $context = $params['context'];
 345       unset($params['context']);
 346     }
 347     else {
 348       $context = NULL;
 349     }
 350
 351     if (isset($params['domain'])) {
 352       $domain = $params['domain'];
 353       unset($params['domain']);
 354     }
 355     else {
 356       $domain = NULL;
 357     }
 358
 359     $raw = !empty($params['raw']);
 360     unset($params['raw']);
 361
 362     if (!isset($params['skip_translation'])) {
 363       if (!empty($domain)) {
 364         // It might be prettier to cast to an array, but this is high-traffic stuff.
 365         if (is_array($domain)) {
 366           foreach ($domain as $d) {
 367             $candidate = $this->crm_translate_raw($text, $d, $count, $plural, $context);
 368             if ($candidate != $text) {
 369               $text = $candidate;
 370               break;
 371             }
 372           }
 373         }
 374         else {
 375           $text = $this->crm_translate_raw($text, $domain, $count, $plural, $context);
 376         }
 377       }
 378       else {
 379         $text = $this->crm_translate_raw($text, NULL, $count, $plural, $context);
 380       }
 381     }
 382
 383     // replace the numbered %1, %2, etc. params if present
 384     if (count($params) && !$raw) {
 385       $text = $this->strarg($text, $params);
 386     }
 387
 388     return self::escape($text, $escape);
 389   }
 390
 391   /**
 392    * Lookup the raw translation of a string (without any extra escaping or interpolation).
 393    *
 394    * @param string $text
 395    * @param string|null $domain
 396    * @param int|null $count
 397    * @param string $plural
 398    * @param string $context
 399    *
 400    * @return string
 401    */
 402   protected function crm_translate_raw($text, $domain, $count, $plural, $context) {
 403     // gettext domain for extensions
 404     $domain_changed = FALSE;
 405     if (!empty($domain) && $this->_phpgettext) {
 406       if ($this->setGettextDomain($domain)) {
 407         $domain_changed = TRUE;
 408       }
 409     }
 410
 411     // do all wildcard translations first
 412
 413     $stringTable = $this->getWordReplacements();
 414
 415     $exactMatch = FALSE;
 416     if (isset($stringTable['enabled']['exactMatch'])) {
 417       foreach ($stringTable['enabled']['exactMatch'] as $search => $replace) {
 418         if ($search === $text) {
 419           $exactMatch = TRUE;
 420           $text = $replace;
 421           break;
 422         }
 423       }
 424     }
 425
 426     if (
 427       !$exactMatch &&
 428       isset($stringTable['enabled']['wildcardMatch'])
 429     ) {
 430       $search = array_keys($stringTable['enabled']['wildcardMatch']);
 431       $replace = array_values($stringTable['enabled']['wildcardMatch']);
 432       $text = str_replace($search, $replace, $text);
 433     }
 434
 435     // dont translate if we've done exactMatch already
 436     if (!$exactMatch) {
 437       // use plural if required parameters are set
 438       if (isset($count) && isset($plural)) {
 439
 440         if ($this->_phpgettext) {
 441           $text = $this->_phpgettext->ngettext($text, $plural, (int) $count);
 442         }
 443         else {
 444           // if the locale's not set, we do ngettext work by hand
 445           // if $count == 1 then $text = $text, else $text = $plural
 446           if ($count != 1) {
 447             $text = $plural;
 448           }
 449         }
 450
 451         // expand %count in translated string to $count
 452         $text = strtr($text, ['%count' => $count]);
 453
 454         // if not plural, but the locale's set, translate
 455       }
 456       elseif ($this->_phpgettext) {
 457         if ($context) {
 458           $text = $this->_phpgettext->pgettext($context, $text);
 459         }
 460         else {
 461           $text = $this->_phpgettext->translate($text);
 462         }
 463       }
 464     }
 465
 466     if ($domain_changed) {
 467       $this->setGettextDomain('civicrm');
 468     }
 469
 470     return $text;
 471   }
 472
 473   /**
 474    * Translate a string to the current locale.
 475    *
 476    * @param string $string
 477    *   this string should be translated.
 478    *
 479    * @return string
 480    *   the translated string
 481    */
 482   public function translate($string) {
 483     return ($this->_phpgettext) ? $this->_phpgettext->translate($string) : $string;
 484   }
 485
 486   /**
 487    * Localize (destructively) array values.
 488    *
 489    * @param array $array
 490    *   the array for localization (in place).
 491    * @param array $params
 492    *   an array of additional parameters.
 493    */
 494   public function localizeArray(
 495     &$array,
 496     $params = []
 497   ) {
 498     $tsLocale = CRM_Core_I18n::getLocale();
 499
 500     if ($tsLocale == 'en_US') {
 501       return;
 502     }
 503
 504     foreach ($array as & $value) {
 505       if ($value) {
 506         $value = ts($value, $params);
 507       }
 508     }
 509   }
 510
 511   /**
 512    * Localize (destructively) array elements with keys of 'title'.
 513    *
 514    * @param array $array
 515    *   the array for localization (in place).
 516    */
 517   public function localizeTitles(&$array) {
 518     foreach ($array as $key => $value) {
 519       if (is_array($value)) {
 520         $this->localizeTitles($value);
 521         $array[$key] = $value;
 522       }
 523       elseif ((string ) $key == 'title') {
 524         $array[$key] = ts($value, ['context' => 'menu']);
 525       }
 526     }
 527   }
 528
 529   /**
 530    * Binds a gettext domain, wrapper over bindtextdomain().
 531    *
 532    * @param $key
 533    *   Key of the extension (can be 'civicrm', or 'org.example.foo').
 534    *
 535    * @return Bool
 536    *   True if the domain was changed for an extension.
 537    */
 538   public function setGettextDomain($key) {
 539     /* No domain changes for en_US */
 540     if (!$this->_phpgettext) {
 541       return FALSE;
 542     }
 543
 544     // It's only necessary to find/bind once
 545     if (!isset($this->_extensioncache[$key])) {
 546       try {
 547         $mapper = CRM_Extension_System::singleton()->getMapper();
 548         $path = $mapper->keyToBasePath($key);
 549         $info = $mapper->keyToInfo($key);
 550         $domain = $info->file;
 551
 552         if ($this->_nativegettext) {
 553           bindtextdomain($domain, $path . DIRECTORY_SEPARATOR . 'l10n');
 554           bind_textdomain_codeset($domain, 'UTF-8');
 555           $this->_extensioncache[$key] = $domain;
 556         }
 557         else {
 558           // phpgettext
 559           $mo_file = $path . DIRECTORY_SEPARATOR . 'l10n' . DIRECTORY_SEPARATOR . $this->locale . DIRECTORY_SEPARATOR . 'LC_MESSAGES' . DIRECTORY_SEPARATOR . $domain . '.mo';
 560           $streamer = new FileReader($mo_file);
 561           $this->_extensioncache[$key] = new gettext_reader($streamer);
 562         }
 563       }
 564       catch (CRM_Extension_Exception $e) {
 565         // Intentionally not translating this string to avoid possible infinite loops
 566         // Only developers should see this string, if they made a mistake in their ts() usage.
 567         CRM_Core_Session::setStatus('Unknown extension key in a translation string: ' . $key, '', 'error');
 568         $this->_extensioncache[$key] = FALSE;
 569       }
 570     }
 571
 572     if (isset($this->_extensioncache[$key]) && $this->_extensioncache[$key]) {
 573       if ($this->_nativegettext) {
 574         textdomain($this->_extensioncache[$key]);
 575       }
 576       else {
 577         $this->_phpgettext = $this->_extensioncache[$key];
 578       }
 579
 580       return TRUE;
 581     }
 582
 583     return FALSE;
 584   }
 585
 586   /**
 587    * Is the current CiviCRM domain in multilingual mode.
 588    *
 589    * @return Bool
 590    *   True if CiviCRM is in multilingual mode.
 591    */
 592   public static function isMultilingual() {
 593     $domainId = CRM_Core_Config::domainID();
 594     return (bool) CRM_Core_DAO::getFieldValue('CRM_Core_DAO_Domain', $domainId, 'locales');
 595   }
 596
 597   /**
 598    * Is the language written "right-to-left"?
 599    *
 600    * @param $language
 601    *   Language (for example 'en_US', or 'fr_CA').
 602    *
 603    * @return Bool
 604    *   True if it is an RTL language.
 605    */
 606   public static function isLanguageRTL($language) {
 607     $rtl = CRM_Core_I18n_PseudoConstant::getRTLlanguages();
 608     $short = CRM_Core_I18n_PseudoConstant::shortForLong($language);
 609
 610     return (in_array($short, $rtl));
 611   }
 612
 613   /**
 614    * If you switch back/forth between locales/drivers, it may be necessary
 615    * to reset some options.
 616    */
 617   protected function reactivate() {
 618     if ($this->_nativegettext) {
 619       $this->setNativeGettextLocale($this->locale);
 620     }
 621
 622   }
 623
 624   /**
 625    * Change the processing language without changing the current user language
 626    *
 627    * @param $locale
 628    *   Locale (for example 'en_US', or 'fr_CA').
 629    *   True if the domain was changed for an extension.
 630    */
 631   public function setLocale($locale) {
 632
 633     // Change the language of the CMS as well, for URLs.
 634     CRM_Utils_System::setUFLocale($locale);
 635
 636     // For sql queries, if running in DB multi-lingual mode.
 637     global $dbLocale;
 638
 639     if ($dbLocale) {
 640       $dbLocale = "_{$locale}";
 641     }
 642
 643     // For self::getLocale()
 644     global $tsLocale;
 645     $tsLocale = $locale;
 646
 647     CRM_Core_I18n::singleton()->reactivate();
 648   }
 649
 650   /**
 651    * Static instance provider - return the instance for the current locale.
 652    *
 653    * @return CRM_Core_I18n
 654    */
 655   public static function &singleton() {
 656     if (!isset(Civi::$statics[__CLASS__]['singleton'])) {
 657       Civi::$statics[__CLASS__]['singleton'] = [];
 658     }
 659     $tsLocale = CRM_Core_I18n::getLocale();
 660     if (!isset(Civi::$statics[__CLASS__]['singleton'][$tsLocale])) {
 661       Civi::$statics[__CLASS__]['singleton'][$tsLocale] = new CRM_Core_I18n($tsLocale);
 662     }
 663
 664     return Civi::$statics[__CLASS__]['singleton'][$tsLocale];
 665   }
 666
 667   /**
 668    * Set the LC_TIME locale if it's not set already (for a given language choice).
 669    *
 670    * @return string
 671    *   the final LC_TIME that got set
 672    */
 673   public static function setLcTime() {
 674     static $locales = [];
 675
 676     $tsLocale = CRM_Core_I18n::getLocale();
 677     if (!isset($locales[$tsLocale])) {
 678       // with the config being set to pl_PL: try pl_PL.UTF-8,
 679       // then pl_PL, if neither present fall back to C
 680       $locales[$tsLocale] = setlocale(LC_TIME, $tsLocale . '.UTF-8', $tsLocale, 'C');
 681     }
 682
 683     return $locales[$tsLocale];
 684   }
 685
 686   /**
 687    * Get the default language for contacts where no language is provided.
 688    *
 689    * Note that NULL is a valid option so be careful with checking for empty etc.
 690    *
 691    * NULL would mean 'we don't know & we don't want to hazard a guess'.
 692    *
 693    * @return string
 694    */
 695   public static  function getContactDefaultLanguage() {
 696     $language = Civi::settings()->get('contact_default_language');
 697     if ($language == 'undefined') {
 698       return NULL;
 699     }
 700     if (empty($language) || $language === '*default*') {
 701       $language = civicrm_api3('setting', 'getvalue', [
 702         'name' => 'lcMessages',
 703         'group' => CRM_Core_BAO_Setting::LOCALIZATION_PREFERENCES_NAME,
 704       ]);
 705     }
 706     elseif ($language == 'current_site_language') {
 707       return CRM_Core_I18n::getLocale();
 708     }
 709
 710     return $language;
 711   }
 712
 713   /**
 714    * Get the current locale
 715    *
 716    * @return string
 717    */
 718   public static function getLocale() {
 719     global $tsLocale;
 720     return $tsLocale ? $tsLocale : 'en_US';
 721   }
 722
 723   /**
 724    * @return array
 725    *   Ex: $stringTable['enabled']['wildcardMatch']['foo'] = 'bar';
 726    */
 727   private function getWordReplacements() {
 728     if (isset(Civi::$statics['testPreInstall'])) {
 729       return [];
 730     }
 731
 732     // FIXME: Is there a constant we can reference instead of hardcoding en_US?
 733     $replacementsLocale = $this->locale ? $this->locale : 'en_US';
 734     if ((!isset(Civi::$statics[__CLASS__]) || !array_key_exists($replacementsLocale, Civi::$statics[__CLASS__]))) {
 735       if (defined('CIVICRM_DSN') && !CRM_Core_Config::isUpgradeMode()) {
 736         Civi::$statics[__CLASS__][$replacementsLocale] = CRM_Core_BAO_WordReplacement::getLocaleCustomStrings($replacementsLocale);
 737       }
 738       else {
 739         Civi::$statics[__CLASS__][$replacementsLocale] = [];
 740       }
 741     }
 742     return Civi::$statics[__CLASS__][$replacementsLocale];
 743   }
 744
 745 }
 746
 747 /**
 748  * Short-named function for string translation, defined in global scope so it's available everywhere.
 749  *
 750  * @param string $text
 751  *   String string for translating.
 752  * @param array $params
 753  *   Array an array of additional parameters.
 754  *
 755  * @return string
 756  *   the translated string
 757  */
 758 function ts($text, $params = []) {
 759   static $bootstrapReady = FALSE;
 760   static $lastLocale = NULL;
 761   static $i18n = NULL;
 762   static $function = NULL;
 763
 764   if ($text == '') {
 765     return '';
 766   }
 767
 768   // When the settings become available, lookup customTranslateFunction.
 769   if (!$bootstrapReady) {
 770     $bootstrapReady = (bool) \Civi\Core\Container::isContainerBooted();
 771     if ($bootstrapReady) {
 772       // just got ready: determine whether there is a working custom translation function
 773       $config = CRM_Core_Config::singleton();
 774       if (isset($config->customTranslateFunction) and function_exists($config->customTranslateFunction)) {
 775         $function = $config->customTranslateFunction;
 776       }
 777     }
 778   }
 779
 780   $activeLocale = CRM_Core_I18n::getLocale();
 781   if (!$i18n or $lastLocale != $activeLocale) {
 782     $i18n = CRM_Core_I18n::singleton();
 783     $lastLocale = $activeLocale;
 784   }
 785
 786   if ($function) {
 787     return $function($text, $params);
 788   }
 789   else {
 790     return $i18n->crm_translate($text, $params);
 791   }
 792 }