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

Начальные данные формы

null|string getDataClass()

Возвращает класс данных формы или null, если данные являются скалярными или массивом.

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

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

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

$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	Является ли имя допустимым