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

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

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

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

Параметры

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

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

$this

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

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

$this remove(string $name)

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

Параметры

string

$name

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

$this

bool has(string $name)

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

Параметры

string

$name

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

bool

array all()

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

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

array

FormInterface getForm()

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

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

FormInterface

Форма