FormBuilder

__construct(string|int $name, string|null $dataClass, EventDispatcherInterface $dispatcher, FormFactoryInterface $factory, array $options = array())

Создаёт пустую конфигурацию формы.

Параметры

string|int	$name	Имя формы
string|null	$dataClass	Класс данных формы
EventDispatcherInterface	$dispatcher	Диспечер событий
FormFactoryInterface	$factory
array	$options	Опции формы

Исключения

InvalidArgumentException

если класс данных не является допустимым классом или имя содержит недопустимые символы

$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

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

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 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

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

$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

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|null $type = null, array $options = array())

Добавляет новое поле в эту группу. Поле должно иметь уникальное имя в группе. В противном случае существующее поле перезаписывается.

Если вы добавляете вложенную группу, эта группа также должна быть представлена в иерархии объектов.

Параметры

string|int|FormBuilderInterface	$child
string|null	$type
array	$options

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

FormBuilderInterface

FormBuilderInterface create(string $name, string|null $type = null, array $options = array())

Создаёт билдер формы.

Параметры

string	$name	Имя формы или имя свойства
string|null	$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}

FormInterface getForm()

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

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

FormInterface

Форма

FormBuilderInterface[] getIterator()

{@inheritdoc}

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

FormBuilderInterface[]