vendor/symfony/translation/LoggingTranslator.php line 76

Open in your IDE?
  1. <?php
  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.  */
  12. namespace Symfony\Component\Translation;
  14. use Psr\Log\LoggerInterface;
  15. use Symfony\Component\Translation\Exception\InvalidArgumentException;
  16. use Symfony\Contracts\Translation\LocaleAwareInterface;
  17. use Symfony\Contracts\Translation\TranslatorInterface;
  19. /**
  20.  * @author Abdellatif Ait boudad <a.aitboudad@gmail.com>
  21.  */
  22. class LoggingTranslator implements TranslatorInterface, TranslatorBagInterface, LocaleAwareInterface
  23. {
  24.     private $translator;
  25.     private $logger;
  27.     /**
  28.      * @param TranslatorInterface&TranslatorBagInterface&LocaleAwareInterface $translator The translator must implement TranslatorBagInterface
  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.         }
  36.         $this->translator = $translator;
  37.         $this->logger = $logger;
  38.     }
  40.     /**
  41.      * {@inheritdoc}
  42.      */
  43.     public function trans(?string $id, array $parameters = [], string $domain = null, string $locale = null)
  44.     {
  45.         $trans = $this->translator->trans($id = (string) $id, $parameters, $domain, $locale);
  46.         $this->log($id, $domain, $locale);
  48.         return $trans;
  49.     }
  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.         }
  62.         $this->logger->debug(sprintf('The locale of the translator has changed from "%s" to "%s".', $prev, $locale));
  63.     }
  65.     /**
  66.      * {@inheritdoc}
  67.      */
  68.     public function getLocale()
  69.     {
  70.         return $this->translator->getLocale();
  71.     }
  73.     /**
  74.      * {@inheritdoc}
  75.      */
  76.     public function getCatalogue(string $locale = null)
  77.     {
  78.         return $this->translator->getCatalogue($locale);
  79.     }
  81.     /**
  82.      * {@inheritdoc}
  83.      */
  84.     public function getCatalogues(): array
  85.     {
  86.         return $this->translator->getCatalogues();
  87.     }
  89.     /**
  90.      * Gets the fallback locales.
  91.      *
  92.      * @return array
  93.      */
  94.     public function getFallbackLocales()
  95.     {
  96.         if ($this->translator instanceof Translator || method_exists($this->translator, 'getFallbackLocales')) {
  97.             return $this->translator->getFallbackLocales();
  98.         }
  100.         return [];
  101.     }
  103.     /**
  104.      * Passes through all unknown calls onto the translator object.
  105.      */
  106.     public function __call(string $method, array $args)
  107.     {
  108.         return $this->translator->{$method}(...$args);
  109.     }
  111.     /**
  112.      * Logs for missing translations.
  113.      */
  114.     private function log(string $id, ?string $domain, ?string $locale)
  115.     {
  116.         if (null === $domain) {
  117.             $domain = 'messages';
  118.         }
  120.         $catalogue = $this->translator->getCatalogue($locale);
  121.         if ($catalogue->defines($id, $domain)) {
  122.             return;
  123.         }
  125.         if ($catalogue->has($id, $domain)) {
  126.             $this->logger->debug('Translation use fallback catalogue.', ['id' => $id, 'domain' => $domain, 'locale' => $catalogue->getLocale()]);
  127.         } else {
  128.             $this->logger->warning('Translation not found.', ['id' => $id, 'domain' => $domain, 'locale' => $catalogue->getLocale()]);
  129.         }
  130.     }
  131. }