FormBuilderInterface

интерфейс FormBuilderInterface реализует Traversable, Countable, FormConfigBuilderInterface

Методы

EventDispatcherInterface	getEventDispatcher() Возвращает диспетчер событий, используемый для отправки событий формы.	из FormConfigInterface
string	getName() Возвращает имя формы, используемой в качестве HTTP параметра.	из FormConfigInterface
null\|PropertyPathInterface	getPropertyPath() Возвращает путь к свойству, к которому должна быть сопоставлена форма.	из FormConfigInterface
bool	getMapped() Возвращает, должна ли форма быть сопоставлена с элементом данных родительской формы.	из FormConfigInterface
bool	getByReference() Возвращает, должны ли данные формы изменяться по ссылке.	из FormConfigInterface
bool	getInheritData() Возвращает, должна ли форма читать и записывать данные родительской формы.	из FormConfigInterface
bool	getCompound() Возвращает, является ли форма составной.	из FormConfigInterface
ResolvedFormTypeInterface	getType() Возвращает типы форм, используемые для построения формы.	из FormConfigInterface
DataTransformerInterface[]	getViewTransformers() Возвращает преобразователи представления формы.	из FormConfigInterface
DataTransformerInterface[]	getModelTransformers() Возвращает преобразователи модели формы.	из FormConfigInterface
DataMapperInterface	getDataMapper() Возвращает маппер данных формы.	из FormConfigInterface
bool	getRequired() Возвращает, является ли форма обязательной.	из FormConfigInterface
bool	getDisabled() Возвращает, является ли форма отключенной.	из FormConfigInterface
bool	getErrorBubbling() Возвращает, будут ли ошибки, прикрепленные к форме, передаваться родительской форме.	из FormConfigInterface
mixed	getEmptyData() Возвращает данные, которые должны быть возвращены, когда форма пуста.	из FormConfigInterface
array	getAttributes() Возвращает дополнительные атрибуты формы.	из FormConfigInterface
bool	hasAttribute(string $name) Возвращает, существует ли атрибут с данным именем.	из FormConfigInterface
mixed	getAttribute(string $name, mixed $default = null) Возвращает значение данного атрибута.	из FormConfigInterface
mixed	getData() Возвращает начальные данные формы.	из FormConfigInterface
string	getDataClass() Возвращает класс данных формы или null, если данные являются скалярными или массивом.	из FormConfigInterface
bool	getDataLocked() Возвращает, заблокированы ли данные формы.	из FormConfigInterface
FormFactoryInterface	getFormFactory() Возвращает фабрику форм, используемую для создания новых форм.	из FormConfigInterface
string	getAction() Возвращает целевой URL формы.	из FormConfigInterface
string	getMethod() Возвращает HTTP-метод, используемый формой.	из FormConfigInterface
RequestHandlerInterface	getRequestHandler() Возвращает обработчик запросов, используемый формой.	из FormConfigInterface
bool	getAutoInitialize() Возвращает, должна ли форма инициализироваться при создании.	из FormConfigInterface
array	getOptions() Возвращает все опции, переданные во время создания формы.	из FormConfigInterface
bool	hasOption(string $name) Возвращает, существует ли определенная опция.	из FormConfigInterface
mixed	getOption(string $name, mixed $default = null) Возвращает значение определенной опции.	из FormConfigInterface
$this	addEventListener(string $eventName, callable $listener, int $priority) Добавляет обработчик событий для события в этой форме.	из FormConfigBuilderInterface
$this	addEventSubscriber(EventSubscriberInterface $subscriber) Добавляет подписчика на события для событий в этой форме.	из FormConfigBuilderInterface
$this	addViewTransformer(DataTransformerInterface $viewTransformer, bool $forcePrepend = false) Добавляет/переопределяет преобразователь в цепочку преобразователей представления.	из FormConfigBuilderInterface
$this	resetViewTransformers() Очищает преобразователи представления.	из FormConfigBuilderInterface

