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

массив all()

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

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

массив

Форма getForm()

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

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

Форма

Форма