vendor/symfony/twig-bridge/Extension/TranslationExtension.php line 133

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\Bridge\Twig\Extension;
  14. use Symfony\Bridge\Twig\NodeVisitor\TranslationDefaultDomainNodeVisitor;
  15. use Symfony\Bridge\Twig\NodeVisitor\TranslationNodeVisitor;
  16. use Symfony\Bridge\Twig\TokenParser\TransDefaultDomainTokenParser;
  17. use Symfony\Bridge\Twig\TokenParser\TransTokenParser;
  18. use Symfony\Component\Translation\TranslatableMessage;
  19. use Symfony\Contracts\Translation\TranslatableInterface;
  20. use Symfony\Contracts\Translation\TranslatorInterface;
  21. use Symfony\Contracts\Translation\TranslatorTrait;
  22. use Twig\Extension\AbstractExtension;
  23. use Twig\TwigFilter;
  24. use Twig\TwigFunction;
  26. // Help opcache.preload discover always-needed symbols
  27. class_exists(TranslatorInterface::class);
  28. class_exists(TranslatorTrait::class);
  30. /**
  31.  * Provides integration of the Translation component with Twig.
  32.  *
  33.  * @author Fabien Potencier <fabien@symfony.com>
  34.  */
  35. final class TranslationExtension extends AbstractExtension
  36. {
  37.     private $translator;
  38.     private $translationNodeVisitor;
  40.     public function __construct(TranslatorInterface $translator = null, TranslationNodeVisitor $translationNodeVisitor = null)
  41.     {
  42.         $this->translator = $translator;
  43.         $this->translationNodeVisitor = $translationNodeVisitor;
  44.     }
  46.     public function getTranslator(): TranslatorInterface
  47.     {
  48.         if (null === $this->translator) {
  49.             if (!interface_exists(TranslatorInterface::class)) {
  50.                 throw new \LogicException(sprintf('You cannot use the "%s" if the Translation Contracts are not available. Try running "composer require symfony/translation".', __CLASS__));
  51.             }
  53.             $this->translator = new class() implements TranslatorInterface {
  54.                 use TranslatorTrait;
  55.             };
  56.         }
  58.         return $this->translator;
  59.     }
  61.     /**
  62.      * {@inheritdoc}
  63.      */
  64.     public function getFunctions(): array
  65.     {
  66.         return [
  67.             new TwigFunction('t', [$this, 'createTranslatable']),
  68.         ];
  69.     }
  71.     /**
  72.      * {@inheritdoc}
  73.      */
  74.     public function getFilters(): array
  75.     {
  76.         return [
  77.             new TwigFilter('trans', [$this, 'trans']),
  78.         ];
  79.     }
  81.     /**
  82.      * {@inheritdoc}
  83.      */
  84.     public function getTokenParsers(): array
  85.     {
  86.         return [
  87.             // {% trans %}Symfony is great!{% endtrans %}
  88.             new TransTokenParser(),
  90.             // {% trans_default_domain "foobar" %}
  91.             new TransDefaultDomainTokenParser(),
  92.         ];
  93.     }
  95.     /**
  96.      * {@inheritdoc}
  97.      */
  98.     public function getNodeVisitors(): array
  99.     {
  100.         return [$this->getTranslationNodeVisitor(), new TranslationDefaultDomainNodeVisitor()];
  101.     }
  103.     public function getTranslationNodeVisitor(): TranslationNodeVisitor
  104.     {
  105.         return $this->translationNodeVisitor ?: $this->translationNodeVisitor = new TranslationNodeVisitor();
  106.     }
  108.     /**
  109.      * @param array|string $arguments Can be the locale as a string when $message is a TranslatableInterface
  110.      */
  111.     public function trans(string|\Stringable|TranslatableInterface|null $message, array|string $arguments = [], string $domain = null, string $locale = null, int $count = null): string
  112.     {
  113.         if ($message instanceof TranslatableInterface) {
  114.             if ([] !== $arguments && !\is_string($arguments)) {
  115.                 throw new \TypeError(sprintf('Argument 2 passed to "%s()" must be a locale passed as a string when the message is a "%s", "%s" given.', __METHOD__, TranslatableInterface::class, get_debug_type($arguments)));
  116.             }
  118.             return $message->trans($this->getTranslator(), $locale ?? (\is_string($arguments) ? $arguments : null));
  119.         }
  121.         if (!\is_array($arguments)) {
  122.             throw new \TypeError(sprintf('Unless the message is a "%s", argument 2 passed to "%s()" must be an array of parameters, "%s" given.', TranslatableInterface::class, __METHOD__, get_debug_type($arguments)));
  123.         }
  125.         if ('' === $message = (string) $message) {
  126.             return '';
  127.         }
  129.         if (null !== $count) {
  130.             $arguments['%count%'] = $count;
  131.         }
  133.         return $this->getTranslator()->trans($message, $arguments, $domain, $locale);
  134.     }
  136.     public function createTranslatable(string $message, array $parameters = [], string $domain = null): TranslatableMessage
  137.     {
  138.         if (!class_exists(TranslatableMessage::class)) {
  139.             throw new \LogicException(sprintf('You cannot use the "%s" as the Translation Component is not installed. Try running "composer require symfony/translation".', __CLASS__));
  140.         }
  142.         return new TranslatableMessage($message, $parameters, $domain);
  143.     }
  144. }