FormBuilder

класс FormBuilder расширяет FormConfigBuilder и реализует IteratorAggregate, FormBuilderInterface

Построитель для создания экземпляров {@link Form}.

Методы

	__construct(string\|int $name, string $dataClass, EventDispatcherInterface $dispatcher, FormFactoryInterface $factory, array $options = array()) Создаёт новый билдер формы.
FormConfigBuilderInterface	addEventListener(string $eventName, callable $listener, int $priority) Добавляет обработчик событий для события этой формы.	из FormConfigBuilder
FormConfigBuilderInterface	addEventSubscriber(EventSubscriberInterface $subscriber) Добавляет подписчика на события для этой формы.	из FormConfigBuilder
FormConfigBuilderInterface	addViewTransformer(DataTransformerInterface $viewTransformer, bool $forcePrepend = false) Добавляет/вставляет преобразователь в цепочку преобразователей представления.	из FormConfigBuilder
FormConfigBuilderInterface	resetViewTransformers() Очищает преобразователи представления.	из FormConfigBuilder
FormConfigBuilderInterface	addModelTransformer(DataTransformerInterface $modelTransformer, bool $forceAppend = false) Добавляет/вставляет преобразователь в цепочку преобразователей нормализации.	из FormConfigBuilder
FormConfigBuilderInterface	resetModelTransformers() Очищает преобразователи нормализации.	из FormConfigBuilder
EventDispatcherInterface	getEventDispatcher() Возвращает диспетчер событий, используемый для отправки событий формы.	из FormConfigBuilder
string	getName() Возвращает имя формы, используемое в качестве HTTP параметра.	из FormConfigBuilder
null\|PropertyPathInterface	getPropertyPath() Возвращает путь к свойству, к которому должна быть сопоставлена форма.	из FormConfigBuilder
bool	getMapped() Возвращает, должна ли форма быть сопоставлена элементу данных родительской формы.	из FormConfigBuilder
bool	getByReference() Возвращает, должны ли данные формы изменяться по ссылке.	из FormConfigBuilder
bool	getInheritData() Возвращает, должна ли форма читать и записывать данные своего родителя.	из FormConfigBuilder
bool	getCompound() Возвращает, является ли форма составной.	из FormConfigBuilder
ResolvedFormTypeInterface	getType() Возвращает тип формы, используемый для построения формы.	из FormConfigBuilder
DataTransformerInterface[]	getViewTransformers() Возвращает преобразователи представления формы.	из FormConfigBuilder
DataTransformerInterface[]	getModelTransformers() Возвращает преобразователи модели формы.	из FormConfigBuilder
DataMapperInterface	getDataMapper() Возвращает мапер данных формы.	из FormConfigBuilder
bool	getRequired() Возвращает, является ли форма обязательной.	из FormConfigBuilder
bool	getDisabled() Возвращает, является ли форма отключенной.	из FormConfigBuilder
bool	getErrorBubbling() Возвращает, будут ли ошибки, связанные с формой, передаваться родителю.	из FormConfigBuilder
mixed	getEmptyData() Возвращает данные, которые должны быть возвращены, когда форма пуста.	из FormConfigBuilder
array	getAttributes() Возвращает дополнительные атрибуты формы.	из FormConfigBuilder
bool	hasAttribute(string $name) Возвращает, существует ли атрибут с данным именем.	из FormConfigBuilder
mixed	getAttribute(string $name, mixed $default = null) Возвращает значение данного атрибута.	из FormConfigBuilder
mixed	getData() Возвращает исходные данные формы.	из FormConfigBuilder
string	getDataClass() Возвращает класс данных формы или null, если данные являются скалярными или массивом.	из FormConfigBuilder
bool	getDataLocked() Возвращает, заблокированы ли данные формы.	из FormConfigBuilder
FormFactoryInterface	getFormFactory() Возвращает фабрику форм, используемую для создания новых форм.	из FormConfigBuilder
string	getAction() Возвращает целевой URL формы.	из FormConfigBuilder
string	getMethod() Возвращает HTTP-метод, используемый формой.	из FormConfigBuilder

