FormBuilder

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

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

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