vendor/symfony/twig-bridge/Extension/FormExtension.php line 38

  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\Node\RenderBlockNode;
  15. use Symfony\Bridge\Twig\Node\SearchAndRenderBlockNode;
  16. use Symfony\Bridge\Twig\TokenParser\FormThemeTokenParser;
  17. use Symfony\Component\Form\ChoiceList\View\ChoiceGroupView;
  18. use Symfony\Component\Form\ChoiceList\View\ChoiceView;
  19. use Symfony\Component\Form\FormError;
  20. use Symfony\Component\Form\FormRenderer;
  21. use Symfony\Component\Form\FormView;
  22. use Symfony\Contracts\Translation\TranslatorInterface;
  23. use Twig\Extension\AbstractExtension;
  24. use Twig\TwigFilter;
  25. use Twig\TwigFunction;
  26. use Twig\TwigTest;
  28. /**
  29.  * FormExtension extends Twig with form capabilities.
  30.  *
  31.  * @author Fabien Potencier <fabien@symfony.com>
  32.  * @author Bernhard Schussek <bschussek@gmail.com>
  33.  */
  34. final class FormExtension extends AbstractExtension
  35. {
  36.     private ?TranslatorInterface $translator;
  38.     public function __construct(TranslatorInterface $translator = null)
  39.     {
  40.         $this->translator = $translator;
  41.     }
  43.     public function getTokenParsers(): array
  44.     {
  45.         return [
  46.             // {% form_theme form "SomeBundle::widgets.twig" %}
  47.             new FormThemeTokenParser(),
  48.         ];
  49.     }
  51.     public function getFunctions(): array
  52.     {
  53.         return [
  54.             new TwigFunction('form_widget', null, ['node_class' => SearchAndRenderBlockNode::class, 'is_safe' => ['html']]),
  55.             new TwigFunction('form_errors', null, ['node_class' => SearchAndRenderBlockNode::class, 'is_safe' => ['html']]),
  56.             new TwigFunction('form_label', null, ['node_class' => SearchAndRenderBlockNode::class, 'is_safe' => ['html']]),
  57.             new TwigFunction('form_help', null, ['node_class' => SearchAndRenderBlockNode::class, 'is_safe' => ['html']]),
  58.             new TwigFunction('form_row', null, ['node_class' => SearchAndRenderBlockNode::class, 'is_safe' => ['html']]),
  59.             new TwigFunction('form_rest', null, ['node_class' => SearchAndRenderBlockNode::class, 'is_safe' => ['html']]),
  60.             new TwigFunction('form', null, ['node_class' => RenderBlockNode::class, 'is_safe' => ['html']]),
  61.             new TwigFunction('form_start', null, ['node_class' => RenderBlockNode::class, 'is_safe' => ['html']]),
  62.             new TwigFunction('form_end', null, ['node_class' => RenderBlockNode::class, 'is_safe' => ['html']]),
  63.             new TwigFunction('csrf_token', [FormRenderer::class, 'renderCsrfToken']),
  64.             new TwigFunction('form_parent', 'Symfony\Bridge\Twig\Extension\twig_get_form_parent'),
  65.             new TwigFunction('field_name', $this->getFieldName(...)),
  66.             new TwigFunction('field_value', $this->getFieldValue(...)),
  67.             new TwigFunction('field_label', $this->getFieldLabel(...)),
  68.             new TwigFunction('field_help', $this->getFieldHelp(...)),
  69.             new TwigFunction('field_errors', $this->getFieldErrors(...)),
  70.             new TwigFunction('field_choices', $this->getFieldChoices(...)),
  71.         ];
  72.     }
  74.     public function getFilters(): array
  75.     {
  76.         return [
  77.             new TwigFilter('humanize', [FormRenderer::class, 'humanize']),
  78.             new TwigFilter('form_encode_currency', [FormRenderer::class, 'encodeCurrency'], ['is_safe' => ['html'], 'needs_environment' => true]),
  79.         ];
  80.     }
  82.     public function getTests(): array
  83.     {
  84.         return [
  85.             new TwigTest('selectedchoice', 'Symfony\Bridge\Twig\Extension\twig_is_selected_choice'),
  86.             new TwigTest('rootform', 'Symfony\Bridge\Twig\Extension\twig_is_root_form'),
  87.         ];
  88.     }
  90.     public function getFieldName(FormView $view): string
  91.     {
  92.         $view->setRendered();
  94.         return $view->vars['full_name'];
  95.     }
  97.     public function getFieldValue(FormView $view): string|array
  98.     {
  99.         return $view->vars['value'];
  100.     }
  102.     public function getFieldLabel(FormView $view): ?string
  103.     {
  104.         if (false === $label = $view->vars['label']) {
  105.             return null;
  106.         }
  108.         if (!$label && $labelFormat = $view->vars['label_format']) {
  109.             $label = str_replace(['%id%', '%name%'], [$view->vars['id'], $view->vars['name']], $labelFormat);
  110.         } elseif (!$label) {
  111.             $label = ucfirst(strtolower(trim(preg_replace(['/([A-Z])/', '/[_\s]+/'], ['_$1', ' '], $view->vars['name']))));
  112.         }
  114.         return $this->createFieldTranslation(
  115.             $label,
  116.             $view->vars['label_translation_parameters'] ?: [],
  117.             $view->vars['translation_domain']
  118.         );
  119.     }
  121.     public function getFieldHelp(FormView $view): ?string
  122.     {
  123.         return $this->createFieldTranslation(
  124.             $view->vars['help'],
  125.             $view->vars['help_translation_parameters'] ?: [],
  126.             $view->vars['translation_domain']
  127.         );
  128.     }
  130.     /**
  131.      * @return string[]
  132.      */
  133.     public function getFieldErrors(FormView $view): iterable
  134.     {
  135.         /** @var FormError $error */
  136.         foreach ($view->vars['errors'] as $error) {
  137.             yield $error->getMessage();
  138.         }
  139.     }
  141.     /**
  142.      * @return string[]|string[][]
  143.      */
  144.     public function getFieldChoices(FormView $view): iterable
  145.     {
  146.         yield from $this->createFieldChoicesList($view->vars['choices'], $view->vars['choice_translation_domain']);
  147.     }
  149.     private function createFieldChoicesList(iterable $choices, string|false|null $translationDomain): iterable
  150.     {
  151.         foreach ($choices as $choice) {
  152.             $translatableLabel = $this->createFieldTranslation($choice->label, [], $translationDomain);
  154.             if ($choice instanceof ChoiceGroupView) {
  155.                 yield $translatableLabel => $this->createFieldChoicesList($choice, $translationDomain);
  157.                 continue;
  158.             }
  160.             /* @var ChoiceView $choice */
  161.             yield $translatableLabel => $choice->value;
  162.         }
  163.     }
  165.     private function createFieldTranslation(?string $value, array $parameters, string|false|null $domain): ?string
  166.     {
  167.         if (!$this->translator || !$value || false === $domain) {
  168.             return $value;
  169.         }
  171.         return $this->translator->trans($value, $parameters, $domain);
  172.     }
  173. }
  175. /**
  176.  * Returns whether a choice is selected for a given form value.
  177.  *
  178.  * This is a function and not callable due to performance reasons.
  179.  *
  180.  * @see ChoiceView::isSelected()
  181.  */
  182. function twig_is_selected_choice(ChoiceView $choice, string|array|null $selectedValue): bool
  183. {
  184.     if (\is_array($selectedValue)) {
  185.         return \in_array($choice->value, $selectedValue, true);
  186.     }
  188.     return $choice->value === $selectedValue;
  189. }
  191. /**
  192.  * @internal
  193.  */
  194. function twig_is_root_form(FormView $formView): bool
  195. {
  196.     return null === $formView->parent;
  197. }
  199. /**
  200.  * @internal
  201.  */
  202. function twig_get_form_parent(FormView $formView): ?FormView
  203. {
  204.     return $formView->parent;
  205. }