FormHelper

setCharset(string $charset)

Sets the default charset.

Parameters

string

$charset

The charset

string getCharset()

Gets the default charset.

Return Value

string

The default charset

__construct(FormRendererInterface $renderer)

Parameters

FormRendererInterface

$renderer

string getName()

Returns the canonical name of this helper.

Return Value

string

The canonical name

setTheme(FormView $view, string|array $themes, bool $useDefaultThemes = true)

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
bool	$useDefaultThemes	If true, will use default themes defined in the renderer

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

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

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

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

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

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

string errors(FormView $view)

Renders the errors of the given view.

Parameters

FormView

$view

Return Value

string

The HTML markup

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

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

string csrfToken(string $tokenId)

Returns a CSRF token.

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

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

Check the token in your action using the same CSRF token id.

// $csrfProvider being an instance of Symfony\Component\Security\Csrf\TokenGenerator\TokenGeneratorInterface if (!$csrfProvider->isCsrfTokenValid('rmuser'.$user->getId(), $token)) { throw new \RuntimeException('CSRF attack detected.'); }

Parameters

string

$tokenId

The CSRF token id of the protected action

Return Value

string

A CSRF token

Exceptions

BadMethodCallException

when no CSRF provider was injected in the constructor

humanize($text)

Parameters

$text