Classes List

Symfony\Component\Form\FormRendererInterface

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
 60 
 61 
 62 
 63 
 64 
 65 
 66 
 67 
 68 
 69 
 70 
 71 
 72 
 73 
 74 
 75 
 76 
 77 
 78 
 79 
 80 
 81 
 82 
 83 
 84 
 85 
 86 
 87 
 88 
 89 
 90 
 91 
 92 
 93 
 94 
 95 
 96 
 97 
 98 
 99 
 100 
 101 
 102 
 103 
 104 
 105 
 106 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


namespace Symfony\Component\Form;

/** * Renders a form into HTML. * * @author Bernhard Schussek <bschussek@gmail.com> */
interface FormRendererInterface
{
    /** * Returns the engine used by this renderer. * * @return FormRendererEngineInterface The renderer engine */
    public function getEngine();

    /** * 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, will be added to the interface in 4.0 */
    public function setTheme(FormView $view$themes /*, $useDefaultThemes = true */
);

    /** * Renders a named block of the form theme. * * @param FormView $view The view for which to render the block * @param string $blockName The name of the block * @param array $variables The variables to pass to the template * * @return string The HTML markup */
    public function renderBlock(FormView $view$blockNamearray $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. * * @param FormView $view The view for which to render the block * @param string $blockNameSuffix The suffix of the block name * @param array $variables The variables to pass to the template * * @return string The HTML markup */
    public function searchAndRenderBlock(FormView $view$blockNameSuffixarray $variables = array());

    /** * Renders a CSRF token. * * Use this helper for CSRF protection without the overhead of creating a * form. * * <code> * <input type="hidden" name="token" value="<?php $renderer->renderCsrfToken('rm_user_'.$user->getId()) ?>"> * </code> * * Check the token in your action using the same token ID. * * <code> * // $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.'); * } * </code> * * @param string $tokenId The ID of the CSRF token * * @return string A CSRF token */
    public function renderCsrfToken($tokenId);

    /** * 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. * * @param string $text The text to humanize * * @return string The humanized text */
    public function humanize($text);
}