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.2/Symfony/Bundle/FrameworkBundle/Templating/Helper/FormHelper.html