FormConfigBuilder

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

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

Параметры

string|int	$name	Имя формы
string|null	$dataClass	Класс данных формы
EventDispatcherInterface	$dispatcher	Диспетчер событий
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	Является ли имя допустимым