5 use Gettext\GettextTranslator
;
6 use Gettext\Translations
;
7 use Gettext\Translator
;
8 use Gettext\TranslatorInterface
;
9 use Shaarli\Config\ConfigManager
;
14 * Load Shaarli translations using 'gettext/gettext'.
15 * This class allows to either use PHP gettext extension, or a PHP implementation of gettext,
16 * with a fixed language, or dynamically using autoLocale().
18 * Translation files PO/MO files follow gettext standard and must be placed under:
19 * <translation path>/<language>/LC_MESSAGES/<domain>.[po|mo]
22 * - gettext extension is faster
23 * - gettext is very system dependent (PHP extension, the locale must be installed, and web server reloaded)
27 * - auto: use default setting (PHP implementation)
28 * - php: use PHP implementation
29 * - gettext: use gettext wrapper
30 * - translation.language:
31 * - auto: use autoLocale() and the language change according to user HTTP headers
32 * - fixed language: e.g. 'fr'
33 * - translation.extensions:
34 * - domain => translation_path: allow plugins and themes to extend the defaut extension
35 * The domain must be unique, and translation path must be relative, and contains the tree mentioned above.
42 * Core translations domain
44 const DEFAULT_DOMAIN
= 'shaarli';
47 * @var TranslatorInterface
49 protected $translator;
62 * Languages constructor.
64 * @param string $language lang determined by autoLocale(), can be overridden.
65 * @param ConfigManager $conf instance.
67 public function __construct($language, $conf)
70 $confLanguage = $this->conf
->get('translation.language', 'auto');
71 // Auto mode or invalid parameter, use the detected language.
72 // If the detected language is invalid, it doesn't matter, it will use English.
73 if ($confLanguage === 'auto' || ! $this->isValidLanguage($confLanguage)) {
74 $this->language
= substr($language, 0, 5);
76 $this->language
= $confLanguage;
79 if (! extension_loaded('gettext')
80 || in_array($this->conf
->get('translation.mode', 'auto'), ['auto', 'php'])
82 $this->initPhpTranslator();
84 $this->initGettextTranslator();
87 // Register default functions (e.g. '__()') to use our Translator
88 $this->translator
->register();
92 * Initialize the translator using php gettext extension (gettext dependency act as a wrapper).
94 protected function initGettextTranslator()
96 $this->translator
= new GettextTranslator();
97 $this->translator
->setLanguage($this->language
);
98 $this->translator
->loadDomain(self
::DEFAULT_DOMAIN
, 'inc/languages');
100 // Default extension translation from the current theme
101 $themeTransFolder = rtrim($this->conf
->get('raintpl_tpl'), '/') .'/'. $this->conf
->get('theme') .'/language';
102 if (is_dir($themeTransFolder)) {
103 $this->translator
->loadDomain($this->conf
->get('theme'), $themeTransFolder, false);
106 foreach ($this->conf
->get('translation.extensions', []) as $domain => $translationPath) {
107 if ($domain !== self
::DEFAULT_DOMAIN
) {
108 $this->translator
->loadDomain($domain, $translationPath, false);
114 * Initialize the translator using a PHP implementation of gettext.
116 * Note that if language po file doesn't exist, errors are ignored (e.g. not installed language).
118 protected function initPhpTranslator()
120 $this->translator
= new Translator();
121 $translations = new Translations();
124 $translations = $translations->addFromPoFile('inc/languages/'. $this->language
.'/LC_MESSAGES/shaarli.po');
125 $translations->setDomain('shaarli');
126 $this->translator
->loadTranslations($translations);
127 } catch (\InvalidArgumentException
$e) {
130 // Default extension translation from the current theme
131 $theme = $this->conf
->get('theme');
132 $themeTransFolder = rtrim($this->conf
->get('raintpl_tpl'), '/') .'/'. $theme .'/language';
133 if (is_dir($themeTransFolder)) {
135 $translations = Translations
::fromPoFile(
136 $themeTransFolder .'/'. $this->language
.'/LC_MESSAGES/'. $theme .'.po'
138 $translations->setDomain($theme);
139 $this->translator
->loadTranslations($translations);
140 } catch (\InvalidArgumentException
$e) {
144 // Extension translations (plugins, themes, etc.).
145 foreach ($this->conf
->get('translation.extensions', []) as $domain => $translationPath) {
146 if ($domain === self
::DEFAULT_DOMAIN
) {
151 $extension = Translations
::fromPoFile(
152 $translationPath . $this->language
.'/LC_MESSAGES/'. $domain .'.po'
154 $extension->setDomain($domain);
155 $this->translator
->loadTranslations($extension);
156 } catch (\InvalidArgumentException
$e) {
162 * Checks if a language string is valid.
164 * @param string $language e.g. 'fr' or 'en_US'
166 * @return bool true if valid, false otherwise
168 protected function isValidLanguage($language)
170 return preg_match('/^[a-z]{2}(_[A-Z]{2})?/', $language) === 1;
174 * Get the list of available languages for Shaarli.
176 * @return array List of available languages, with their label.
178 public static function getAvailableLanguages()
181 'auto' => t('Automatic'),
182 'en' => t('English'),