SubmitButton
class SubmitButton extends Button implements ClickableInterface
Кнопка, которая отправляет форму.
Методы
| __construct(FormConfigInterface $config) Создаёт новую кнопку из конфигурации формы. | from Button | |
| bool | offsetExists(mixed $offset) Метод не поддерживается. | from Button |
| offsetGet(mixed $offset) Метод не поддерживается. | from Button | |
| offsetSet(mixed $offset, mixed $value) Метод не поддерживается. | from Button | |
| offsetUnset(mixed $offset) Метод не поддерживается. | from Button | |
| FormInterface | setParent(FormInterface $parent = null) Устанавливает родительскую форму. | from Button |
| FormInterface|null | getParent() Возвращает родительскую форму. | from Button |
| FormInterface | add(FormInterface|string|int $child, string|null $type = null, array $options = array()) Метод не поддерживается. | from Button |
| FormInterface | get(string $name) Метод не поддерживается. | from Button |
| bool | has(string $name) Метод не поддерживается. | from Button |
| $this | remove(string $name) Метод не поддерживается. | from Button |
| FormInterface[] | all() Возвращает всех потомков в этой группе. | from Button |
| FormErrorIterator | getErrors(bool $deep = false, bool $flatten = true) Возвращает ошибки этой формы. | from Button |
| $this | setData(mixed $modelData) Метод не поддерживается. | from Button |
| mixed | getData() Метод не поддерживается. | from Button |
| mixed | getNormData() Метод не поддерживается. | from Button |
| mixed | getViewData() Метод не поддерживается. | from Button |
| array | getExtraData() Метод не поддерживается. | from Button |
| FormConfigInterface | getConfig() Возвращает конфигурацию кнопки. | from Button |
| bool | isSubmitted() Возвращает, отправлена ли кнопка. | from Button |
| string | getName() Возвращает имя, по которому кнопка идентифицируется в формах. | from Button |
| PropertyPathInterface|null | getPropertyPath() Метод не поддерживается. | from Button |
| $this | addError(FormError $error) Метод не поддерживается. | from Button |
| bool | isValid() Метод не поддерживается. | from Button |
| bool | isRequired() Метод не поддерживается. | from Button |
| bool | isDisabled() Возвращает, отключена ли эта форма. | from Button |
| bool | isEmpty() Метод не поддерживается. | from Button |
| bool | isSynchronized() Метод не поддерживается. | from Button |
| TransformationFailedException|null | getTransformationFailure() Метод не поддерживается. | from Button |
| $this | initialize() Метод не поддерживается. | from Button |
| $this | handleRequest(mixed $request = null) Метод не поддерживается. | from Button |
| $this | submit(mixed $submittedData, bool $clearMissing = true) Отправляет данные на кнопку. | |
| FormInterface | getRoot() Возвращает корень дерева формы. | from Button |
| bool | isRoot() Возвращает, является ли поле корнем дерева формы. | from Button |
| FormView | createView(FormView $parent = null) Создаёт представление. | from Button |
| int | count() Метод не поддерживается. | from Button |
| EmptyIterator | getIterator() Метод не поддерживается. | from Button |
| bool | isClicked() Возвращает, был ли этот элемент нажат. |
Подробности
__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 |
Возвращаемое значение
| 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 |
$this remove(string $name)
Метод не поддерживается.
Этот метод вызывать не следует.
Параметры
| string | $name | Имя дочернего элемента для удаления |
Возвращаемое значение
| $this |
Исключения
| BadMethodCallException |
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 |
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 |
Исключения
| BadMethodCallException |
bool isValid()
Метод не поддерживается.
Значение возврата
| bool |
bool isRequired()
Метод не поддерживается.
Значение возврата
| bool |
bool isDisabled()
Возвращает, отключена ли эта форма.
Содержимое отключенной формы отображается, но не может быть изменено. Валидация изменённых отключенных форм должна завершиться неудачей.
Формы, родителями которых являются отключённые формы, считаются отключёнными независимо от их собственного состояния.
Значение возврата
| bool |
bool isEmpty()
Метод не поддерживается.
Значение возврата
| bool |
bool isSynchronized()
Метод не поддерживается.
Значение возврата
| bool |
TransformationFailedException|null getTransformationFailure()
Метод не поддерживается.
Значение возврата
| TransformationFailedException|null | Ошибка преобразования |
$this initialize()
Метод не поддерживается.
Значение возврата
| $this |
Исключения
| BadMethodCallException |
$this handleRequest(mixed $request = null)
Метод не поддерживается.
Параметры
| mixed | $request | Обрабатываемый запрос |
Значение возврата
| $this |
Исключения
| BadMethodCallException |
$this submit(mixed $submittedData, bool $clearMissing = true)
Отправляет данные на кнопку.
Параметры
| mixed | $submittedData | Отправленные данные |
| bool | $clearMissing | Устанавливать поля в NULL, если они отсутствуют в данных, отправленных на обработку |
Значение возврата
| $this |
Исключения
| AlreadySubmittedException | если форма уже была отправлена |
FormInterface getRoot()
Возвращает корень дерева форм.
Значение возврата
| FormInterface | Корень дерева |
bool isRoot()
Возвращает, является ли поле корнем дерева форм.
Значение возврата
| bool |
FormView createView(FormView $parent = null)
Создаёт представление.
Параметры
| FormView | $parent |
Значение возврата
| FormView | Представление |
int count()
Метод не поддерживается.
Значение возврата
| int | Всегда возвращает 0 |
EmptyIterator getIterator()
Метод не поддерживается.
Значение возврата
| EmptyIterator | Всегда возвращает пустой итератор |
bool isClicked()
Возвращает, был ли этот элемент нажат.
Значение возврата
| bool | Был ли этот элемент нажат |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Form/SubmitButton.html
