FormBuilder

__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 getVirtual() ^deprecated

^deprecated

since version 2.3, to be removed in 3.0. Use {@link getInheritData()} instead.

Псевдоним {@link 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

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

setVirtual(bool $inheritData) ^{устаревший}

^{устаревший}

since версия 2.3, будет удалена в 3.0. Используйте {@link setInheritData()} вместо.

Псевдоним {@link setInheritData()}.

Параметры

bool

$inheritData

Должна ли форма наследовать данные родителя

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|FormTypeInterface $type = null, array $options = array())

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

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

Параметры

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

Значение возвращаемого значения

$this

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

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

$this remove(string $name)

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

Параметры

string

$name

Значение возвращаемого значения

$this

bool has(string $name)

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

Параметры

string

$name

Значение возвращаемого значения

bool

array all()

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

Значение возвращаемого значения

array

count()

{@inheritdoc}

FormInterface getForm()

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

Значение возвращаемого значения

FormInterface

Форма

FormBuilderInterface[] getIterator()

{@inheritdoc}

Значение возвращаемого значения

FormBuilderInterface[]