Spec-Zone.ru › Symfony 4.1

ButtonBuilder

class ButtonBuilder implements IteratorAggregate, FormBuilderInterface

A builder for {@link Button} instances.

Свойства

protected bool $locked

Методы

__construct(string|null $name, array $options = array())
FormBuilderInterface add(string|int|FormBuilderInterface $child, string|null $type = null, array $options = array())

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

FormBuilderInterface create(string $name, string|null $type = null, array $options = array())

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

FormBuilderInterface get(string $name)

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

FormBuilderInterface remove(string $name)

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

bool has(string $name)

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

array all()

Возвращает дочерние элементы.

FormInterface getForm()

Создаёт кнопку.

$this addEventListener(string $eventName, callable $listener, int $priority = 0)

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

$this addEventSubscriber(EventSubscriberInterface $subscriber)

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

$this addViewTransformer(DataTransformerInterface $viewTransformer, bool $forcePrepend = false)

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

$this resetViewTransformers()

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

$this addModelTransformer(DataTransformerInterface $modelTransformer, bool $forceAppend = false)

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

$this resetModelTransformers()

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

$this setAttribute(string $name, mixed $value)

Устанавливает значение для атрибута.

$this setAttributes(array $attributes)

Устанавливает атрибуты.

$this setDataMapper(DataMapperInterface $dataMapper = null)

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

$this setDisabled(bool $disabled)

Устанавливает, отключена ли кнопка.

$this setEmptyData(mixed $emptyData)

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

$this setErrorBubbling(bool $errorBubbling)

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

$this setRequired(bool $required)

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

$this setPropertyPath(string|PropertyPathInterface|null $propertyPath)

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

$this setMapped(bool $mapped)

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

$this setByReference(bool $byReference)

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

$this setCompound(bool $compound)

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

$this setType(ResolvedFormTypeInterface $type)

Устанавливает тип кнопки.

$this setData(mixed $data)

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

$this setDataLocked(bool $locked)

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

setFormFactory(FormFactoryInterface $formFactory)

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

$this setAction(string $action)

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

$this setMethod(string $method)

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

$this setRequestHandler(RequestHandlerInterface $requestHandler)

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

$this setAutoInitialize(bool $initialize)

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

$this setInheritData(bool $inheritData)

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

FormConfigInterface getFormConfig()

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

EventDispatcherInterface getEventDispatcher()

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

string getName()

Возвращает имя формы, используемое в качестве HTTP параметра.

PropertyPathInterface|null getPropertyPath()

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

bool getMapped()

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

bool getByReference()

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

bool getCompound()

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

ResolvedFormTypeInterface getType()

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

DataTransformerInterface[] getViewTransformers()

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

DataTransformerInterface[] getModelTransformers()

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

DataMapperInterface|null getDataMapper()

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

bool getRequired()

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

bool getDisabled()

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

bool getErrorBubbling()

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

mixed getEmptyData()

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

array getAttributes()

Возвращает дополнительные атрибуты кнопки.

bool hasAttribute(string $name)

Возвращает, существует ли атрибут с заданным именем.

mixed getAttribute(string $name, mixed $default = null)

Возвращает значение заданного атрибута.

mixed getData()

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

string|null getDataClass()

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

bool getDataLocked()

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

FormFactoryInterface getFormFactory()

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

string getAction()

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

string getMethod()

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

RequestHandlerInterface getRequestHandler()

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

bool getAutoInitialize()

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

bool getInheritData()

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

array getOptions()

Возвращает все опции, переданные при создании кнопки.

bool hasOption(string $name)

Возвращает, существует ли определённая опция.

mixed getOption(string $name, mixed $default = null)

Возвращает значение определённой опции.

int count()

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

EmptyIterator getIterator()

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

Подробности

__construct(string|null $name, array $options = array())

Параметры

string|null $name
array $options

Исключения

InvalidArgumentException если имя пустое

FormBuilderInterface add(string|int|FormBuilderInterface $child, string|null $type = null, array $options = array())

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

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

Параметры

string|int|FormBuilderInterface $child
string|null $type
array $options

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

FormBuilderInterface

Исключения

BadMethodCallException

FormBuilderInterface create(string $name, string|null $type = null, array $options = array())

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

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

Параметры

string $name Имя формы или имя свойства
string|null $type Тип формы или null, если имя — свойство
array $options Опции

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

FormBuilderInterface

Исключения

BadMethodCallException

