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(null\|string\|array $submittedData, bool $clearMissing = true) Отправляет данные в форму, преобразует и валидирует их.
FormInterface	getRoot() Возвращает корень дерева формы.
bool	isRoot() Возвращает, является ли поле корнем дерева формы.
FormView	createView(FormView $parent = null) Создаёт представление.

Подробности

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

$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 (но в версии 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(null|string|array $submittedData, bool $clearMissing = true)

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

Параметры

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