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)

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

Параметры

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

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

FormInterface

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

Исключения

AlreadySubmittedException

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

FormInterface getRoot()

Возвращает корень дерева формы.

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

FormInterface

Корень дерева

bool isRoot()

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

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

bool

FormView createView(FormView $parent = null)

Создаёт представление.

Параметры

FormView

$parent

Родительское представление

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

FormView

Представление