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