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