RequestHandlerInterface	getRequestHandler() Возвращает обработчик запроса, используемый формой.	из FormConfigBuilder
bool	getAutoInitialize() Возвращает, следует ли инициализировать форму при создании.	из FormConfigBuilder
array	getOptions() Возвращает все опции, переданные во время создания формы.	из FormConfigBuilder
bool	hasOption(string $name) Возвращает, существует ли определённая опция.	из FormConfigBuilder
mixed	getOption(string $name, mixed $default = null) Возвращает значение определённой опции.	из FormConfigBuilder
FormConfigBuilderInterface	setAttribute(string $name, mixed $value) Устанавливает значение для атрибута.	из FormConfigBuilder
FormConfigBuilderInterface	setAttributes(array $attributes) Устанавливает атрибуты.	из FormConfigBuilder
FormConfigBuilderInterface	setDataMapper(DataMapperInterface $dataMapper = null) Устанавливает маппер данных, используемый формой.	из FormConfigBuilder
FormConfigBuilderInterface	setDisabled(bool $disabled) Устанавливает, отключена ли форма.	из FormConfigBuilder
FormConfigBuilderInterface	setEmptyData(mixed $emptyData) Устанавливает данные, используемые для данных клиента, когда значение не отправлено.	из FormConfigBuilder
FormConfigBuilderInterface	setErrorBubbling(bool $errorBubbling) Устанавливает, будут ли ошибки передаваться вверх родительскому элементу.	из FormConfigBuilder
FormConfigBuilderInterface	setRequired(bool $required) Устанавливает, обязательно ли заполнять это поле при отправке.	из FormConfigBuilder
FormConfigBuilderInterface	setPropertyPath(null\|string\|PropertyPathInterface $propertyPath) Устанавливает путь к свойству, к которому должна быть сопоставлена форма.	из FormConfigBuilder
FormConfigBuilderInterface	setMapped(bool $mapped) Устанавливает, должна ли форма быть сопоставлена с элементом данных родительского элемента.	из FormConfigBuilder
FormConfigBuilderInterface	setByReference(bool $byReference) Устанавливает, должны ли данные формы изменяться по ссылке.	из FormConfigBuilder
FormConfigBuilderInterface	setInheritData(bool $inheritData) Устанавливает, должна ли форма читать и записывать данные родительского элемента.	из FormConfigBuilder
FormConfigBuilderInterface	setCompound(bool $compound) Устанавливает, должна ли форма быть составной.	из FormConfigBuilder
FormConfigBuilderInterface	setType(ResolvedFormTypeInterface $type) Устанавливает типы.	из FormConfigBuilder
FormConfigBuilderInterface	setData(mixed $data) Устанавливает исходные данные формы.	из FormConfigBuilder
FormConfigBuilderInterface	setDataLocked(bool $locked) Заблокировать данные формы, привязанные к данным, переданным в настройках.	из FormConfigBuilder
	setFormFactory(FormFactoryInterface $formFactory) Устанавливает фабрику форм, используемую для создания новых форм.	из FormConfigBuilder
FormConfigBuilderInterface	setAction(string $action) Устанавливает целевой URL формы.	из FormConfigBuilder
FormConfigBuilderInterface	setMethod(string $method) Устанавливает HTTP-метод, используемый формой.	из FormConfigBuilder
FormConfigBuilderInterface	setRequestHandler(RequestHandlerInterface $requestHandler) Устанавливает обработчик запроса, используемый формой.	из FormConfigBuilder
FormConfigBuilderInterface	setAutoInitialize(bool $initialize) Устанавливает, должна ли форма инициализироваться автоматически.	из FormConfigBuilder
FormConfigInterface	getFormConfig() Строит и возвращает конфигурацию формы.
static	validateName(string\|int $name) Проверяет, является ли данная переменная допустимым именем формы.	из FormConfigBuilder
static bool	isValidName(string $name) Возвращает, содержит ли данная переменная допустимое имя формы.	из FormConfigBuilder
$this	add(string\|int\|FormBuilderInterface $child, string\|null $type = null, array $options = array()) Добавляет новое поле в эту группу. Поле должно иметь уникальное имя в группе. В противном случае существующее поле перезаписывается.

FormBuilderInterface	create(string $name, string\|null $type = null, array $options = array()) Создаёт билдер формы.
FormBuilderInterface	get(string $name) Возвращает дочерний элемент по имени.
$this	remove(string $name) Удаляет поле с заданным именем.
bool	has(string $name) Возвращает, существует ли поле с заданным именем.
array	all() Возвращает дочерние элементы.
	count() {@inheritdoc}
FormInterface	getForm() Создаёт форму.
FormBuilderInterface[]	getIterator() {@inheritdoc}

Подробности

__construct(string|int $name, string $dataClass, EventDispatcherInterface $dispatcher, FormFactoryInterface $factory, array $options = array())

Создаёт новый билдер формы.

Параметры

string\|int	$name	Имя формы
string	$dataClass	Класс данных формы
EventDispatcherInterface	$dispatcher	Диспечер событий
FormFactoryInterface	$factory
array	$options	Опции формы

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

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

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 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

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

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

static validateName(string|int $name)

Проверяет, является ли данная переменная допустимым именем формы.

Параметры

string|int

$name

Имя проверяемой формы

Исключения

UnexpectedTypeException	Если имя не является строкой или целым числом.
InvalidArgumentException	Если имя содержит недопустимые символы.

static bool isValidName(string $name)

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

Имя принимается, если:

пустое
начинается с буквы, цифры или подчеркивания
содержит только буквы, цифры, числа, подчеркивания ("_"), дефисы ("-") и двоеточия (":")

Параметры

string

$name

Имя проверяемой формы

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

bool	Является ли имя допустимым

$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	Опции