Кнопка

класс Кнопка реализует IteratorAggregate, FormInterface

Кнопка формы.

Методы

	__construct(FormConfigInterface $config) Создаёт новую кнопку на основе конфигурации формы.
bool	offsetExists(mixed $offset) Неподдерживаемый метод.
	offsetGet(mixed $offset) Неподдерживаемый метод.
	offsetSet(mixed $offset, mixed $value) Неподдерживаемый метод.
	offsetUnset(mixed $offset) Неподдерживаемый метод.
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) Неподдерживаемый метод.
FormInterface	remove(string $name) Неподдерживаемый метод.
FormInterface[]	all() Возвращает всех дочерних элементов в этой группе.
FormErrorIterator	getErrors(bool $deep = false, bool $flatten = true) Возвращает ошибки этой формы.
FormInterface	setData(mixed $modelData) Неподдерживаемый метод.
mixed	getData() Неподдерживаемый метод.
mixed	getNormData() Неподдерживаемый метод.
mixed	getViewData() Неподдерживаемый метод.
array	getExtraData() Неподдерживаемый метод.
FormConfigInterface	getConfig() Возвращает конфигурацию кнопки.
bool	isSubmitted() Возвращает, отправлена ли кнопка.
string	getName() Возвращает имя, по которому кнопка идентифицируется в формах.
PropertyPathInterface	getPropertyPath() Неподдерживаемый метод.
FormInterface	addError(FormError $error) Неподдерживаемый метод.
bool	isValid() Неподдерживаемый метод.
bool	isRequired() Неподдерживаемый метод.
bool	isDisabled() Возвращает, отключена ли эта форма.
bool	isEmpty() Неподдерживаемый метод.
bool	isSynchronized() Неподдерживаемый метод.
TransformationFailedException\|null	getTransformationFailure() Неподдерживаемый метод.
FormInterface	initialize() Неподдерживаемый метод.
FormInterface	handleRequest(mixed $request = null) Неподдерживаемый метод.
FormInterface	submit(null\|string\|array $submittedData, bool $clearMissing = true) Отправляет данные в кнопку.
FormInterface	getRoot() Возвращает корень дерева формы.
bool	isRoot() Возвращает, является ли поле корнем дерева формы.
FormView	createView(FormView $parent = null) Создаёт представление.
int	count() Неподдерживаемый метод.
EmptyIterator	getIterator() Неподдерживаемый метод.

Подробности

__construct(FormConfigInterface $config)

Создаёт новую кнопку на основе конфигурации формы.

Параметры

FormConfigInterface

$config

Конфигурация кнопки.

bool offsetExists(mixed $offset)

Метод не поддерживается.

Параметры

mixed

$offset

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

bool	Всегда возвращает false.

offsetGet(mixed $offset)

Метод не поддерживается.

Этот метод вызывать не следует.

Параметры

mixed

$offset

Исключения

BadMethodCallException

offsetSet(mixed $offset, mixed $value)

Метод не поддерживается.

Этот метод вызывать не следует.

Параметры

mixed	$offset
mixed	$value

Исключения

BadMethodCallException

offsetUnset(mixed $offset)

Метод не поддерживается.

Этот метод вызывать не следует.

Параметры

mixed

$offset

Исключения

BadMethodCallException

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

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

Исключения

BadMethodCallException

FormInterface get(string $name)

Метод не поддерживается.

Этот метод вызывать не следует.

Параметры

string

$name

Имя дочернего элемента

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

FormInterface

Дочерняя форма

Исключения

BadMethodCallException

bool has(string $name)

Метод не поддерживается.

Параметры

string

$name

Имя дочернего элемента

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

bool

FormInterface remove(string $name)

Метод не поддерживается.

Этот метод вызывать не следует.

Параметры

string

$name

Имя дочернего элемента для удаления

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

FormInterface

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

Исключения

BadMethodCallException

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

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

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

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

Исключения

BadMethodCallException

bool isValid()

Неподдерживаемый метод.

Значение возвращаемого значения

bool

bool isRequired()

Неподдерживаемый метод.

Значение возвращаемого значения

bool

bool isDisabled()

Возвращает, отключена ли эта форма.

Содержимое отключенной формы отображается, но не может быть изменено. Валидация изменённых отключенных форм должна завершиться ошибкой.

Формы, родительские элементы которых отключены, считаются отключёнными независимо от собственного состояния.

Значение возвращаемого значения

bool

bool isEmpty()

Неподдерживаемый метод.

Значение возвращаемого значения

bool

bool isSynchronized()

Неподдерживаемый метод.

Значение возвращаемого значения

bool

TransformationFailedException|null getTransformationFailure()

Неподдерживаемый метод.

Значение возвращаемого значения

TransformationFailedException|null

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

FormInterface initialize()

Неподдерживаемый метод.

Значение возвращаемого значения

FormInterface

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

Исключения

BadMethodCallException

FormInterface handleRequest(mixed $request = null)

Неподдерживаемый метод.

Параметры

mixed

$request

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

Значение возвращаемого значения

FormInterface

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

Исключения

BadMethodCallException

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

Отправляет данные на кнопку.

Параметры

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