Matthias Andreas Benkard | 7b2a3a1 | 2021-08-16 10:57:25 +0200 | [diff] [blame] | 1 | <?php |
| 2 | |
| 3 | /* |
| 4 | * This file is part of the Symfony package. |
| 5 | * |
| 6 | * (c) Fabien Potencier <fabien@symfony.com> |
| 7 | * |
| 8 | * For the full copyright and license information, please view the LICENSE |
| 9 | * file that was distributed with this source code. |
| 10 | */ |
| 11 | |
| 12 | namespace Symfony\Component\Translation; |
| 13 | |
| 14 | use Psr\Log\LoggerInterface; |
| 15 | use Symfony\Component\Translation\Exception\InvalidArgumentException; |
| 16 | use Symfony\Contracts\Translation\LocaleAwareInterface; |
| 17 | use Symfony\Contracts\Translation\TranslatorInterface; |
| 18 | |
| 19 | /** |
| 20 | * @author Abdellatif Ait boudad <a.aitboudad@gmail.com> |
| 21 | */ |
| 22 | class LoggingTranslator implements TranslatorInterface, TranslatorBagInterface, LocaleAwareInterface |
| 23 | { |
Matthias Andreas Benkard | 7b2a3a1 | 2021-08-16 10:57:25 +0200 | [diff] [blame] | 24 | private $translator; |
Matthias Andreas Benkard | 7b2a3a1 | 2021-08-16 10:57:25 +0200 | [diff] [blame] | 25 | private $logger; |
| 26 | |
| 27 | /** |
Matthias Andreas Benkard | 1ba5381 | 2022-12-27 17:32:58 +0100 | [diff] [blame^] | 28 | * @param TranslatorInterface&TranslatorBagInterface&LocaleAwareInterface $translator The translator must implement TranslatorBagInterface |
Matthias Andreas Benkard | 7b2a3a1 | 2021-08-16 10:57:25 +0200 | [diff] [blame] | 29 | */ |
| 30 | public function __construct(TranslatorInterface $translator, LoggerInterface $logger) |
| 31 | { |
| 32 | if (!$translator instanceof TranslatorBagInterface || !$translator instanceof LocaleAwareInterface) { |
| 33 | throw new InvalidArgumentException(sprintf('The Translator "%s" must implement TranslatorInterface, TranslatorBagInterface and LocaleAwareInterface.', get_debug_type($translator))); |
| 34 | } |
| 35 | |
| 36 | $this->translator = $translator; |
| 37 | $this->logger = $logger; |
| 38 | } |
| 39 | |
| 40 | /** |
| 41 | * {@inheritdoc} |
| 42 | */ |
Matthias Andreas Benkard | 1ba5381 | 2022-12-27 17:32:58 +0100 | [diff] [blame^] | 43 | public function trans(?string $id, array $parameters = [], string $domain = null, string $locale = null): string |
Matthias Andreas Benkard | 7b2a3a1 | 2021-08-16 10:57:25 +0200 | [diff] [blame] | 44 | { |
| 45 | $trans = $this->translator->trans($id = (string) $id, $parameters, $domain, $locale); |
| 46 | $this->log($id, $domain, $locale); |
| 47 | |
| 48 | return $trans; |
| 49 | } |
| 50 | |
| 51 | /** |
| 52 | * {@inheritdoc} |
| 53 | */ |
| 54 | public function setLocale(string $locale) |
| 55 | { |
| 56 | $prev = $this->translator->getLocale(); |
| 57 | $this->translator->setLocale($locale); |
| 58 | if ($prev === $locale) { |
| 59 | return; |
| 60 | } |
| 61 | |
| 62 | $this->logger->debug(sprintf('The locale of the translator has changed from "%s" to "%s".', $prev, $locale)); |
| 63 | } |
| 64 | |
| 65 | /** |
| 66 | * {@inheritdoc} |
| 67 | */ |
Matthias Andreas Benkard | 1ba5381 | 2022-12-27 17:32:58 +0100 | [diff] [blame^] | 68 | public function getLocale(): string |
Matthias Andreas Benkard | 7b2a3a1 | 2021-08-16 10:57:25 +0200 | [diff] [blame] | 69 | { |
| 70 | return $this->translator->getLocale(); |
| 71 | } |
| 72 | |
| 73 | /** |
| 74 | * {@inheritdoc} |
| 75 | */ |
Matthias Andreas Benkard | 1ba5381 | 2022-12-27 17:32:58 +0100 | [diff] [blame^] | 76 | public function getCatalogue(string $locale = null): MessageCatalogueInterface |
Matthias Andreas Benkard | 7b2a3a1 | 2021-08-16 10:57:25 +0200 | [diff] [blame] | 77 | { |
| 78 | return $this->translator->getCatalogue($locale); |
| 79 | } |
| 80 | |
| 81 | /** |
| 82 | * {@inheritdoc} |
| 83 | */ |
| 84 | public function getCatalogues(): array |
| 85 | { |
| 86 | return $this->translator->getCatalogues(); |
| 87 | } |
| 88 | |
| 89 | /** |
| 90 | * Gets the fallback locales. |
Matthias Andreas Benkard | 7b2a3a1 | 2021-08-16 10:57:25 +0200 | [diff] [blame] | 91 | */ |
Matthias Andreas Benkard | 1ba5381 | 2022-12-27 17:32:58 +0100 | [diff] [blame^] | 92 | public function getFallbackLocales(): array |
Matthias Andreas Benkard | 7b2a3a1 | 2021-08-16 10:57:25 +0200 | [diff] [blame] | 93 | { |
| 94 | if ($this->translator instanceof Translator || method_exists($this->translator, 'getFallbackLocales')) { |
| 95 | return $this->translator->getFallbackLocales(); |
| 96 | } |
| 97 | |
| 98 | return []; |
| 99 | } |
| 100 | |
| 101 | /** |
| 102 | * Passes through all unknown calls onto the translator object. |
| 103 | */ |
| 104 | public function __call(string $method, array $args) |
| 105 | { |
| 106 | return $this->translator->{$method}(...$args); |
| 107 | } |
| 108 | |
| 109 | /** |
| 110 | * Logs for missing translations. |
| 111 | */ |
| 112 | private function log(string $id, ?string $domain, ?string $locale) |
| 113 | { |
| 114 | if (null === $domain) { |
| 115 | $domain = 'messages'; |
| 116 | } |
| 117 | |
| 118 | $catalogue = $this->translator->getCatalogue($locale); |
| 119 | if ($catalogue->defines($id, $domain)) { |
| 120 | return; |
| 121 | } |
| 122 | |
| 123 | if ($catalogue->has($id, $domain)) { |
| 124 | $this->logger->debug('Translation use fallback catalogue.', ['id' => $id, 'domain' => $domain, 'locale' => $catalogue->getLocale()]); |
| 125 | } else { |
| 126 | $this->logger->warning('Translation not found.', ['id' => $id, 'domain' => $domain, 'locale' => $catalogue->getLocale()]); |
| 127 | } |
| 128 | } |
| 129 | } |