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

  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 ?TranslatorInterface $translator;
  38.     private ?TranslationNodeVisitor $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.     public function getFunctions(): array
  62.     {
  63.         return [
  64.             new TwigFunction('t', $this->createTranslatable(...)),
  65.         ];
  66.     }
  68.     public function getFilters(): array
  69.     {
  70.         return [
  71.             new TwigFilter('trans', $this->trans(...)),
  72.         ];
  73.     }
  75.     public function getTokenParsers(): array
  76.     {
  77.         return [
  78.             // {% trans %}Symfony is great!{% endtrans %}
  79.             new TransTokenParser(),
  81.             // {% trans_default_domain "foobar" %}
  82.             new TransDefaultDomainTokenParser(),
  83.         ];
  84.     }
  86.     public function getNodeVisitors(): array
  87.     {
  88.         return [$this->getTranslationNodeVisitor(), new TranslationDefaultDomainNodeVisitor()];
  89.     }
  91.     public function getTranslationNodeVisitor(): TranslationNodeVisitor
  92.     {
  93.         return $this->translationNodeVisitor ?: $this->translationNodeVisitor = new TranslationNodeVisitor();
  94.     }
  96.     /**
  97.      * @param array|string $arguments Can be the locale as a string when $message is a TranslatableInterface
  98.      */
  99.     public function trans(string|\Stringable|TranslatableInterface|null $message, array|string $arguments = [], string $domain = null, string $locale = null, int $count = null): string
  100.     {
  101.         if ($message instanceof TranslatableInterface) {
  102.             if ([] !== $arguments && !\is_string($arguments)) {
  103.                 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)));
  104.             }
  106.             if ($message instanceof TranslatableMessage && '' === $message->getMessage()) {
  107.                 return '';
  108.             }
  110.             return $message->trans($this->getTranslator(), $locale ?? (\is_string($arguments) ? $arguments : null));
  111.         }
  113.         if (!\is_array($arguments)) {
  114.             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)));
  115.         }
  117.         if ('' === $message = (string) $message) {
  118.             return '';
  119.         }
  121.         if (null !== $count) {
  122.             $arguments['%count%'] = $count;
  123.         }
  125.         return $this->getTranslator()->trans($message, $arguments, $domain, $locale);
  126.     }
  128.     public function createTranslatable(string $message, array $parameters = [], string $domain = null): TranslatableMessage
  129.     {
  130.         if (!class_exists(TranslatableMessage::class)) {
  131.             throw new \LogicException(sprintf('You cannot use the "%s" as the Translation Component is not installed. Try running "composer require symfony/translation".', __CLASS__));
  132.         }
  134.         return new TranslatableMessage($message, $parameters, $domain);
  135.     }
  136. }