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

Начальные данные формы

null|string getDataClass()

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

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

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

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

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

$this

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

FormConfigInterface getFormConfig()

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

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

FormConfigInterface