$this	addModelTransformer(DataTransformerInterface $modelTransformer, bool $forceAppend = false) Добавляет/присоединяет преобразователь к цепочке преобразователей нормализации.	из FormConfigBuilderInterface
$this	resetModelTransformers() Очищает преобразователи нормализации.	из FormConfigBuilderInterface
$this	setAttribute(string $name, mixed $value) Устанавливает значение для атрибута.	из FormConfigBuilderInterface
$this	setAttributes(array $attributes) Устанавливает атрибуты.	из FormConfigBuilderInterface
$this	setDataMapper(DataMapperInterface $dataMapper = null) Устанавливает маппер данных, используемый формой.	из FormConfigBuilderInterface
$this	setDisabled(bool $disabled) Устанавливает, отключена ли форма.	из FormConfigBuilderInterface
$this	setEmptyData(mixed $emptyData) Устанавливает данные, используемые для данных клиента, когда значение не отправляется.	из FormConfigBuilderInterface
$this	setErrorBubbling(bool $errorBubbling) Устанавливает, должны ли ошибки передаваться родительскому элементу.	из FormConfigBuilderInterface
$this	setRequired(bool $required) Устанавливает, является ли это поле обязательным для заполнения при отправке.	из FormConfigBuilderInterface
$this	setPropertyPath(null\|string\|PropertyPathInterface $propertyPath) Устанавливает путь к свойству, к которому должна быть сопоставлена форма.	из FormConfigBuilderInterface
$this	setMapped(bool $mapped) Устанавливает, должна ли форма быть сопоставлена с элементом данных родителя.	из FormConfigBuilderInterface
$this	setByReference(bool $byReference) Устанавливает, должны ли данные формы изменяться по ссылке.	из FormConfigBuilderInterface
$this	setInheritData(bool $inheritData) Устанавливает, должна ли форма читать и записывать данные родителя.	из FormConfigBuilderInterface
$this	setCompound(bool $compound) Устанавливает, должна ли форма быть составной.	из FormConfigBuilderInterface
$this	setType(ResolvedFormTypeInterface $type) Установить типы.	из FormConfigBuilderInterface
$this	setData(mixed $data) Устанавливает начальные данные формы.	из FormConfigBuilderInterface
$this	setDataLocked(bool $locked) Заблокировать данные формы к данным, переданным в конфигурацию.	из FormConfigBuilderInterface
	setFormFactory(FormFactoryInterface $formFactory) Устанавливает фабрику форм, используемую для создания новых форм.	из FormConfigBuilderInterface
$this	setAction(string $action) Устанавливает целевой URL формы.	из FormConfigBuilderInterface
$this	setMethod(string $method) Устанавливает HTTP-метод, используемый формой.	из FormConfigBuilderInterface
$this	setRequestHandler(RequestHandlerInterface $requestHandler) Устанавливает обработчик запросов, используемый формой.	из FormConfigBuilderInterface
$this	setAutoInitialize(bool $initialize) Устанавливает, должна ли форма инициализироваться автоматически.	из FormConfigBuilderInterface
FormConfigInterface	getFormConfig() Создаёт и возвращает конфигурацию формы.	из FormConfigBuilderInterface
FormBuilderInterface	add(string\|int\|FormBuilderInterface $child, string\|FormTypeInterface $type = null, array $options = array()) Добавляет новое поле в эту группу. Поле должно иметь уникальное имя внутри группы. В противном случае существующее поле перезаписывается.
FormBuilderInterface	create(string $name, string\|FormTypeInterface $type = null, array $options = array()) Создаёт билдер формы.
FormBuilderInterface	get(string $name) Возвращает дочерний элемент по имени.
FormBuilderInterface	remove(string $name) Удаляет поле с заданным именем.
bool	has(string $name) Возвращает, существует ли поле с заданным именем.
array	all() Возвращает дочерние элементы.
FormInterface	getForm() Создаёт форму.

Подробности

EventDispatcherInterface getEventDispatcher()

Возвращает диспетчер событий, используемый для отправки событий формы.

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

EventDispatcherInterface

Диспетчер

string getName()

Возвращает имя формы, используемой в качестве параметра HTTP.

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

string

Имя формы

null|PropertyPathInterface getPropertyPath()

Возвращает путь к свойству, к которому должна быть сопоставлена форма.

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

null|PropertyPathInterface

Путь к свойству

bool getMapped()

Возвращает, должна ли форма быть сопоставлена с элементом данных родителя.

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

bool	Сопоставлена ли форма

bool getByReference()

Возвращает, должно ли изменяться данные формы по ссылке.

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

bool	Изменять данные формы по ссылке

bool getInheritData()

Возвращает, должна ли форма читать и записывать данные родителя.

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

bool	Должна ли форма наследовать данные родителя

bool getCompound()

Возвращает, является ли форма составной.

Это свойство независимо от того, есть ли у формы дочерние элементы. Форма может быть составной и не иметь дочерних элементов, например, пустая форма коллекции.

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

bool	Является ли форма составной

ResolvedFormTypeInterface getType()

Возвращает типы форм, используемые для построения формы.

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

ResolvedFormTypeInterface

Тип формы

DataTransformerInterface[] getViewTransformers()

Возвращает преобразователи представления формы.

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

DataTransformerInterface[]

Массив экземпляров {@link DataTransformerInterface}

DataTransformerInterface[] getModelTransformers()

Возвращает преобразователи модели формы.

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

DataTransformerInterface[]

Массив экземпляров {@link DataTransformerInterface}

