class FormHelper extends Helper

FormHelper provides helpers to help display forms.

Properties

protected $charset from Helper

Methods

setCharset(string $charset)

Sets the default charset.

from Helper
string
getCharset()

Gets the default charset.

from Helper
__construct(FormRendererInterface $renderer)

No description

string
getName()

Returns the canonical name of this helper.

setTheme(FormView $view, string|array $themes)

Sets a theme for a given view.

string
form(FormView $view, array $variables = array())

Renders the HTML for a form.

string
start(FormView $view, array $variables = array())

Renders the form start tag.

string
end(FormView $view, array $variables = array())

Renders the form end tag.

string
enctype(FormView $view) deprecated

Renders the HTML enctype in the form tag, if necessary.

string
widget(FormView $view, array $variables = array())

Renders the HTML for a given view.

string
row(FormView $view, array $variables = array())

Renders the entire form field "row".

string
label(FormView $view, string $label = null, array $variables = array())

Renders the label of the given view.

string
errors(FormView $view)

Renders the errors of the given view.

string
rest(FormView $view, array $variables = array())

Renders views which have not already been rendered.

string
block(FormView $view, string $blockName, array $variables = array())

Renders a block of the template.

string
csrfToken(string $intention)

Returns a CSRF token.

humanize($text)

No description

formEncodeCurrency($text, $widget = '')

No description

Details

in Helper at line 31
setCharset(string $charset)

Sets the default charset.

Parameters

string $charset The charset

in Helper at line 41
string getCharset()

Gets the default charset.

Return Value

string The default charset

at line 28
__construct(FormRendererInterface $renderer)

Parameters

FormRendererInterface $renderer

at line 36
string getName()

Returns the canonical name of this helper.

Return Value

string The canonical name

at line 49
setTheme(FormView $view, string|array $themes)

Sets a theme for a given view.

The theme format is ":".

Parameters

FormView $view A FormView instance
string|array $themes A theme or an array of theme

at line 78
string form(FormView $view, array $variables = array())

Renders the HTML for a form.

Example usage:

<?php echo view['form']->form($form) ?>

You can pass options during the call:

<?php echo view['form']->form($form, array('attr' => array('class' => 'foo'))) ?>

<?php echo view['form']->form($form, array('separator' => '+++++')) ?>

This method is mainly intended for prototyping purposes. If you want to control the layout of a form in a more fine-grained manner, you are advised to use the other helper methods for rendering the parts of the form individually. You can also create a custom form theme to adapt the look of the form.

Parameters

FormView $view The view for which to render the form
array $variables Additional variables passed to the template

Return Value

string The HTML markup

at line 95
string start(FormView $view, array $variables = array())

Renders the form start tag.

Example usage templates:

<?php echo $view['form']->start($form) ?>>

Parameters

FormView $view The view for which to render the start tag
array $variables Additional variables passed to the template

Return Value

string The HTML markup

at line 112
string end(FormView $view, array $variables = array())

Renders the form end tag.

Example usage templates:

<?php echo $view['form']->end($form) ?>>

Parameters

FormView $view The view for which to render the end tag
array $variables Additional variables passed to the template

Return Value

string The HTML markup

at line 131
string enctype(FormView $view) deprecated

deprecated since version 2.3, to be removed in 3.0. Use {@link start} instead.

Renders the HTML enctype in the form tag, if necessary.

Example usage templates:

<form action="..." method="post" <?php echo $view['form']->enctype($form) ?>>

Parameters

FormView $view The view for which to render the encoding type

Return Value

string The HTML markup

at line 156
string widget(FormView $view, array $variables = array())

Renders the HTML for a given view.

Example usage:

<?php echo $view['form']->widget($form) ?>

You can pass options during the call:

<?php echo $view['form']->widget($form, array('attr' => array('class' => 'foo'))) ?>

<?php echo $view['form']->widget($form, array('separator' => '+++++')) ?>

Parameters

FormView $view The view for which to render the widget
array $variables Additional variables passed to the template

Return Value

string The HTML markup

at line 169
string row(FormView $view, array $variables = array())

Renders the entire form field "row".

Parameters

FormView $view The view for which to render the row
array $variables Additional variables passed to the template

Return Value

string The HTML markup

at line 183
string label(FormView $view, string $label = null, array $variables = array())

Renders the label of the given view.

Parameters

FormView $view The view for which to render the label
string $label The label
array $variables Additional variables passed to the template

Return Value

string The HTML markup

at line 197
string errors(FormView $view)

Renders the errors of the given view.

Parameters

FormView $view

Return Value

string The HTML markup

at line 210
string rest(FormView $view, array $variables = array())

Renders views which have not already been rendered.

Parameters

FormView $view The parent view
array $variables An array of variables

Return Value

string The HTML markup

at line 224
string block(FormView $view, string $blockName, array $variables = array())

Renders a block of the template.

Parameters

FormView $view The view for determining the used themes
string $blockName The name of the block to render
array $variables The variable to pass to the template

Return Value

string The HTML markup

at line 250
string csrfToken(string $intention)

Returns a CSRF token.

Use this helper for CSRF protection without the overhead of creating a form.

echo $view['form']->csrfToken('rm_user_'.$user->getId());

Check the token in your action using the same intention.

$csrfProvider = $this->get('security.csrf.token_generator');
if (!$csrfProvider->isCsrfTokenValid('rm_user_'.$user->getId(), $token)) {
    throw new \RuntimeException('CSRF attack detected.');
}

Parameters

string $intention The intention of the protected action

Return Value

string A CSRF token

Exceptions

BadMethodCallException when no CSRF provider was injected in the constructor

at line 255
humanize($text)

Parameters

$text

at line 263
formEncodeCurrency($text, $widget = '')

Parameters

$text
$widget