Spec-Zone.ru › Symfony 4.1

FormHelper

class FormHelper extends Helper

FormHelper предоставляет вспомогательные функции для отображения форм.

Свойства

protected $charset из Helper

Методы

setCharset(string $charset)

Устанавливает кодировку по умолчанию.

из Helper
string getCharset()

Получает кодировку по умолчанию.

из Helper
__construct(FormRendererInterface $renderer)
string getName()

Возвращает каноническое имя этого помощника.

setTheme(FormView $view, string|array $themes, bool $useDefaultThemes = true)

Устанавливает тему для данного представления.

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 help(FormView $view)

Отображает подсказку для данного представления.

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)
formEncodeCurrency($text, $widget = '')

Подробности

setCharset(string $charset)

Устанавливает кодировку по умолчанию.

Параметры

string $charset Кодировка

string getCharset()

Получает кодировку по умолчанию.

Значение возврата

string Кодировка по умолчанию

__construct(FormRendererInterface $renderer)

Параметры

FormRendererInterface $renderer

string getName()

Возвращает каноническое имя этого помощника.

Значение возврата

string Каноническое имя

setTheme(FormView $view, string|array $themes, bool $useDefaultThemes = true)

Устанавливает тему для заданного представления.

Формат темы: «<пучок>:<контроллер>».

Параметры

FormView $view Объект FormView
string|array $themes Тема или массив тем
bool $useDefaultThemes Если true, будут использоваться темы по умолчанию, определенные в рендерере

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 help(FormView $view)

Отображает помощь для данного представления.

Параметры

FormView $view Родительское представление

Значение возврата

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('rm_user_'.$user->getId());

Проверьте токен в вашем обработчике, используя тот же идентификатор токена CSRF.

// $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.');
}

Параметры

string $tokenId Идентификатор токена CSRF защищаемого обработчика

Значение возврата

string Токен CSRF

Исключения

BadMethodCallException если в конструктор не был внедрен поставщик CSRF

humanize($text)

Параметры

$text

formEncodeCurrency($text, $widget = '')

Параметры

$text
$widget

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Bundle/FrameworkBundle/Templating/Helper/FormHelper.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API