vendor/symfony/symfony/src/Symfony/Bundle/FrameworkBundle/Templating/Helper/FormHelper.php line 14

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\Bundle\FrameworkBundle\Templating\Helper;
  14. @trigger_error('The '.FormHelper::class.' class is deprecated since version 4.3 and will be removed in 5.0; use Twig instead.', E_USER_DEPRECATED);
  16. use Symfony\Component\Form\FormRendererInterface;
  17. use Symfony\Component\Form\FormView;
  18. use Symfony\Component\Templating\Helper\Helper;
  20. /**
  21.  * FormHelper provides helpers to help display forms.
  22.  *
  23.  * @author Fabien Potencier <fabien@symfony.com>
  24.  * @author Bernhard Schussek <bschussek@gmail.com>
  25.  *
  26.  * @deprecated since version 4.3, to be removed in 5.0; use Twig instead.
  27.  */
  28. class FormHelper extends Helper
  29. {
  30.     private $renderer;
  32.     public function __construct(FormRendererInterface $renderer)
  33.     {
  34.         $this->renderer = $renderer;
  35.     }
  37.     /**
  38.      * {@inheritdoc}
  39.      */
  40.     public function getName()
  41.     {
  42.         return 'form';
  43.     }
  45.     /**
  46.      * Sets a theme for a given view.
  47.      *
  48.      * The theme format is "<Bundle>:<Controller>".
  49.      *
  50.      * @param string|array $themes           A theme or an array of theme
  51.      * @param bool         $useDefaultThemes If true, will use default themes defined in the renderer
  52.      */
  53.     public function setTheme(FormView $view, $themes, $useDefaultThemes = true)
  54.     {
  55.         $this->renderer->setTheme($view, $themes, $useDefaultThemes);
  56.     }
  58.     /**
  59.      * Renders the HTML for a form.
  60.      *
  61.      * Example usage:
  62.      *
  63.      *     <?php echo view['form']->form($form) ?>
  64.      *
  65.      * You can pass options during the call:
  66.      *
  67.      *     <?php echo view['form']->form($form, ['attr' => ['class' => 'foo']]) ?>
  68.      *
  69.      *     <?php echo view['form']->form($form, ['separator' => '+++++']) ?>
  70.      *
  71.      * This method is mainly intended for prototyping purposes. If you want to
  72.      * control the layout of a form in a more fine-grained manner, you are
  73.      * advised to use the other helper methods for rendering the parts of the
  74.      * form individually. You can also create a custom form theme to adapt
  75.      * the look of the form.
  76.      *
  77.      * @param array $variables Additional variables passed to the template
  78.      *
  79.      * @return string The HTML markup
  80.      */
  81.     public function form(FormView $view, array $variables = [])
  82.     {
  83.         return $this->renderer->renderBlock($view, 'form', $variables);
  84.     }
  86.     /**
  87.      * Renders the form start tag.
  88.      *
  89.      * Example usage templates:
  90.      *
  91.      *     <?php echo $view['form']->start($form) ?>>
  92.      *
  93.      * @param array $variables Additional variables passed to the template
  94.      *
  95.      * @return string The HTML markup
  96.      */
  97.     public function start(FormView $view, array $variables = [])
  98.     {
  99.         return $this->renderer->renderBlock($view, 'form_start', $variables);
  100.     }
  102.     /**
  103.      * Renders the form end tag.
  104.      *
  105.      * Example usage templates:
  106.      *
  107.      *     <?php echo $view['form']->end($form) ?>>
  108.      *
  109.      * @param array $variables Additional variables passed to the template
  110.      *
  111.      * @return string The HTML markup
  112.      */
  113.     public function end(FormView $view, array $variables = [])
  114.     {
  115.         return $this->renderer->renderBlock($view, 'form_end', $variables);
  116.     }
  118.     /**
  119.      * Renders the HTML for a given view.
  120.      *
  121.      * Example usage:
  122.      *
  123.      *     <?php echo $view['form']->widget($form) ?>
  124.      *
  125.      * You can pass options during the call:
  126.      *
  127.      *     <?php echo $view['form']->widget($form, ['attr' => ['class' => 'foo']]) ?>
  128.      *
  129.      *     <?php echo $view['form']->widget($form, ['separator' => '+++++']) ?>
  130.      *
  131.      * @param array $variables Additional variables passed to the template
  132.      *
  133.      * @return string The HTML markup
  134.      */
  135.     public function widget(FormView $view, array $variables = [])
  136.     {
  137.         return $this->renderer->searchAndRenderBlock($view, 'widget', $variables);
  138.     }
  140.     /**
  141.      * Renders the entire form field "row".
  142.      *
  143.      * @param array $variables Additional variables passed to the template
  144.      *
  145.      * @return string The HTML markup
  146.      */
  147.     public function row(FormView $view, array $variables = [])
  148.     {
  149.         return $this->renderer->searchAndRenderBlock($view, 'row', $variables);
  150.     }
  152.     /**
  153.      * Renders the label of the given view.
  154.      *
  155.      * @param string $label     The label
  156.      * @param array  $variables Additional variables passed to the template
  157.      *
  158.      * @return string The HTML markup
  159.      */
  160.     public function label(FormView $view, $label = null, array $variables = [])
  161.     {
  162.         if (null !== $label) {
  163.             $variables += ['label' => $label];
  164.         }
  166.         return $this->renderer->searchAndRenderBlock($view, 'label', $variables);
  167.     }
  169.     /**
  170.      * Renders the help of the given view.
  171.      *
  172.      * @return string The HTML markup
  173.      */
  174.     public function help(FormView $view): string
  175.     {
  176.         return $this->renderer->searchAndRenderBlock($view, 'help');
  177.     }
  179.     /**
  180.      * Renders the errors of the given view.
  181.      *
  182.      * @return string The HTML markup
  183.      */
  184.     public function errors(FormView $view)
  185.     {
  186.         return $this->renderer->searchAndRenderBlock($view, 'errors');
  187.     }
  189.     /**
  190.      * Renders views which have not already been rendered.
  191.      *
  192.      * @param array $variables An array of variables
  193.      *
  194.      * @return string The HTML markup
  195.      */
  196.     public function rest(FormView $view, array $variables = [])
  197.     {
  198.         return $this->renderer->searchAndRenderBlock($view, 'rest', $variables);
  199.     }
  201.     /**
  202.      * Renders a block of the template.
  203.      *
  204.      * @param string $blockName The name of the block to render
  205.      * @param array  $variables The variable to pass to the template
  206.      *
  207.      * @return string The HTML markup
  208.      */
  209.     public function block(FormView $view, $blockName, array $variables = [])
  210.     {
  211.         return $this->renderer->renderBlock($view, $blockName, $variables);
  212.     }
  214.     /**
  215.      * Returns a CSRF token.
  216.      *
  217.      * Use this helper for CSRF protection without the overhead of creating a
  218.      * form.
  219.      *
  220.      *     echo $view['form']->csrfToken('rm_user_'.$user->getId());
  221.      *
  222.      * Check the token in your action using the same CSRF token id.
  223.      *
  224.      *     // $csrfProvider being an instance of Symfony\Component\Security\Csrf\TokenGenerator\TokenGeneratorInterface
  225.      *     if (!$csrfProvider->isCsrfTokenValid('rm_user_'.$user->getId(), $token)) {
  226.      *         throw new \RuntimeException('CSRF attack detected.');
  227.      *     }
  228.      *
  229.      * @param string $tokenId The CSRF token id of the protected action
  230.      *
  231.      * @return string A CSRF token
  232.      *
  233.      * @throws \BadMethodCallException when no CSRF provider was injected in the constructor
  234.      */
  235.     public function csrfToken($tokenId)
  236.     {
  237.         return $this->renderer->renderCsrfToken($tokenId);
  238.     }
  240.     public function humanize($text)
  241.     {
  242.         return $this->renderer->humanize($text);
  243.     }
  245.     /**
  246.      * @internal
  247.      */
  248.     public function formEncodeCurrency($text, $widget = '')
  249.     {
  250.         if ('UTF-8' === $charset = $this->getCharset()) {
  251.             $text = htmlspecialchars($text, ENT_QUOTES | (\defined('ENT_SUBSTITUTE') ? ENT_SUBSTITUTE : 0), 'UTF-8');
  252.         } else {
  253.             $text = htmlentities($text, ENT_QUOTES | (\defined('ENT_SUBSTITUTE') ? ENT_SUBSTITUTE : 0), 'UTF-8');
  254.             $text = iconv('UTF-8', $charset, $text);
  255.             $widget = iconv('UTF-8', $charset, $widget);
  256.         }
  258.         return str_replace('{{ widget }}', $widget, $text);
  259.     }
  260. }