DataMapperInterface getDataMapper()

Возвращает маппер данных формы.

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

DataMapperInterface

Маппер данных

bool getRequired()

Возвращает, является ли форма обязательной.

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

bool	Является ли форма обязательной

bool getDisabled()

Возвращает, отключена ли форма.

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

bool	Отключена ли форма

bool getErrorBubbling()

Возвращает, будут ли ошибки, привязанные к форме, передаваться родителю.

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

bool	Будут ли ошибки передаваться вверх

mixed getEmptyData()

Возвращает данные, которые должны быть возвращены, когда форма пустая.

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

mixed

Данные, возвращаемые, если форма пустая

array getAttributes()

Возвращает дополнительные атрибуты формы.

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

array

Массив пар ключ-значение

bool hasAttribute(string $name)

Возвращает, существует ли атрибут с заданным именем.

Параметры

string

$name

Имя атрибута

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

bool	Существует ли атрибут

mixed getAttribute(string $name, mixed $default = null)

Возвращает значение заданного атрибута.

Параметры

string	$name	Имя атрибута
mixed	$default	Значение, возвращаемое, если атрибут не существует

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

mixed

Значение атрибута

mixed getData()

Возвращает исходные данные формы.

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

mixed

Исходные данные формы

string getDataClass()

Возвращает класс данных формы или null, если данные являются скалярными или массивом.

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

string

Класс данных или null

bool getDataLocked()

Возвращает, заблокированы ли данные формы.

Форма с заблокированными данными ограничена данными, переданными в этом конфигурации. Данные могут быть изменены только при отправке формы.

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

bool	Заблокированы ли данные

FormFactoryInterface getFormFactory()

Возвращает фабрику форм, используемую для создания новых форм.

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

FormFactoryInterface

Фабрика форм

string getAction()

Возвращает целевой URL формы.

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

string

Целевой URL формы

string getMethod()

Возвращает HTTP-метод, используемый формой.

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

string

HTTP-метод формы

RequestHandlerInterface getRequestHandler()

Возвращает обработчик запроса, используемый формой.

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

RequestHandlerInterface

Обработчик запроса

bool getAutoInitialize()

Возвращает, должна ли форма инициализироваться при создании.

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

bool	Возвращает true, если форма должна инициализироваться при создании, иначе false.

array getOptions()

Возвращает все параметры, переданные при создании формы.

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

array

Переданные параметры

bool hasOption(string $name)

Возвращает, существует ли конкретный параметр.

Параметры

string

$name

Имя параметра

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

bool	Существует ли параметр

mixed getOption(string $name, mixed $default = null)

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

Параметры

string	$name	Имя параметра
mixed	$default	Значение, возвращаемое, если параметр не существует

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

mixed

Значение параметра

$this addEventListener(string $eventName, callable $listener, int $priority)

Добавляет обработчик событий для события в этой форме.

Параметры

string	$eventName	Имя события, на которое нужно подписаться
callable	$listener	Обработчик для выполнения
int	$priority	Приоритет обработчика. Обработчики с более высоким приоритетом вызываются до обработчиков с более низким приоритетом.

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

$this

Объект конфигурации

$this addEventSubscriber(EventSubscriberInterface $subscriber)

Добавляет обработчик событий для событий в этой форме.

Параметры

EventSubscriberInterface

$subscriber

Подписчик для добавления

Возвращаемое значение

$this

Объект конфигурации

$this addViewTransformer(DataTransformerInterface $viewTransformer, bool $forcePrepend = false)

Добавляет/вставляет преобразователь в цепочку преобразователей представления.

Метод transform преобразователя используется для преобразования данных из нормализованного формата в формат представления. Метод reverseTransform преобразователя используется для преобразования из формата представления в нормализованный формат.

Параметры

DataTransformerInterface	$viewTransformer
bool	$forcePrepend	если установлено в true, вставка вместо добавления

Возвращаемое значение

$this

Объект конфигурации

$this resetViewTransformers()

Очищает преобразователи представления.

Возвращаемое значение

$this

Объект конфигурации

$this addModelTransformer(DataTransformerInterface $modelTransformer, bool $forceAppend = false)

Вставляет/добавляет преобразователь в цепочку преобразователей нормализации.

Метод transform преобразователя используется для преобразования данных из модели в нормализованный формат. Метод reverseTransform преобразователя используется для преобразования из нормализованного в формат модели.

Параметры

DataTransformerInterface	$modelTransformer
bool	$forceAppend	если установлено в true, добавление вместо вставки

Возвращаемое значение

$this

Объект конфигурации

$this resetModelTransformers()

Очищает преобразователи нормализации.

Возвращаемое значение

$this

Объект конфигурации

$this setAttribute(string $name, mixed $value)

Устанавливает значение для атрибута.

