FormInterface

интерфейс FormInterface реализует Iterator, FormInterface

Методы

FormInterface	setParent(FormInterface $parent = null) Устанавливает родительскую форму.	from FormInterface
FormInterface\|null	getParent() Возвращает родительскую форму.	from FormInterface
FormInterface	add(FormInterface\|string\|int $child, string\|null $type = null, array $options = array()) Добавляет или заменяет дочернюю форму.	from FormInterface
FormInterface	get(string $name) Возвращает дочернюю форму с заданным именем.	from FormInterface
bool	has(string $name) Возвращает, существует ли дочерняя форма с заданным именем.	from FormInterface
FormInterface	remove(string $name) Удаляет дочернюю форму из формы.	from FormInterface
FormInterface[]	all() Возвращает все дочерние формы в этой группе.	from FormInterface
FormErrorIterator	getErrors(bool $deep = false, bool $flatten = true) Возвращает ошибки этой формы.	from FormInterface
FormInterface	setData(mixed $modelData) Обновляет форму данными по умолчанию.	from FormInterface
mixed	getData() Возвращает данные в формате, необходимом для базового объекта.	from FormInterface
mixed	getNormData() Возвращает нормализованные данные поля.	from FormInterface
mixed	getViewData() Возвращает данные, преобразованные преобразователем значений.	from FormInterface
array	getExtraData() Возвращает дополнительные данные.	from FormInterface
FormConfigInterface	getConfig() Возвращает конфигурацию формы.	from FormInterface
bool	isSubmitted() Возвращает, была ли форма отправлена.	from FormInterface
string	getName() Возвращает имя, по которому форма идентифицируется в формах.	from FormInterface
PropertyPathInterface	getPropertyPath() Возвращает путь к свойству, к которому привязана форма.	from FormInterface
FormInterface	addError(FormError $error) Добавляет ошибку в эту форму.	from FormInterface
bool	isValid() Возвращает, является ли форма и все дочерние формы валидными.	from FormInterface
bool	isRequired() Возвращает, является ли форма обязательной для заполнения.	from FormInterface
bool	isDisabled() Возвращает, отключена ли эта форма.	from FormInterface
bool	isEmpty() Возвращает, пуста ли форма.	from FormInterface
bool	isSynchronized() Возвращает, синхронизированы ли данные в различных форматах.	from FormInterface
TransformationFailedException\|null	getTransformationFailure() Возвращает ошибку преобразования данных, если она есть.	from FormInterface
FormInterface	initialize() Инициализирует дерево форм.	from FormInterface
FormInterface	handleRequest(mixed $request = null) Проверяет переданный запрос и вызывает {@link submit()}, если форма была отправлена.	from FormInterface
FormInterface	submit(null\|string\|array $submittedData, bool $clearMissing = true) Отправляет данные в форму, преобразует и проверяет их.	from FormInterface
FormInterface	getRoot() Возвращает корень дерева форм.	from FormInterface
bool	isRoot() Возвращает, является ли поле корнем дерева форм.	from FormInterface
FormView	createView(FormView $parent = null) Создает представление.	from FormInterface

Подробности

FormInterface setParent(FormInterface $parent = null)

Устанавливает родительскую форму.

Параметры

FormInterface

$parent

Родительская форма или null, если это корневая форма.

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

FormInterface

Экземпляр формы

Исключения

AlreadySubmittedException	Если форма уже была отправлена.
LogicException	При попытке установить родителя для формы с пустым именем.

FormInterface|null getParent()

Возвращает родительскую форму.

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

FormInterface|null

Родительская форма или null, если её нет.

FormInterface add(FormInterface|string|int $child, string|null $type = null, array $options = array())

Добавляет или заменяет дочернюю форму.

Параметры

FormInterface\|string\|int	$child	Экземпляр FormInterface или имя дочернего элемента.
string\|null	$type	Тип дочернего элемента, если было передано имя.
array	$options	Опции дочернего элемента, если было передано имя.

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

FormInterface

Экземпляр формы

Исключения

AlreadySubmittedException	Если форма уже была отправлена.
LogicException	При попытке добавить дочерний элемент к форме, которая не является составной.
UnexpectedTypeException	Если $child или $type имеют неверный тип.

FormInterface get(string $name)

Возвращает дочерний элемент с заданным именем.

Параметры

string

$name

Имя дочернего элемента

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

