FormHelper
class FormHelper extends Helper
FormHelper предоставляет помощники для отображения форм.
Методы
| setCharset(string $charset) Устанавливает кодировку по умолчанию. | from Helper | |
| string | getCharset() Получает кодировку по умолчанию. | from Helper |
| __construct(FormRendererInterface $renderer) | ||
| string | getName() Возвращает каноническое имя этого помощника. | |
| setTheme(FormView $view, string|array $themes) Устанавливает тему для данного представления. | ||
| string | form(FormView $view, array $variables = array()) Отображает HTML для формы. | |
| string | start(FormView $view, array $variables = array()) Отображает открывающий тег формы. | |
| string | end(FormView $view, array $variables = array()) Отображает закрывающий тег формы. | |
| string | widget(FormView $view, array $variables = array()) Отображает HTML для данного представления. | |
| string | row(FormView $view, array $variables = array()) Отображает всю строку поля формы. | |
| string | label(FormView $view, string $label = null, array $variables = array()) Отображает метку данного представления. | |
| string | errors(FormView $view) Отображает ошибки данного представления. | |
| string | rest(FormView $view, array $variables = array()) Отображает представления, которые еще не отображались. | |
| string | block(FormView $view, string $blockName, array $variables = array()) Отображает блок шаблона. | |
| string | csrfToken(string $tokenId) Возвращает токен CSRF. | |
| humanize($text) |
Подробности
setCharset(string $charset)
Устанавливает значение по умолчанию для кодировки символов.
Параметры
| string | $charset | Кодировка символов |
string getCharset()
Возвращает значение по умолчанию для кодировки символов.
Значение возврата
| string | Значение по умолчанию для кодировки символов |
__construct(FormRendererInterface $renderer)
Параметры
| FormRendererInterface | $renderer |
string getName()
Возвращает каноническое имя этого помощника.
Значение возврата
| string | Каноническое имя |
setTheme(FormView $view, string|array $themes)
Устанавливает тему для заданного представления.
Формат темы — "<пакет>:<контроллер>".
Параметры
| FormView | $view | Экземпляр FormView |
| string|array | $themes | Тема или массив тем |
string form(FormView $view, array $variables = array())
Отображает HTML для формы.
Пример использования:
<?php echo view['form']->form($form) ?>
Вы можете передать параметры при вызове:
<?php echo view['form']->form($form, array('attr' => array('class' => 'foo'))) ?>
<?php echo view['form']->form($form, array('separator' => '+++++')) ?>
Этот метод в основном предназначен для прототипирования. Если вы хотите более точно управлять макетом формы, рекомендуется использовать другие методы помощника для рендеринга отдельных частей формы. Вы также можете создать пользовательскую тему формы для адаптации внешнего вида формы.
Параметры
| FormView | $view | Представление, для которого нужно отобразить форму |
| array | $variables | Дополнительные переменные, передаваемые в шаблон |
Значение возврата
| string | HTML-разметка |
string start(FormView $view, array $variables = array())
Отображает стартовую метку формы.
Примеры использования шаблонов:
<?php echo $view['form']->start($form) ?>>
Параметры
| FormView | $view | Представление, для которого нужно отобразить стартовую метку |
| array | $variables | Дополнительные переменные, передаваемые в шаблон |
Значение возврата
| string | HTML-разметка |
string end(FormView $view, array $variables = array())
Отображает закрывающую метку формы.
Примеры использования шаблонов:
<?php echo $view['form']->end($form) ?>>
Параметры
| FormView | $view | Представление, для которого нужно отобразить закрывающую метку |
| array | $variables | Дополнительные переменные, передаваемые в шаблон |
Значение возврата
| string | HTML-разметка |
string widget(FormView $view, array $variables = array())
Отображает HTML для заданного представления.
Пример использования:
<?php echo $view['form']->widget($form) ?>
Вы можете передать параметры при вызове:
<?php echo $view['form']->widget($form, array('attr' => array('class' => 'foo'))) ?>
<?php echo $view['form']->widget($form, array('separator' => '+++++')) ?>
Параметры
| FormView | $view | Представление, для которого нужно отобразить виджет |
| array | $variables | Дополнительные переменные, передаваемые в шаблон |
Значение возврата
| string | HTML-разметка |
string row(FormView $view, array $variables = array())
Отображает всю строку поля формы.
Параметры
| FormView | $view | Представление, для которого нужно отобразить строку |
| array | $variables | Дополнительные переменные, передаваемые в шаблон |
Значение возврата
| string | HTML-разметка |
string label(FormView $view, string $label = null, array $variables = array())
Отображает метку заданного представления.
Параметры
| FormView | $view | Представление, для которого нужно отобразить метку |
| string | $label | Метка |
| array | $variables | Дополнительные переменные, передаваемые в шаблон |
Значение возврата
| string | HTML-разметка |
string errors(FormView $view)
Отображает ошибки данного представления.
Параметры
| FormView | $view |
Значение возврата
| string | HTML-разметка |
string rest(FormView $view, array $variables = array())
Отображает представления, которые еще не были отображены.
Параметры
| FormView | $view | Родительское представление |
| array | $variables | Массив переменных |
Значение возврата
| string | HTML-разметка |
string block(FormView $view, string $blockName, array $variables = array())
Отображает блок шаблона.
Параметры
| FormView | $view | Представление для определения используемых тем |
| string | $blockName | Имя блока для отображения |
| array | $variables | Переменные для передачи в шаблон |
Значение возврата
| string | HTML-разметка |
string csrfToken(string $tokenId)
Возвращает токен CSRF.
Используйте этот помощник для защиты от CSRF без необходимости создания формы.
echo $view['form']->csrfToken('rmuser'.$user->getId());
Проверьте токен в вашем действии, используя тот же идентификатор токена CSRF.
$csrfProvider = $this->get('security.csrf.tokengenerator');
if (!$csrfProvider->isCsrfTokenValid('rmuser_'.$user->getId(), $token)) {
throw new \RuntimeException('CSRF attack detected.');
}
Параметры
| string | $tokenId | Идентификатор токена CSRF защищаемого действия |
Значение возврата
| string | Токен CSRF |
Исключения
| BadMethodCallException | при отсутствии поставщика CSRF, внедренного в конструктор |
humanize($text)
Параметры
| $text |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.3/Symfony/Bundle/FrameworkBundle/Templating/Helper/FormHelper.html