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	Должна ли форма наследовать данные родителя.

FormConfigBuilder getVirtual() ^{устарело}

^{устарело}

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

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

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

FormConfigBuilder

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

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

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

FormConfigBuilder setVirtual(bool $inheritData) ^deprecated

^deprecated

since version 2.3, to be removed in 3.0. Use {@link setInheritData()} вместо.

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

Параметры

bool

$inheritData

Должна ли форма унаследовать данные родительской формы.

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

FormConfigBuilder

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

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	Является ли имя допустимым.

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)

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

Параметры

string

$name

Значение результата

bool

array all()

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

Значение результата

array

count()

{@inheritdoc}

Form getForm()

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

Значение результата

Form

Форма

getIterator()

{@inheritdoc}