FormConfigBuilderInterface

EventDispatcherInterface getEventDispatcher()

Возвращает диспетчер событий, используемый для отправки событий формы.

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

EventDispatcherInterface

Диспетчер

string getName()

Возвращает имя формы, используемое в качестве параметра HTTP.

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

string

Имя формы

PropertyPathInterface|null getPropertyPath()

Возвращает путь к свойству, к которому должна быть сопоставлена форма.

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

PropertyPathInterface|null

Путь к свойству

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|null getDataMapper()

Возвращает маппер данных формы.

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

DataMapperInterface|null

Маппер данных

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|null getDataClass()

Возвращает класс данных формы или null, если данные являются скалярными или массивом.

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

string|null

Класс данных или 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

Значение параметра

$this addEventListener(string $eventName, callable $listener, int $priority = 0)

Добавляет обработчик событий для события в этой форме.

Параметры

string	$eventName	Название события, на которое нужно отслеживать
callable	$listener	Обработчик, который необходимо выполнить
int	$priority	Приоритет обработчика. Обработчики с более высоким приоритетом вызываются до обработчиков с более низким приоритетом.

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

$this

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

$this addEventSubscriber(EventSubscriberInterface $subscriber)

Добавляет обработчик событий для событий в этой форме.

Параметры

EventSubscriberInterface

$subscriber

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

$this

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

$this addViewTransformer(DataTransformerInterface $viewTransformer, bool $forcePrepend = false)

Добавляет/вставляет преобразователь в цепочку преобразователей представления.

Метод transform преобразователя используется для преобразования данных из нормализованного формата в формат представления. Метод reverseTransform преобразователя используется для преобразования из формата представления в нормализованный формат.

Параметры

DataTransformerInterface	$viewTransformer
bool	$forcePrepend	Если установлено в true, вставка вместо добавления

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

$this

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

$this resetViewTransformers()

Очищает преобразователи представления.

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

$this

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

$this addModelTransformer(DataTransformerInterface $modelTransformer, bool $forceAppend = false)

Вставляет/добавляет преобразователь в цепочку преобразователей нормализации.

Метод transform преобразователя используется для преобразования данных из модели в нормализованный формат. Метод reverseTransform преобразователя используется для преобразования из нормализованного формата в формат модели.

Параметры

DataTransformerInterface	$modelTransformer
bool	$forceAppend	Если установлено в true, добавление вместо вставки

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

$this

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

$this resetModelTransformers()

Очищает преобразователи нормализации.

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

$this

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

$this setAttribute(string $name, mixed $value)

Устанавливает значение для атрибута.

Параметры

string	$name	Имя атрибута
mixed	$value	Значение атрибута

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

$this

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

$this setAttributes(array $attributes)

Устанавливает атрибуты.

Параметры

array

$attributes

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

$this

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

$this setDataMapper(DataMapperInterface $dataMapper = null)

Устанавливает используемый маппер данных формы.

Параметры

DataMapperInterface

$dataMapper

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

$this

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

$this setDisabled(bool $disabled)

Устанавливает, отключена ли форма.

Параметры

bool

$disabled

Отключена ли форма

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

$this

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

$this setEmptyData(mixed $emptyData)

Устанавливает данные, используемые для данных клиента, когда не передано значение.

Параметры

mixed

$emptyData

Пустые данные

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

$this

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

$this setErrorBubbling(bool $errorBubbling)

Устанавливает, могут ли ошибки передаваться вверх родительскому элементу.

Параметры

bool

$errorBubbling

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

$this

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

$this setRequired(bool $required)

Устанавливает, обязательно ли это поле для заполнения при отправке.

Параметры

bool

$required

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

$this

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

$this setPropertyPath(string|PropertyPathInterface|null $propertyPath)

Устанавливает путь к свойству, к которому должна быть привязана форма.

Параметры

string|PropertyPathInterface|null

$propertyPath

Путь к свойству или null, если путь должен быть установлен автоматически на основе имени формы

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

$this

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

$this setMapped(bool $mapped)

Устанавливает, должна ли форма быть привязана к элементу данных родительского элемента.

Параметры

bool

$mapped

Должна ли форма быть привязана

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

$this

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

$this setByReference(bool $byReference)

Устанавливает, должны ли данные формы изменяться по ссылке.

Параметры

bool

$byReference

Изменять ли данные по ссылке

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

$this

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

$this setInheritData(bool $inheritData)

Устанавливает, должна ли форма считывать и записывать данные своего родительского элемента.

Параметры

bool

$inheritData

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

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

$this

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

$this setCompound(bool $compound)

Устанавливает, должна ли форма быть составной.

Параметры

bool

$compound

Должна ли форма быть составной

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

$this

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

См. также

FormConfigInterface::getCompound

$this setType(ResolvedFormTypeInterface $type)

Установить типы.

Параметры

ResolvedFormTypeInterface

$type

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

$this

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

$this setData(mixed $data)

Устанавливает начальные данные формы.

Параметры

mixed

$data

Данные формы в формате приложения

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

$this

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

$this setDataLocked(bool $locked)

Заблокировать данные формы по данным, переданным в конфигурации.

Форма с заблокированными данными ограничена данными, переданными в этой конфигурации. Данные можно изменять только при отправке формы.

Параметры

bool

$locked

Заблокировать ли значения по умолчанию

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

$this

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

setFormFactory(FormFactoryInterface $formFactory)

Устанавливает фабрику форм, используемую для создания новых форм.

Параметры

FormFactoryInterface

$formFactory

$this setAction(string $action)

Устанавливает целевой URL формы.

Параметры

string

$action

Целевой URL формы

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

$this

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

$this setMethod(string $method)

Устанавливает HTTP-метод, используемый формой.

Параметры

string

$method

HTTP-метод формы

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

$this

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

$this setRequestHandler(RequestHandlerInterface $requestHandler)

Устанавливает обработчик запросов, используемый формой.

Параметры

RequestHandlerInterface

$requestHandler

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

$this

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

$this setAutoInitialize(bool $initialize)

Устанавливает, следует ли автоматически инициализировать форму.

Должно быть установлено в значение true только для корневых форм.

Параметры

bool

$initialize

Истина, если форму нужно инициализировать автоматически, ложь — для подавления автоматической инициализации. В последнем случае вам нужно вручную вызвать {@link FormInterface::initialize()}.

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

$this

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

FormConfigInterface getFormConfig()

Создаёт и возвращает конфигурацию формы.

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

FormConfigInterface