FormInterface

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

Методы

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

Подробности

FormInterface setParent(FormInterface $parent = null)

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

Параметры

FormInterface

$parent

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

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

$this remove(string $name)

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

Параметры

string

$name

Имя дочерней формы для удаления

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

$this

Исключения

AlreadySubmittedException

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

FormInterface[] all()

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

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

FormInterface[]

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

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

Параметры

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

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

FormErrorIterator

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

$this setData(mixed $modelData)

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

Параметры

mixed

$modelData

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

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

$this

Исключения

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|null getPropertyPath()

Возвращает путь к свойству, к которому сопоставлена форма.

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

PropertyPathInterface|null

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

$this addError(FormError $error)

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

Параметры

FormError

$error

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

$this

bool isValid()

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

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

bool

Исключения

LogicException

если форма не отправлена

bool isRequired()

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

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

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

bool

bool isDisabled()

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

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

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

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

bool

bool isEmpty()

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

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

bool

bool isSynchronized()

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

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

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

bool

TransformationFailedException|null getTransformationFailure()

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

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

TransformationFailedException|null

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

$this initialize()

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

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

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

$this

$this handleRequest(mixed $request = null)

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

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

Параметры

mixed

$request

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

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

$this

$this submit(mixed $submittedData, bool $clearMissing = true)

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

Параметры

mixed	$submittedData	Отправленные данные
bool	$clearMissing	Установить поля в NULL, если они отсутствуют в отправленных данных