vendor/symfony/translation/DataCollectorTranslator.php line 22

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 Symfony\Component\HttpKernel\CacheWarmer\WarmableInterface;
  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 DataCollectorTranslator implements TranslatorInterface, TranslatorBagInterface, LocaleAwareInterface, WarmableInterface
  23. {
  24.     public const MESSAGE_DEFINED = 0;
  25.     public const MESSAGE_MISSING = 1;
  26.     public const MESSAGE_EQUALS_FALLBACK = 2;
  28.     private $translator;
  29.     private $messages = [];
  31.     /**
  32.      * @param TranslatorInterface&TranslatorBagInterface&LocaleAwareInterface $translator
  33.      */
  34.     public function __construct(TranslatorInterface $translator)
  35.     {
  36.         if (!$translator instanceof TranslatorBagInterface || !$translator instanceof LocaleAwareInterface) {
  37.             throw new InvalidArgumentException(sprintf('The Translator "%s" must implement TranslatorInterface, TranslatorBagInterface and LocaleAwareInterface.', get_debug_type($translator)));
  38.         }
  40.         $this->translator = $translator;
  41.     }
  43.     /**
  44.      * {@inheritdoc}
  45.      */
  46.     public function trans(?string $id, array $parameters = [], ?string $domain = null, ?string $locale = null)
  47.     {
  48.         $trans = $this->translator->trans($id = (string) $id, $parameters, $domain, $locale);
  49.         $this->collectMessage($locale, $domain, $id, $trans, $parameters);
  51.         return $trans;
  52.     }
  54.     /**
  55.      * {@inheritdoc}
  56.      */
  57.     public function setLocale(string $locale)
  58.     {
  59.         $this->translator->setLocale($locale);
  60.     }
  62.     /**
  63.      * {@inheritdoc}
  64.      */
  65.     public function getLocale()
  66.     {
  67.         return $this->translator->getLocale();
  68.     }
  70.     /**
  71.      * {@inheritdoc}
  72.      */
  73.     public function getCatalogue(?string $locale = null)
  74.     {
  75.         return $this->translator->getCatalogue($locale);
  76.     }
  78.     /**
  79.      * {@inheritdoc}
  80.      */
  81.     public function getCatalogues(): array
  82.     {
  83.         return $this->translator->getCatalogues();
  84.     }
  86.     /**
  87.      * {@inheritdoc}
  88.      *
  89.      * @return string[]
  90.      */
  91.     public function warmUp(string $cacheDir)
  92.     {
  93.         if ($this->translator instanceof WarmableInterface) {
  94.             return (array) $this->translator->warmUp($cacheDir);
  95.         }
  97.         return [];
  98.     }
  100.     /**
  101.      * Gets the fallback locales.
  102.      *
  103.      * @return array
  104.      */
  105.     public function getFallbackLocales()
  106.     {
  107.         if ($this->translator instanceof Translator || method_exists($this->translator, 'getFallbackLocales')) {
  108.             return $this->translator->getFallbackLocales();
  109.         }
  111.         return [];
  112.     }
  114.     /**
  115.      * Passes through all unknown calls onto the translator object.
  116.      */
  117.     public function __call(string $method, array $args)
  118.     {
  119.         return $this->translator->{$method}(...$args);
  120.     }
  122.     /**
  123.      * @return array
  124.      */
  125.     public function getCollectedMessages()
  126.     {
  127.         return $this->messages;
  128.     }
  130.     private function collectMessage(?string $locale, ?string $domain, string $id, string $translation, ?array $parameters = [])
  131.     {
  132.         if (null === $domain) {
  133.             $domain = 'messages';
  134.         }
  136.         $catalogue = $this->translator->getCatalogue($locale);
  137.         $locale = $catalogue->getLocale();
  138.         $fallbackLocale = null;
  139.         if ($catalogue->defines($id, $domain)) {
  140.             $state = self::MESSAGE_DEFINED;
  141.         } elseif ($catalogue->has($id, $domain)) {
  142.             $state = self::MESSAGE_EQUALS_FALLBACK;
  144.             $fallbackCatalogue = $catalogue->getFallbackCatalogue();
  145.             while ($fallbackCatalogue) {
  146.                 if ($fallbackCatalogue->defines($id, $domain)) {
  147.                     $fallbackLocale = $fallbackCatalogue->getLocale();
  148.                     break;
  149.                 }
  150.                 $fallbackCatalogue = $fallbackCatalogue->getFallbackCatalogue();
  151.             }
  152.         } else {
  153.             $state = self::MESSAGE_MISSING;
  154.         }
  156.         $this->messages[] = [
  157.             'locale' => $locale,
  158.             'fallbackLocale' => $fallbackLocale,
  159.             'domain' => $domain,
  160.             'id' => $id,
  161.             'translation' => $translation,
  162.             'parameters' => $parameters,
  163.             'state' => $state,
  164.             'transChoiceNumber' => isset($parameters['%count%']) && is_numeric($parameters['%count%']) ? $parameters['%count%'] : null,
  165.         ];
  166.     }
  167. }