FormBuilderInterface

EventDispatcherInterface getEventDispatcher()

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

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

EventDispatcherInterface

Диспетчер

string getName()

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

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

string

Имя формы

PropertyPathInterface|null getPropertyPath()

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

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

PropertyPathInterface|null

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

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|null getDataMapper()

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

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

DataMapperInterface|null

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

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|null getDataClass()

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

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

string|null

Класс данных или 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 = 0)

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

Параметры

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(string|PropertyPathInterface|null $propertyPath)

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

Параметры

string|PropertyPathInterface|null

$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

FormBuilderInterface add(string|int|FormBuilderInterface $child, string|null $type = null, array $options = array())

Добавляет новое поле в эту группу. Поле должно иметь уникальное имя в группе. В противном случае существующее поле перезаписывается.

Если вы добавляете вложенную группу, эта группа также должна быть представлена в иерархии объектов.

Параметры

string|int|FormBuilderInterface	$child
string|null	$type
array	$options

Значение возвращаемого значения

FormBuilderInterface

FormBuilderInterface create(string $name, string|null $type = null, array $options = array())

Создаёт билдер формы.

Параметры

string	$name	Имя формы или имя свойства
string|null	$type	Тип формы или null, если имя является свойством
array	$options	Опции

Значение возвращаемого значения

FormBuilderInterface

FormBuilderInterface get(string $name)

Возвращает дочерний элемент по имени.

Параметры

string

$name

Имя дочернего элемента

Значение возвращаемого значения

FormBuilderInterface

Исключения

InvalidArgumentException

если заданный дочерний элемент не существует

FormBuilderInterface remove(string $name)

Удаляет поле с заданным именем.

Параметры

string

$name

Значение возвращаемого значения

FormBuilderInterface

bool has(string $name)

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

Параметры

string

$name

Значение возвращаемого значения

bool

array all()

Возвращает дочерние элементы.

Значение возвращаемого значения

array

FormInterface getForm()

Создаёт форму.

Значение возвращаемого значения

FormInterface

Форма