Кнопка
класс Кнопка реализует 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(mixed $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 |
Возвращаемое значение
| 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(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 | Всегда возвращает пустой итератор |
© 2004–2017 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/Form/Button.html