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