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

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

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

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

Параметры

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

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

FormConfigBuilderInterface

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

FormConfigBuilderInterface addEventSubscriber(EventSubscriberInterface $subscriber)

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

Параметры

EventSubscriberInterface

$subscriber

Обработчик событий для добавления.

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

FormConfigBuilderInterface

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

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

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

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

Параметры

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

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

FormConfigBuilderInterface

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

FormConfigBuilderInterface resetViewTransformers()

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

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

FormConfigBuilderInterface

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

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

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

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

Параметры

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

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

FormConfigBuilderInterface

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

FormConfigBuilderInterface resetModelTransformers()

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

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

FormConfigBuilderInterface

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

FormConfigBuilderInterface setAttribute(string $name, mixed $value)

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

Параметры

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

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

FormConfigBuilderInterface

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

FormConfigBuilderInterface setAttributes(array $attributes)

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

Параметры

array

$attributes

Атрибуты.

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

FormConfigBuilderInterface

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

FormConfigBuilderInterface setDataMapper(DataMapperInterface $dataMapper = null)

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

Параметры

DataMapperInterface

$dataMapper

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

FormConfigBuilderInterface

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

FormConfigBuilderInterface setDisabled(bool $disabled)

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

Параметры

bool

$disabled

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

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

FormConfigBuilderInterface

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

FormConfigBuilderInterface setEmptyData(mixed $emptyData)

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

Параметры

mixed

$emptyData

Данные по умолчанию.

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

FormConfigBuilderInterface

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

FormConfigBuilderInterface setErrorBubbling(bool $errorBubbling)

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

Параметры

bool

$errorBubbling

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

FormConfigBuilderInterface

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

FormConfigBuilderInterface setRequired(bool $required)

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

Параметры

bool

$required

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

FormConfigBuilderInterface

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

FormConfigBuilderInterface setPropertyPath(null|string|PropertyPathInterface $propertyPath)

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

Параметры

null|string|PropertyPathInterface

$propertyPath

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

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

FormConfigBuilderInterface

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

FormConfigBuilderInterface setMapped(bool $mapped)

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

Параметры

bool

$mapped

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

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

FormConfigBuilderInterface

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

FormConfigBuilderInterface setByReference(bool $byReference)

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

Параметры

bool

$byReference

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

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

FormConfigBuilderInterface

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

FormConfigBuilderInterface setInheritData(bool $inheritData)

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

Параметры

bool

$inheritData

Следует ли форме наследовать данные родителя.

Значение результата

FormConfigBuilderInterface

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

FormConfigBuilderInterface setCompound(bool $compound)

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

Параметры

bool

$compound

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

Значение результата

FormConfigBuilderInterface

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

См. также

FormConfigInterface::getCompound()

FormConfigBuilderInterface setType(ResolvedFormTypeInterface $type)

Устанавливает типы.

Параметры

ResolvedFormTypeInterface

$type

Тип формы.

Значение результата

FormConfigBuilderInterface

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

FormConfigBuilderInterface setData(mixed $data)

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

Параметры

mixed

$data

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

Значение результата

FormConfigBuilderInterface

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

FormConfigBuilderInterface setDataLocked(bool $locked)

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

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

Параметры

bool

$locked

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

Значение результата

FormConfigBuilderInterface

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

setFormFactory(FormFactoryInterface $formFactory)

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

Параметры

FormFactoryInterface

$formFactory

Фабрика форм.

FormConfigBuilderInterface setAction(string $action)

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

Параметры

string

$action

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

Значение результата

FormConfigBuilderInterface

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

FormConfigBuilderInterface setMethod(string $method)

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

Параметры

string

$method

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

Значение результата

FormConfigBuilderInterface

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

FormConfigBuilderInterface setRequestHandler(RequestHandlerInterface $requestHandler)

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

Параметры

RequestHandlerInterface

$requestHandler

Значение результата

FormConfigBuilderInterface

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

FormConfigBuilderInterface setAutoInitialize(bool $initialize)

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

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

Параметры

bool

$initialize

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

Значение результата

FormConfigBuilderInterface

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

FormConfigInterface getFormConfig()

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

Значение результата

FormConfigInterface

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

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

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

Параметры

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

Значение результата

FormBuilderInterface

Объект билдера.

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

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

Параметры

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

Значение результата

FormBuilderInterface

Созданный билдер.

FormBuilderInterface get(string $name)

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

Параметры

string

$name

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

Значение результата

FormBuilderInterface

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

Исключения

InvalidArgumentException

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

FormBuilderInterface remove(string $name)

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

Параметры

string

$name

Значение результата

FormBuilderInterface

Объект билдера.

bool has(string $name)

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

Параметры

строка

$name

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

bool

array all()

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

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

array

Форма getForm()

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

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

Форма

Форма