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

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

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

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

Параметры

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(null|string|PropertyPathInterface $propertyPath)

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

Параметры

null|string|PropertyPathInterface

$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