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, 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 | 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, 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 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 being an instance of Symfony\Component\Security\Csrf\TokenGenerator\TokenGeneratorInterface
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.4/Symfony/Bundle/FrameworkBundle/Templating/Helper/FormHelper.html