FormBuilderInterface get(string $name)

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

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

Параметры

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

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

FormBuilderInterface

Исключения

BadMethodCallException

FormBuilderInterface remove(string $name)

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

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

Параметры

string $name

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

FormBuilderInterface

Исключения

BadMethodCallException

bool has(string $name)

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

Параметры

string $name

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

bool

array all()

Возвращает дочерние элементы.

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

array

FormInterface getForm()

Создаёт кнопку.

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

FormInterface Форма

$this addEventListener(string $eventName, callable $listener, int $priority = 0)

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

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

Параметры

string $eventName Название события, на которое нужно подписаться
callable $listener Слушатель для выполнения
int $priority Приоритет слушателя. Слушатели с более высоким приоритетом вызываются до слушателей с более низким приоритетом.

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

$this Объект конфигурации

Исключения

BadMethodCallException

$this addEventSubscriber(EventSubscriberInterface $subscriber)

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

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

Параметры

EventSubscriberInterface $subscriber

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

$this Объект конфигурации

Исключения

BadMethodCallException

$this addViewTransformer(DataTransformerInterface $viewTransformer, bool $forcePrepend = false)

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

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

Параметры

DataTransformerInterface $viewTransformer
bool $forcePrepend Если true, добавить в начало, а не в конец

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

$this Объект конфигурации

Исключения

BadMethodCallException

$this resetViewTransformers()

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

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

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

$this Объект конфигурации

Исключения

BadMethodCallException

$this addModelTransformer(DataTransformerInterface $modelTransformer, bool $forceAppend = false)

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

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

Параметры

DataTransformerInterface $modelTransformer
bool $forceAppend Если true, добавить в конец, а не в начало

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

$this Объект конфигурации

Исключения

BadMethodCallException

$this resetModelTransformers()

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

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

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

$this Объект конфигурации

Исключения

BadMethodCallException

$this setAttribute(string $name, mixed $value)

Устанавливает значение атрибута.

Параметры

string $name Имя атрибута
mixed $value Значение атрибута

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

$this Объект конфигурации

$this setAttributes(array $attributes)

Устанавливает атрибуты.

Параметры

array $attributes

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

$this Объект конфигурации

$this setDataMapper(DataMapperInterface $dataMapper = null)

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

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

Параметры

DataMapperInterface $dataMapper

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

$this Объект конфигурации

Исключения

BadMethodCallException

$this setDisabled(bool $disabled)

Установить, отключён ли кнопка.

Параметры

bool $disabled Отключен ли формуляр

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

$this Объект конфигурации

$this setEmptyData(mixed $emptyData)

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

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

Параметры

mixed $emptyData Данные по умолчанию

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

$this Объект конфигурации

Исключения

BadMethodCallException

$this setErrorBubbling(bool $errorBubbling)

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

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

Параметры

bool $errorBubbling

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

$this Объект конфигурации

Исключения

BadMethodCallException

$this setRequired(bool $required)

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

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

Параметры

bool $required

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

$this Объект конфигурации

Исключения

BadMethodCallException

$this setPropertyPath(string|PropertyPathInterface|null $propertyPath)

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

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

Параметры

string|PropertyPathInterface|null $propertyPath Путь к свойству или null, если путь должен быть установлен автоматически на основе имени формы

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

$this Объект конфигурации

Исключения

BadMethodCallException

$this setMapped(bool $mapped)

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

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

Параметры

bool $mapped Нужно ли отображать форму

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

$this Объект конфигурации

Исключения

BadMethodCallException

$this setByReference(bool $byReference)

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

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

Параметры

bool $byReference Нужно ли изменять данные по ссылке

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

$this Объект конфигурации

Исключения

BadMethodCallException

$this setCompound(bool $compound)

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

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

Параметры

bool $compound Является ли форма составной

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

$this Объект конфигурации

Исключения

BadMethodCallException

$this setType(ResolvedFormTypeInterface $type)

Устанавливает тип кнопки.

Параметры

ResolvedFormTypeInterface $type

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

$this Объект конфигурации

$this setData(mixed $data)

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

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

Параметры

mixed $data Данные формы в формате приложения

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

$this Объект конфигурации

Исключения

BadMethodCallException

$this setDataLocked(bool $locked)

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

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

Параметры

bool $locked Заблокировать данные по умолчанию

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

$this Объект конфигурации

Исключения

BadMethodCallException

setFormFactory(FormFactoryInterface $formFactory)

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

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

