name: FormRendererInterface
class_comment: null
dependencies: []
properties: []
methods:
- name: getEngine
  visibility: public
  parameters: []
  comment: '# * Renders a form into HTML.

    # *

    # * @author Bernhard Schussek <bschussek@gmail.com>

    # */

    # interface FormRendererInterface

    # {

    # /**

    # * Returns the engine used by this renderer.'
- name: setTheme
  visibility: public
  parameters:
  - name: view
  - name: themes
  - name: useDefaultThemes
    default: 'true'
  comment: '# * Sets the theme(s) to be used for rendering a view and its children.

    # *

    # * @param FormView $view             The view to assign the theme(s) to

    # * @param mixed    $themes           The theme(s). The type of these themes

    # *                                   is open to the implementation.

    # * @param bool     $useDefaultThemes If true, will use default themes specified

    # *                                   in the renderer'
- name: renderBlock
  visibility: public
  parameters:
  - name: view
  - name: blockName
  - name: variables
    default: '[]'
  comment: '# * Renders a named block of the form theme.

    # *

    # * @param FormView $view      The view for which to render the block

    # * @param array    $variables The variables to pass to the template'
- name: searchAndRenderBlock
  visibility: public
  parameters:
  - name: view
  - name: blockNameSuffix
  - name: variables
    default: '[]'
  comment: '# * 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.

    # *

    # * @param FormView $view      The view for which to render the block

    # * @param array    $variables The variables to pass to the template'
- name: renderCsrfToken
  visibility: public
  parameters:
  - name: tokenId
  comment: '# * Renders a CSRF token.

    # *

    # * Use this helper for CSRF protection without the overhead of creating a

    # * form.

    # *

    # *     <input type="hidden" name="token" value="<?php $renderer->renderCsrfToken(''rm_user_''.$user->getId())
    ?>">

    # *

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

    # *

    # *     // $csrfProvider being an instance of Symfony\Component\Security\Csrf\TokenGenerator\TokenGeneratorInterface

    # *     if (!$csrfProvider->isCsrfTokenValid(''rm_user_''.$user->getId(), $token))
    {

    # *         throw new \RuntimeException(''CSRF attack detected.'');

    # *     }'
- name: humanize
  visibility: public
  parameters:
  - name: text
  comment: '# * 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.'
traits: []
interfaces: []