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

Истина для автоматической инициализации формы, ложь для подавления автоматической инициализации. В последнем случае вам нужно вручную вызвать {@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)

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

Параметры

string

$name

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

bool

array all()

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

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

array

Form getForm()

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

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

Form

Форма