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