SubmitButtonBuilder

__construct(string $name, array $options = array())

Создаёт новый билдер кнопки.

Параметры

string	$name	Имя кнопки.
array	$options	Опции кнопки.

Исключения

InvalidArgumentException

Если имя пустое.

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

Form getForm()

Создаёт кнопку.

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

Form

Форма

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

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

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

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

setVirtual(bool $virtual)

Неподдерживаемый метод.

Этот метод вызывать не следует.

Параметры

bool

$virtual

Исключения

BadMethodCallException

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

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

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

FormConfigBuilderInterface

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

FormConfigBuilderInterface setInheritData(bool $inheritData)

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

Параметры

bool

$inheritData

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

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

FormConfigBuilderInterface

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

FormConfigInterface getFormConfig()

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

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

FormConfigInterface

EventDispatcherInterface getEventDispatcher()

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

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

EventDispatcherInterface

Диспетчер.

string getName()

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

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

string

Имя формы.

null|PropertyPathInterface getPropertyPath()

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

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

null|PropertyPathInterface

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

bool getMapped()

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

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

bool	Булево значение отображения формы.

bool getByReference()

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

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

bool	Изменять данные формы по ссылке.

bool getVirtual()

Метод не поддерживается.

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

bool	Всегда возвращает false.

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 в противном случае.

bool getInheritData()

Возвращает, должна ли форма читать и записывать данные своего родителя.

Результат

bool	Нужно ли форме унаследовать данные родителя.

array getOptions()

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

Результат

array

Переданные опции.

bool hasOption(string $name)

Возвращает, существует ли определённая опция.

Параметры

string

$name

Имя опции,

Результат

bool	Существует ли опция.

mixed getOption(string $name, mixed $default = null)

Возвращает значение определённой опции.

Параметры

string	$name	Имя опции.
mixed	$default	Значение, возвращаемое, если опция не существует.

Результат

mixed

Значение опции.

int count()

Метод не поддерживается.

Результат

int	Всегда возвращает 0.

EmptyIterator getIterator()

Метод не поддерживается.

Результат

EmptyIterator

Всегда возвращает пустой итератор.