Кнопка
класс Кнопка реализует 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) Метод не поддерживается. | |
| $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) Метод не поддерживается. | |
| $this | 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 |
$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 getPropertyPath()
Метод не поддерживается.
Возвращаемое значение
| PropertyPathInterface | Путь к свойству |
$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(null|string|array $submittedData, bool $clearMissing = true)
Отправляет данные на кнопку.
Параметры
| null|string|array | $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 | Всегда возвращает пустой итератор |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.1/Symfony/Component/Form/Button.html