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
FormInterface	remove(string $name) Удаляет дочернюю форму.	из FormInterface
FormInterface[]	all() Возвращает все дочерние формы в этой группе.	из FormInterface
FormErrorIterator	getErrors(bool $deep = false, bool $flatten = true) Возвращает ошибки этой формы.	из FormInterface
FormInterface	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	getPropertyPath() Возвращает путь к свойству, к которому сопоставлена форма.	из FormInterface
FormInterface	addError(FormError $error) Добавляет ошибку в эту форму.	из FormInterface
bool	isValid() Возвращает, является ли форма и все дочерние элементы валидными.	из FormInterface
bool	isRequired() Возвращает, требуется ли заполнить форму.	из FormInterface
bool	isDisabled() Возвращает, отключена ли эта форма.	из FormInterface
bool	isEmpty() Возвращает, пуста ли форма.	из FormInterface
bool	isSynchronized() Возвращает, синхронизированы ли данные в разных форматах.	из FormInterface
TransformationFailedException\|null	getTransformationFailure() Возвращает ошибку преобразования данных, если она есть.	из FormInterface
FormInterface	initialize() Инициализирует дерево формы.	из FormInterface
FormInterface	handleRequest(mixed $request = null) Проверяет заданный запрос и вызывает {@link submit()}, если форма была отправлена.	из FormInterface
FormInterface	submit(null\|string\|array $submittedData, bool $clearMissing = true) Отправляет данные в форму, преобразует и проверяет их.	из FormInterface
FormInterface	getRoot() Возвращает корень дерева формы.	из FormInterface
bool	isRoot() Возвращает, является ли поле корнем дерева формы.	из FormInterface
FormView	createView(FormView $parent = null) Создаёт представление.	из FormInterface

Подробности

FormInterface setParent(FormInterface $parent = null)

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

Параметры

FormInterface

$parent

Родительская форма или null, если это корневая форма.

Возвращаемое значение

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

FormInterface remove(string $name)

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

Параметры

string

$name

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

Возвращаемое значение

FormInterface

Экземпляр формы

Исключения

AlreadySubmittedException

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

FormInterface[] all()

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

Возвращаемое значение

FormInterface[]

Массив экземпляров FormInterface

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

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

Параметры

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

Возвращаемое значение

FormErrorIterator

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

FormInterface setData(mixed $modelData)

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

Параметры

mixed

$modelData

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

Возвращаемое значение

FormInterface

Экземпляр формы

Исключения

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

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

FormInterface addError(FormError $error)

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

Параметры

FormError

$error

Возвращаемое значение

FormInterface

Экземпляр формы

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

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

FormInterface initialize()

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

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

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

FormInterface

Экземпляр формы.

FormInterface handleRequest(mixed $request = null)

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

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

Параметры

mixed

$request

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

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

FormInterface

Экземпляр формы.

FormInterface submit(null|string|array $submittedData, bool $clearMissing = true)

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

Параметры

null\|string\|array	$submittedData	Отправленные данные.
bool	$clearMissing	Устанавливать ли поля в NULL, если они отсутствуют в данных.