FormConfigBuilder

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

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

Параметры

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

Исключения

InvalidArgumentException

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

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

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

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

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

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

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

FormConfigBuilderInterface setInheritData(bool $inheritData)

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

Параметры

bool

$inheritData

Следует ли форме наследоваться от данных родительской формы

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

FormConfigBuilderInterface

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

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

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

FormConfigInterface getFormConfig()

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

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

FormConfigInterface

static validateName(string|int $name)

Проверяет, является ли данная переменная допустимым именем формы.

Параметры

string|int

$name

Проверяемое имя формы

Исключения

UnexpectedTypeException	Если имя не является строкой или целым числом.
InvalidArgumentException	Если имя содержит недопустимые символы.

static bool isValidName(string $name)

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

Имя принимается, если:

• пустое
• начинается с буквы, цифры или символа подчеркивания
• содержит только буквы, цифры, числа, символы подчеркивания («_»), дефисы («-») и двоеточия (":")

Параметры

string

$name

Проверяемое имя формы

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

bool	Является ли имя допустимым