| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404 |
- <?php
- /**
- * This file is part of the Carbon package.
- *
- * (c) Brian Nesbitt <brian@nesbot.com>
- *
- * For the full copyright and license information, please view the LICENSE
- * file that was distributed with this source code.
- */
- namespace Carbon;
- use Closure;
- use ReflectionException;
- use ReflectionFunction;
- use Symfony\Component\Translation;
- class Translator extends Translation\Translator
- {
- /**
- * Translator singletons for each language.
- *
- * @var array
- */
- protected static $singletons = [];
- /**
- * List of custom localized messages.
- *
- * @var array
- */
- protected $messages = [];
- /**
- * List of custom directories that contain translation files.
- *
- * @var string[]
- */
- protected $directories = [];
- /**
- * Set to true while constructing.
- *
- * @var bool
- */
- protected $initializing = false;
- /**
- * List of locales aliases.
- *
- * @var string[]
- */
- protected $aliases = [
- 'me' => 'sr_Latn_ME',
- 'scr' => 'sh',
- ];
- /**
- * Return a singleton instance of Translator.
- *
- * @param string|null $locale optional initial locale ("en" - english by default)
- *
- * @return static
- */
- public static function get($locale = null)
- {
- $locale = $locale ?: 'en';
- if (!isset(static::$singletons[$locale])) {
- static::$singletons[$locale] = new static($locale ?: 'en');
- }
- return static::$singletons[$locale];
- }
- public function __construct($locale, Translation\Formatter\MessageFormatterInterface $formatter = null, $cacheDir = null, $debug = false)
- {
- $this->initializing = true;
- $this->directories = [__DIR__.'/Lang'];
- $this->addLoader('array', new Translation\Loader\ArrayLoader());
- parent::__construct($locale, $formatter, $cacheDir, $debug);
- $this->initializing = false;
- }
- /**
- * Returns the list of directories translation files are searched in.
- *
- * @return array
- */
- public function getDirectories(): array
- {
- return $this->directories;
- }
- /**
- * Set list of directories translation files are searched in.
- *
- * @param array $directories new directories list
- *
- * @return $this
- */
- public function setDirectories(array $directories)
- {
- $this->directories = $directories;
- return $this;
- }
- /**
- * Add a directory to the list translation files are searched in.
- *
- * @param string $directory new directory
- *
- * @return $this
- */
- public function addDirectory(string $directory)
- {
- $this->directories[] = $directory;
- return $this;
- }
- /**
- * Remove a directory from the list translation files are searched in.
- *
- * @param string $directory directory path
- *
- * @return $this
- */
- public function removeDirectory(string $directory)
- {
- $search = rtrim(strtr($directory, '\\', '/'), '/');
- return $this->setDirectories(array_filter($this->getDirectories(), function ($item) use ($search) {
- return rtrim(strtr($item, '\\', '/'), '/') !== $search;
- }));
- }
- /**
- * Returns the translation.
- *
- * @param string $id
- * @param array $parameters
- * @param string $domain
- * @param string $locale
- *
- * @return string
- */
- public function trans($id, array $parameters = [], $domain = null, $locale = null)
- {
- if ($domain === null) {
- $domain = 'messages';
- }
- $format = $this->getCatalogue($locale)->get((string) $id, $domain);
- if ($format instanceof Closure) {
- // @codeCoverageIgnoreStart
- try {
- $count = (new ReflectionFunction($format))->getNumberOfRequiredParameters();
- } catch (ReflectionException $exception) {
- $count = 0;
- }
- // @codeCoverageIgnoreEnd
- return $format(
- ...array_values($parameters),
- ...array_fill(0, max(0, $count - \count($parameters)), null)
- );
- }
- return parent::trans($id, $parameters, $domain, $locale);
- }
- /**
- * Reset messages of a locale (all locale if no locale passed).
- * Remove custom messages and reload initial messages from matching
- * file in Lang directory.
- *
- * @param string|null $locale
- *
- * @return bool
- */
- public function resetMessages($locale = null)
- {
- if ($locale === null) {
- $this->messages = [];
- return true;
- }
- foreach ($this->getDirectories() as $directory) {
- $data = @include sprintf('%s/%s.php', rtrim($directory, '\\/'), $locale);
- if ($data !== false) {
- $this->messages[$locale] = $data;
- $this->addResource('array', $this->messages[$locale], $locale);
- return true;
- }
- }
- return false;
- }
- /**
- * Returns the list of files matching a given locale prefix (or all if empty).
- *
- * @param string $prefix prefix required to filter result
- *
- * @return array
- */
- public function getLocalesFiles($prefix = '')
- {
- $files = [];
- foreach ($this->getDirectories() as $directory) {
- $directory = rtrim($directory, '\\/');
- foreach (glob("$directory/$prefix*.php") as $file) {
- $files[] = $file;
- }
- }
- return array_unique($files);
- }
- /**
- * Returns the list of internally available locales and already loaded custom locales.
- * (It will ignore custom translator dynamic loading.)
- *
- * @param string $prefix prefix required to filter result
- *
- * @return array
- */
- public function getAvailableLocales($prefix = '')
- {
- $locales = [];
- foreach ($this->getLocalesFiles($prefix) as $file) {
- $locales[] = substr($file, strrpos($file, '/') + 1, -4);
- }
- return array_unique(array_merge($locales, array_keys($this->messages)));
- }
- /**
- * Init messages language from matching file in Lang directory.
- *
- * @param string $locale
- *
- * @return bool
- */
- protected function loadMessagesFromFile($locale)
- {
- if (isset($this->messages[$locale])) {
- return true;
- }
- return $this->resetMessages($locale);
- }
- /**
- * Set messages of a locale and take file first if present.
- *
- * @param string $locale
- * @param array $messages
- *
- * @return $this
- */
- public function setMessages($locale, $messages)
- {
- $this->loadMessagesFromFile($locale);
- $this->addResource('array', $messages, $locale);
- $this->messages[$locale] = array_merge(
- isset($this->messages[$locale]) ? $this->messages[$locale] : [],
- $messages
- );
- return $this;
- }
- /**
- * Set messages of the current locale and take file first if present.
- *
- * @param array $messages
- *
- * @return $this
- */
- public function setTranslations($messages)
- {
- return $this->setMessages($this->getLocale(), $messages);
- }
- /**
- * Get messages of a locale, if none given, return all the
- * languages.
- *
- * @param string|null $locale
- *
- * @return array
- */
- public function getMessages($locale = null)
- {
- return $locale === null ? $this->messages : $this->messages[$locale];
- }
- /**
- * Set the current translator locale and indicate if the source locale file exists
- *
- * @param string $locale locale ex. en
- *
- * @return bool
- */
- public function setLocale($locale)
- {
- $locale = preg_replace_callback('/[-_]([a-z]{2,}|[0-9]{2,})/', function ($matches) {
- // _2-letters or YUE is a region, _3+-letters is a variant
- $upper = strtoupper($matches[1]);
- if ($upper === 'YUE' || $upper === 'ISO' || \strlen($upper) < 3) {
- return "_$upper";
- }
- return '_'.ucfirst($matches[1]);
- }, strtolower($locale));
- $previousLocale = $this->getLocale();
- if ($previousLocale === $locale && isset($this->messages[$locale])) {
- return true;
- }
- unset(static::$singletons[$previousLocale]);
- if ($locale === 'auto') {
- $completeLocale = setlocale(LC_TIME, '0');
- $locale = preg_replace('/^([^_.-]+).*$/', '$1', $completeLocale);
- $locales = $this->getAvailableLocales($locale);
- $completeLocaleChunks = preg_split('/[_.-]+/', $completeLocale);
- $getScore = function ($language) use ($completeLocaleChunks) {
- return static::compareChunkLists($completeLocaleChunks, preg_split('/[_.-]+/', $language));
- };
- usort($locales, function ($first, $second) use ($getScore) {
- return $getScore($second) <=> $getScore($first);
- });
- $locale = $locales[0];
- }
- if (isset($this->aliases[$locale])) {
- $locale = $this->aliases[$locale];
- }
- // If subtag (ex: en_CA) first load the macro (ex: en) to have a fallback
- if (str_contains($locale, '_') &&
- $this->loadMessagesFromFile($macroLocale = preg_replace('/^([^_]+).*$/', '$1', $locale))
- ) {
- parent::setLocale($macroLocale);
- }
- if ($this->loadMessagesFromFile($locale) || $this->initializing) {
- parent::setLocale($locale);
- return true;
- }
- return false;
- }
- /**
- * Show locale on var_dump().
- *
- * @return array
- */
- public function __debugInfo()
- {
- return [
- 'locale' => $this->getLocale(),
- ];
- }
- private static function compareChunkLists($referenceChunks, $chunks)
- {
- $score = 0;
- foreach ($referenceChunks as $index => $chunk) {
- if (!isset($chunks[$index])) {
- $score++;
- continue;
- }
- if (strtolower($chunks[$index]) === strtolower($chunk)) {
- $score += 10;
- }
- }
- return $score;
- }
- }
|