FormInterface

Дочерняя форма

Исключения

OutOfBoundsException

Если дочерний элемент с заданным именем не найден.

bool has(string $name)

Возвращает, существует ли дочерний элемент с заданным именем.

Параметры

string

$name

Имя дочернего элемента

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

bool

FormInterface remove(string $name)

Удаляет дочерний элемент из формы.

Параметры

string

$name

Имя дочернего элемента для удаления

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

FormInterface

Экземпляр формы

Исключения

AlreadySubmittedException

Если форма уже была отправлена.

FormInterface[] all()

Возвращает все дочерние элементы в этой группе.

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

FormInterface[]

Массив экземпляров FormInterface

FormErrorIterator getErrors(bool $deep = false, bool $flatten = true)

Возвращает ошибки этой формы.

Параметры

bool	$deep	Включать ли ошибки дочерних форм
bool	$flatten	Сглаживать ли список ошибок, если $deep установлен в true

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

FormErrorIterator

Итератор по экземплярам {@link FormError}, которые были добавлены в эту форму

FormInterface setData(mixed $modelData)

Обновляет форму данными по умолчанию.

Параметры

mixed

$modelData

Данные в формате, ожидаемом базовым объектом

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

FormInterface

Экземпляр формы

Исключения

AlreadySubmittedException	Если форма уже была отправлена.
LogicException	Если обработчики пытаются вызвать setData в цикле. Или если данные представления не соответствуют ожидаемому типу в соответствии с {@link FormConfigInterface::getDataClass}.

mixed getData()

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

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

mixed

mixed getNormData()

Возвращает нормализованные данные поля.

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

mixed

Если поле не отправлено, возвращаются данные по умолчанию. Если поле отправлено, возвращаются нормализованные отправленные данные, если поле валидно, в противном случае null.

mixed getViewData()

Возвращает данные, преобразованные трансформатором значений.

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

mixed

array getExtraData()

Возвращает дополнительные данные.

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

array

Отправленные данные, которые не относятся к дочернему элементу

FormConfigInterface getConfig()

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

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

FormConfigInterface

Конфигурация.

bool isSubmitted()

Возвращает, отправлена ли форма.

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

bool	true, если форма отправлена, false в противном случае

string getName()

Возвращает имя, по которому форма идентифицируется в формах.

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

string

Имя формы.

PropertyPathInterface getPropertyPath()

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

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

PropertyPathInterface

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

FormInterface addError(FormError $error)

Добавляет ошибку в эту форму.

Параметры

FormError

$error

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

FormInterface

Экземпляр формы

bool isValid()

Возвращает, валидна ли форма и все дочерние элементы.

Если форма не отправлена, этот метод всегда возвращает false.

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

bool

bool isRequired()

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

Если у формы есть родитель, и родитель не обязателен, этот метод всегда вернёт false. В противном случае возвращается значение, установленное с помощью setRequired().

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

bool

bool isDisabled()

Возвращает, отключена ли эта форма.

Содержимое отключённой формы отображается, но не допускается изменение. Валидация изменённых отключённых форм должна завершиться ошибкой.

Формы, родительские элементы которых отключены, считаются отключёнными независимо от собственного состояния.

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

bool

bool isEmpty()

Возвращает, пуста ли форма.

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

bool

bool isSynchronized()

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

Если данные не синхронизированы, вы можете получить ошибку преобразования, вызвав {@link getTransformationFailure()}.

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

bool

TransformationFailedException|null getTransformationFailure()

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

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

TransformationFailedException|null

Ошибка преобразования

FormInterface initialize()

Инициализирует дерево формы.

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

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

FormInterface

Экземпляр формы.

FormInterface handleRequest(mixed $request = null)

Проверяет переданный запрос и вызывает {@link submit()}, если форма была отправлена.

Внутренне запрос передаётся конфигурированному экземпляру {@link RequestHandlerInterface}, который определяет, нужно ли отправлять форму.

Параметры

mixed

$request

Обрабатываемый запрос.

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

FormInterface

Экземпляр формы.

FormInterface submit(null|string|array $submittedData, bool $clearMissing = true)

Отправляет данные на форму, преобразует и валидирует их.

Параметры

null\|string\|array	$submittedData	Отправленные данные.
bool	$clearMissing	Устанавливать ли поля в NULL, если они отсутствуют в данных.