1. class
  2. Symfony
  3. Bridge
  4. Twig
  5. Form
  6. TwigRenderer

TwigRenderer

class TwigRenderer extends FormRenderer implements TwigRendererInterface

Constants

CACHE_KEY_VAR

Methods

__construct(FormRendererEngineInterface $engine, CsrfTokenManagerInterface|null $csrfTokenManager = null)

Constructor.

FormRendererEngineInterface
getEngine()

Returns the engine used by this renderer.

from FormRenderer
setTheme(FormView $view, mixed $themes)

Sets the theme(s) to be used for rendering a view and its children.

from FormRenderer
string
renderCsrfToken(string $tokenId)

Renders a CSRF token.

from FormRenderer
string
renderBlock(FormView $view, string $blockName, array $variables = array())

Renders a named block of the form theme.

from FormRenderer
string
searchAndRenderBlock(FormView $view, string $blockNameSuffix, array $variables = array())

Searches and renders a block for a given name suffix.

from FormRenderer
string
humanize(string $text)

Makes a technical name human readable.

from FormRenderer
setEnvironment(Twig_Environment $environment)

Sets Twig's environment.

Details

at line line 26
__construct(FormRendererEngineInterface $engine, CsrfTokenManagerInterface|null $csrfTokenManager = null)

Constructor.

Parameters

FormRendererEngineInterface $engine
CsrfTokenManagerInterface|null $csrfTokenManager

Exceptions

UnexpectedTypeException

in FormRenderer at line line 78
FormRendererEngineInterface getEngine()

Returns the engine used by this renderer.

Return Value

FormRendererEngineInterface The renderer engine.

in FormRenderer at line line 86
setTheme(FormView $view, mixed $themes)

Sets the theme(s) to be used for rendering a view and its children.

Parameters

FormView $view The view to assign the theme(s) to.
mixed $themes The theme(s). The type of these themes is open to the implementation.

in FormRenderer at line line 94
string renderCsrfToken(string $tokenId)

Renders a CSRF token.

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

Check the token in your action using the same token ID.

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

Parameters

string $tokenId The ID of the CSRF token

Return Value

string A CSRF token

in FormRenderer at line line 106
string renderBlock(FormView $view, string $blockName, array $variables = array())

Renders a named block of the form theme.

Parameters

FormView $view The view for which to render the block.
string $blockName The name of the block.
array $variables The variables to pass to the template.

Return Value

string The HTML markup

in FormRenderer at line line 165
string searchAndRenderBlock(FormView $view, string $blockNameSuffix, array $variables = array())

Searches and renders a block for a given name suffix.

The block is searched by combining the block names stored in the form view with the given suffix. If a block name is found, that block is rendered.

If this method is called recursively, the block search is continued where a block was found before.

Parameters

FormView $view The view for which to render the block.
string $blockNameSuffix The suffix of the block name.
array $variables The variables to pass to the template.

Return Value

string The HTML markup

in FormRenderer at line line 316
string humanize(string $text)

Makes a technical name human readable.

Sequences of underscores are replaced by single spaces. The first letter of the resulting string is capitalized, while all other letters are turned to lowercase.

Parameters

string $text The text to humanize.

Return Value

string The humanized text.

at line line 36
setEnvironment(Twig_Environment $environment)

Sets Twig's environment.

Parameters

Twig_Environment $environment