Параметры

string	$name	Имя атрибута
mixed	$value	Значение атрибута

Возвращаемое значение

$this

Объект конфигурации

$this setAttributes(array $attributes)

Устанавливает атрибуты.

Параметры

array

$attributes

Атрибуты

Возвращаемое значение

$this

Объект конфигурации

$this setDataMapper(DataMapperInterface $dataMapper = null)

Устанавливает маппер данных, используемый формой.

Параметры

DataMapperInterface

$dataMapper

Возвращаемое значение

$this

Объект конфигурации

$this setDisabled(bool $disabled)

Устанавливает, отключена ли форма.

Параметры

bool

$disabled

Отключена ли форма

Возвращаемое значение

$this

Объект конфигурации

$this setEmptyData(mixed $emptyData)

Устанавливает данные, используемые для данных клиента, когда значение не отправлено.

Параметры

mixed

$emptyData

Пустые данные

Возвращаемое значение

$this

Объект конфигурации

$this setErrorBubbling(bool $errorBubbling)

Устанавливает, будут ли ошибки подниматься к родителю.

Параметры

bool

$errorBubbling

Возвращаемое значение

$this

Объект конфигурации

$this setRequired(bool $required)

Устанавливает, обязательным ли является это поле для заполнения при отправке.

Параметры

bool

$required

Возвращаемое значение

$this

Объект конфигурации

$this setPropertyPath(null|string|PropertyPathInterface $propertyPath)

Устанавливает путь к свойству, к которому должна быть привязана форма.

Параметры

null|string|PropertyPathInterface

$propertyPath

Путь к свойству или null, если путь должен быть установлен автоматически на основе имени формы.

Возвращаемое значение

$this

Объект конфигурации

$this setMapped(bool $mapped)

Устанавливает, должна ли форма быть привязана к элементу данных родителя.

Параметры

bool

$mapped

Должна ли форма быть привязана

Возвращаемое значение

$this

Объект конфигурации

$this setByReference(bool $byReference)

Устанавливает, должны ли данные формы изменяться по ссылке.

Параметры

bool

$byReference

Изменяться ли данные по ссылке.

Возвращаемое значение

$this

Объект конфигурации

$this setInheritData(bool $inheritData)

Устанавливает, должна ли форма считывать и записывать данные родителя.

Параметры

bool

$inheritData

Должна ли форма наследовать данные родителя

Возвращаемое значение

$this

Объект конфигурации

$this setCompound(bool $compound)

Устанавливает, должна ли форма быть составной.

Параметры

bool

$compound

Должна ли форма быть составной

Возвращаемое значение

$this

Объект конфигурации

См. также

FormConfigInterface::getCompound()

$this setType(ResolvedFormTypeInterface $type)

Установить типы.

Параметры

ResolvedFormTypeInterface

$type

Тип формы

Возвращаемое значение

$this

Объект конфигурации

$this setData(mixed $data)

Устанавливает начальные данные формы.

Параметры

mixed

$data

Данные формы в формате приложения

Возвращаемое значение

$this

Объект конфигурации

$this setDataLocked(bool $locked)

Заблокировать данные формы для данных, переданных в конфигурацию.

Форма с заблокированными данными ограничена данными, переданными в этой конфигурации. Данные могут быть изменены только при отправке формы.

Параметры

bool

$locked

Блокировать ли данные по умолчанию

Возвращаемое значение

$this

Объект конфигурации

setFormFactory(FormFactoryInterface $formFactory)

Устанавливает фабрику форм, используемую для создания новых форм.

Параметры

FormFactoryInterface

$formFactory

Фабрика форм

$this setAction(string $action)

Устанавливает целевой URL формы.

Параметры

string

$action

Целевой URL формы

Возвращаемое значение

$this

Объект конфигурации

$this setMethod(string $method)

Устанавливает HTTP-метод, используемый формой.

Параметры

string

$method

HTTP-метод формы

Возвращаемое значение

$this

Объект конфигурации

$this setRequestHandler(RequestHandlerInterface $requestHandler)

Устанавливает обработчик запросов, используемый формой.

Параметры

RequestHandlerInterface

$requestHandler

Возвращаемое значение

$this

Объект конфигурации

$this setAutoInitialize(bool $initialize)

Устанавливает, должна ли форма автоматически инициализироваться.

Должно быть установлено в true только для корневых форм.

Параметры

bool

$initialize

True для автоматической инициализации формы, false для подавления автоматической инициализации. В последнем случае необходимо вручную вызвать {@link FormInterface::initialize()}.

Возвращаемое значение

$this

Объект конфигурации

FormConfigInterface getFormConfig()

Создаёт и возвращает конфигурацию формы.

Возвращаемое значение

FormConfigInterface