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

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

Если форма не отправлена, этот метод всегда возвращает false (но в версии 4.0 будет выброшено исключение).

Значение результата

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