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 FormView     $view             A FormView instance
  51.      * @param string|array $themes           A theme or an array of theme
  52.      * @param bool         $useDefaultThemes If true, will use default themes defined in the renderer
  53.      */
  54.     public function setTheme(FormView $view, $themes, $useDefaultThemes = true)
  55.     {
  56.         $this->renderer->setTheme($view, $themes, $useDefaultThemes);
  57.     }
  59.     /**
  60.      * Renders the HTML for a form.
  61.      *
  62.      * Example usage:
  63.      *
  64.      *     <?php echo view['form']->form($form) ?>
  65.      *
  66.      * You can pass options during the call:
  67.      *
  68.      *     <?php echo view['form']->form($form, ['attr' => ['class' => 'foo']]) ?>
  69.      *
  70.      *     <?php echo view['form']->form($form, ['separator' => '+++++']) ?>
  71.      *
  72.      * This method is mainly intended for prototyping purposes. If you want to
  73.      * control the layout of a form in a more fine-grained manner, you are
  74.      * advised to use the other helper methods for rendering the parts of the
  75.      * form individually. You can also create a custom form theme to adapt
  76.      * the look of the form.
  77.      *
  78.      * @param FormView $view      The view for which to render the form
  79.      * @param array    $variables Additional variables passed to the template
  80.      *
  81.      * @return string The HTML markup
  82.      */
  83.     public function form(FormView $view, array $variables = [])
  84.     {
  85.         return $this->renderer->renderBlock($view, 'form', $variables);
  86.     }
  88.     /**
  89.      * Renders the form start tag.
  90.      *
  91.      * Example usage templates:
  92.      *
  93.      *     <?php echo $view['form']->start($form) ?>>
  94.      *
  95.      * @param FormView $view      The view for which to render the start tag
  96.      * @param array    $variables Additional variables passed to the template
  97.      *
  98.      * @return string The HTML markup
  99.      */
  100.     public function start(FormView $view, array $variables = [])
  101.     {
  102.         return $this->renderer->renderBlock($view, 'form_start', $variables);
  103.     }
  105.     /**
  106.      * Renders the form end tag.
  107.      *
  108.      * Example usage templates:
  109.      *
  110.      *     <?php echo $view['form']->end($form) ?>>
  111.      *
  112.      * @param FormView $view      The view for which to render the end tag
  113.      * @param array    $variables Additional variables passed to the template
  114.      *
  115.      * @return string The HTML markup
  116.      */
  117.     public function end(FormView $view, array $variables = [])
  118.     {
  119.         return $this->renderer->renderBlock($view, 'form_end', $variables);
  120.     }
  122.     /**
  123.      * Renders the HTML for a given view.
  124.      *
  125.      * Example usage:
  126.      *
  127.      *     <?php echo $view['form']->widget($form) ?>
  128.      *
  129.      * You can pass options during the call:
  130.      *
  131.      *     <?php echo $view['form']->widget($form, ['attr' => ['class' => 'foo']]) ?>
  132.      *
  133.      *     <?php echo $view['form']->widget($form, ['separator' => '+++++']) ?>
  134.      *
  135.      * @param FormView $view      The view for which to render the widget
  136.      * @param array    $variables Additional variables passed to the template
  137.      *
  138.      * @return string The HTML markup
  139.      */
  140.     public function widget(FormView $view, array $variables = [])
  141.     {
  142.         return $this->renderer->searchAndRenderBlock($view, 'widget', $variables);
  143.     }
  145.     /**
  146.      * Renders the entire form field "row".
  147.      *
  148.      * @param FormView $view      The view for which to render the row
  149.      * @param array    $variables Additional variables passed to the template
  150.      *
  151.      * @return string The HTML markup
  152.      */
  153.     public function row(FormView $view, array $variables = [])
  154.     {
  155.         return $this->renderer->searchAndRenderBlock($view, 'row', $variables);
  156.     }
  158.     /**
  159.      * Renders the label of the given view.
  160.      *
  161.      * @param FormView $view      The view for which to render the label
  162.      * @param string   $label     The label
  163.      * @param array    $variables Additional variables passed to the template
  164.      *
  165.      * @return string The HTML markup
  166.      */
  167.     public function label(FormView $view, $label = null, array $variables = [])
  168.     {
  169.         if (null !== $label) {
  170.             $variables += ['label' => $label];
  171.         }
  173.         return $this->renderer->searchAndRenderBlock($view, 'label', $variables);
  174.     }
  176.     /**
  177.      * Renders the help of the given view.
  178.      *
  179.      * @param FormView $view The parent view
  180.      *
  181.      * @return string The HTML markup
  182.      */
  183.     public function help(FormView $view): string
  184.     {
  185.         return $this->renderer->searchAndRenderBlock($view, 'help');
  186.     }
  188.     /**
  189.      * Renders the errors of the given view.
  190.      *
  191.      * @return string The HTML markup
  192.      */
  193.     public function errors(FormView $view)
  194.     {
  195.         return $this->renderer->searchAndRenderBlock($view, 'errors');
  196.     }
  198.     /**
  199.      * Renders views which have not already been rendered.
  200.      *
  201.      * @param FormView $view      The parent view
  202.      * @param array    $variables An array of variables
  203.      *
  204.      * @return string The HTML markup
  205.      */
  206.     public function rest(FormView $view, array $variables = [])
  207.     {
  208.         return $this->renderer->searchAndRenderBlock($view, 'rest', $variables);
  209.     }
  211.     /**
  212.      * Renders a block of the template.
  213.      *
  214.      * @param FormView $view      The view for determining the used themes
  215.      * @param string   $blockName The name of the block to render
  216.      * @param array    $variables The variable to pass to the template
  217.      *
  218.      * @return string The HTML markup
  219.      */
  220.     public function block(FormView $view, $blockName, array $variables = [])
  221.     {
  222.         return $this->renderer->renderBlock($view, $blockName, $variables);
  223.     }
  225.     /**
  226.      * Returns a CSRF token.
  227.      *
  228.      * Use this helper for CSRF protection without the overhead of creating a
  229.      * form.
  230.      *
  231.      *     echo $view['form']->csrfToken('rm_user_'.$user->getId());
  232.      *
  233.      * Check the token in your action using the same CSRF token id.
  234.      *
  235.      *     // $csrfProvider being an instance of Symfony\Component\Security\Csrf\TokenGenerator\TokenGeneratorInterface
  236.      *     if (!$csrfProvider->isCsrfTokenValid('rm_user_'.$user->getId(), $token)) {
  237.      *         throw new \RuntimeException('CSRF attack detected.');
  238.      *     }
  239.      *
  240.      * @param string $tokenId The CSRF token id of the protected action
  241.      *
  242.      * @return string A CSRF token
  243.      *
  244.      * @throws \BadMethodCallException when no CSRF provider was injected in the constructor
  245.      */
  246.     public function csrfToken($tokenId)
  247.     {
  248.         return $this->renderer->renderCsrfToken($tokenId);
  249.     }
  251.     public function humanize($text)
  252.     {
  253.         return $this->renderer->humanize($text);
  254.     }
  256.     /**
  257.      * @internal
  258.      */
  259.     public function formEncodeCurrency($text, $widget = '')
  260.     {
  261.         if ('UTF-8' === $charset = $this->getCharset()) {
  262.             $text = htmlspecialchars($text, ENT_QUOTES | (\defined('ENT_SUBSTITUTE') ? ENT_SUBSTITUTE : 0), 'UTF-8');
  263.         } else {
  264.             $text = htmlentities($text, ENT_QUOTES | (\defined('ENT_SUBSTITUTE') ? ENT_SUBSTITUTE : 0), 'UTF-8');
  265.             $text = iconv('UTF-8', $charset, $text);
  266.             $widget = iconv('UTF-8', $charset, $widget);
  267.         }
  269.         return str_replace('{{ widget }}', $widget, $text);
  270.     }
  271. }