FormConfigBuilder

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

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

Параметры

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

Исключения

InvalidArgumentException

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

$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

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

EventDispatcherInterface getEventDispatcher()

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

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

EventDispatcherInterface

Диспечер

string getName()

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

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

string

Имя формы

null|PropertyPathInterface getPropertyPath()

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

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

null|PropertyPathInterface

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

bool getMapped()

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

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

bool	Привязана ли форма

bool getByReference()

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

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

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

bool getInheritData()

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

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

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

bool getVirtual() ^deprecated

^deprecated

since version 2.3, to be removed in 3.0. Use {@link getInheritData()} instead.

Псевдоним для {@link 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 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

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

setVirtual(bool $inheritData) ^{устаревшее}

^{устаревшее}

since версия 2.3, будет удалено в 3.0. Используйте {@link setInheritData()} вместо этого.

Псевдоним для {@link setInheritData()}.

Параметры

bool

$inheritData

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

$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

Истина для автоматической инициализации формы, ложь для предотвращения автоматической инициализации. В последнем случае необходимо вручную вызвать {@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	Является ли имя допустимым