FormBuilderInterface

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

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

Форма