Параметры

FormFactoryInterface $formFactory

Исключения

BadMethodCallException

$this setAction(string $action)

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

Параметры

string $action Целевой URL формы

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

$this Объект конфигурации

Исключения

BadMethodCallException

$this setMethod(string $method)

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

Параметры

string $method HTTP-метод формы

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

$this Объект конфигурации

Исключения

BadMethodCallException

$this setRequestHandler(RequestHandlerInterface $requestHandler)

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

Параметры

RequestHandlerInterface $requestHandler

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

$this Объект конфигурации

Исключения

BadMethodCallException

$this setAutoInitialize(bool $initialize)

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

Параметры

bool $initialize true для автоматического инициализации формы, false для подавления автоматической инициализации. В последнем случае необходимо вручную вызвать {@link FormInterface::initialize()}

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

$this Объект конфигурации

Исключения

BadMethodCallException

$this setInheritData(bool $inheritData)

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

Параметры

bool $inheritData Нужно ли форме наследовать данные от родительской формы

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

$this Объект конфигурации

Исключения

BadMethodCallException

FormConfigInterface getFormConfig()

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

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

FormConfigInterface

EventDispatcherInterface getEventDispatcher()

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

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

EventDispatcherInterface Диспечер

string getName()

Возвращает имя формы, используемое в качестве HTTP-параметра.

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

string Имя формы

PropertyPathInterface|null getPropertyPath()

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

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

PropertyPathInterface|null Путь к свойству

bool getMapped()

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

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

bool Привязана ли форма

bool getByReference()

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

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

bool Изменять данные формы по ссылке

bool getCompound()

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

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

bool Является ли форма составной

ResolvedFormTypeInterface getType()

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

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

ResolvedFormTypeInterface Тип формы

DataTransformerInterface[] getViewTransformers()

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

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

DataTransformerInterface[] Массив экземпляров {@link DataTransformerInterface}

DataTransformerInterface[] getModelTransformers()

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

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

DataTransformerInterface[] Массив экземпляров {@link DataTransformerInterface}

DataMapperInterface|null getDataMapper()

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

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

DataMapperInterface|null Маппер данных

bool getRequired()

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

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

bool Обязательна ли форма

bool getDisabled()

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

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

bool Отключена ли форма

bool getErrorBubbling()

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

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

bool Будут ли ошибки распространяться вверх

mixed getEmptyData()

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

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

mixed Данные, возвращаемые, если форма пустая

array getAttributes()

Возвращает дополнительные атрибуты кнопки.

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

array Массив пар ключ-значение

bool hasAttribute(string $name)

Возвращает, существует ли атрибут с заданным именем.

Параметры

string $name Имя атрибута

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

bool Существует ли атрибут

mixed getAttribute(string $name, mixed $default = null)

Возвращает значение заданного атрибута.

Параметры

string $name Имя атрибута
mixed $default Значение, возвращаемое, если атрибут не существует

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

mixed Значение атрибута

mixed getData()

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

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

mixed Исходные данные формы

string|null getDataClass()

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

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

string|null Класс данных или null

bool getDataLocked()

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

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

bool Заблокированы ли данные

FormFactoryInterface getFormFactory()

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

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

FormFactoryInterface Фабрика форм

string getAction()

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

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

string Целевой URL формы

string getMethod()

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

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

string HTTP-метод формы

RequestHandlerInterface getRequestHandler()

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

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

RequestHandlerInterface Обработчик запроса

bool getAutoInitialize()

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

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

bool возвращает true, если форма должна инициализироваться при создании, иначе false

bool getInheritData()

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

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

bool Должна ли форма унаследовать данные родителя

array getOptions()

Возвращает все опции, переданные при создании кнопки.

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

array Переданные опции

bool hasOption(string $name)

Возвращает, существует ли определённая опция.

Параметры

string $name Имя опции

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

bool Существует ли опция

mixed getOption(string $name, mixed $default = null)

Возвращает значение определённой опции.

Параметры

string $name Имя опции
mixed $default Значение, возвращаемое, если опция не существует

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

mixed Значение опции

int count()

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

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

int Всегда возвращает 0

EmptyIterator getIterator()

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

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

EmptyIterator Всегда возвращает пустой итератор

© 2004–2017 Fabien Potencier
Licensed under the MIT License.
https://api.symfony.com/4.1/Symfony/Component/Form/ButtonBuilder.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API