5 use Gettext\GettextTranslator
;
7 use Gettext\Translations
;
8 use Gettext\Translator
;
9 use Gettext\TranslatorInterface
;
10 use Shaarli\Config\ConfigManager
;
15 * Load Shaarli translations using 'gettext/gettext'.
16 * This class allows to either use PHP gettext extension, or a PHP implementation of gettext,
17 * with a fixed language, or dynamically using autoLocale().
19 * Translation files PO/MO files follow gettext standard and must be placed under:
20 * <translation path>/<language>/LC_MESSAGES/<domain>.[po|mo]
23 * - gettext extension is faster
24 * - gettext is very system dependent (PHP extension, the locale must be installed, and web server reloaded)
28 * - auto: use default setting (PHP implementation)
29 * - php: use PHP implementation
30 * - gettext: use gettext wrapper
31 * - translation.language:
32 * - auto: use autoLocale() and the language change according to user HTTP headers
33 * - fixed language: e.g. 'fr'
34 * - translation.extensions:
35 * - domain => translation_path: allow plugins and themes to extend the defaut extension
36 * The domain must be unique, and translation path must be relative, and contains the tree mentioned above.
43 * Core translations domain
45 const DEFAULT_DOMAIN
= 'shaarli';
48 * @var TranslatorInterface
50 protected $translator;
63 * Languages constructor.
65 * @param string $language lang determined by autoLocale(), can be overridden.
66 * @param ConfigManager $conf instance.
68 public function __construct($language, $conf)
71 $confLanguage = $this->conf
->get('translation.language', 'auto');
72 // Auto mode or invalid parameter, use the detected language.
73 // If the detected language is invalid, it doesn't matter, it will use English.
74 if ($confLanguage === 'auto' || ! $this->isValidLanguage($confLanguage)) {
75 $this->language
= substr($language, 0, 5);
77 $this->language
= $confLanguage;
80 if (! extension_loaded('gettext')
81 || in_array($this->conf
->get('translation.mode', 'auto'), ['auto', 'php'])
83 $this->initPhpTranslator();
85 $this->initGettextTranslator();
88 // Register default functions (e.g. '__()') to use our Translator
89 $this->translator
->register();
93 * Initialize the translator using php gettext extension (gettext dependency act as a wrapper).
95 protected function initGettextTranslator ()
97 $this->translator
= new GettextTranslator();
98 $this->translator
->setLanguage($this->language
);
99 $this->translator
->loadDomain(self
::DEFAULT_DOMAIN
, 'inc/languages');
101 foreach ($this->conf
->get('translation.extensions', []) as $domain => $translationPath) {
102 if ($domain !== self
::DEFAULT_DOMAIN
) {
103 $this->translator
->loadDomain($domain, $translationPath, false);
109 * Initialize the translator using a PHP implementation of gettext.
111 * Note that if language po file doesn't exist, errors are ignored (e.g. not installed language).
113 protected function initPhpTranslator()
115 $this->translator
= new Translator();
116 $translations = new Translations();
119 /** @var Translations $translations */
120 $translations = $translations->addFromPoFile('inc/languages/'. $this->language
.'/LC_MESSAGES/shaarli.po');
121 $translations->setDomain('shaarli');
122 $this->translator
->loadTranslations($translations);
123 } catch (\InvalidArgumentException
$e) {}
126 // Extension translations (plugins, themes, etc.).
127 foreach ($this->conf
->get('translation.extensions', []) as $domain => $translationPath) {
128 if ($domain === self
::DEFAULT_DOMAIN
) {
133 /** @var Translations $extension */
134 $extension = Translations
::fromPoFile($translationPath . $this->language
.'/LC_MESSAGES/'. $domain .'.po');
135 $extension->setDomain($domain);
136 $this->translator
->loadTranslations($extension);
137 } catch (\InvalidArgumentException
$e) {}
142 * Checks if a language string is valid.
144 * @param string $language e.g. 'fr' or 'en_US'
146 * @return bool true if valid, false otherwise
148 protected function isValidLanguage($language)
150 return preg_match('/^[a-z]{2}(_[A-Z]{2})?/', $language) === 1;
154 * Get the list of available languages for Shaarli.
156 * @return array List of available languages, with their label.
158 public static function getAvailableLanguages()
161 'auto' => t('Automatic'),
162 'en' => t('English'),