FormInterface

интерфейс FormInterface реализует ArrayAccess, Traversable, Countable

Группа форм, объединяющая несколько форм в иерархической структуре.

Методы

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

Детали

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

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

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

PropertyPathInterface

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

$this addError(FormError $error)

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

Параметры

FormError

$error

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

$this

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

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

$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, если они отсутствуют в отправленных данных