Spec-Zone.ru › Symfony 3.4

ButtonBuilder

class ButtonBuilder implements IteratorAggregate, FormBuilderInterface

A builder for {@link Button} instances.

Methods

__construct(string $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)

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

$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(null|string|PropertyPathInterface $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-параметр.

null|PropertyPathInterface getPropertyPath()

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

bool getMapped()

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

bool getByReference()

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

bool getCompound()

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

ResolvedFormTypeInterface getType()

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

DataTransformerInterface[] getViewTransformers()

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

DataTransformerInterface[] getModelTransformers()

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

DataMapperInterface getDataMapper()

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

bool getRequired()

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

bool getDisabled()

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

bool getErrorBubbling()

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

mixed getEmptyData()

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

array getAttributes()

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

bool hasAttribute(string $name)

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

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

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

mixed getData()

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

null|string 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 $name, array $options = array())

Создаёт новый билдер кнопки.

Параметры

string $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)

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

Вызов этого метода не должен происходить.

Параметры

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(null|string|PropertyPathInterface $propertyPath)

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

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

Параметры

null|string|PropertyPathInterface $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 Истина для автоматической инициализации формы, ложь для подавления автоматической инициализации. В последнем случае необходимо вручную вызвать {@link FormInterface::initialize()}.

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

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

Исключения

BadMethodCallException

$this setInheritData(bool $inheritData)

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

Параметры

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

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

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

Исключения

BadMethodCallException

FormConfigInterface getFormConfig()

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

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

FormConfigInterface

EventDispatcherInterface getEventDispatcher()

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

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

EventDispatcherInterface Диспечер

string getName()

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

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

string Имя формы

null|PropertyPathInterface getPropertyPath()

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

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

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

bool getMapped()

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

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

bool Отмечено ли поле как сопоставленное

bool getByReference()

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

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

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

bool getCompound()

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

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

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

ResolvedFormTypeInterface getType()

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

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

ResolvedFormTypeInterface Тип формы

DataTransformerInterface[] getViewTransformers()

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

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

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

DataTransformerInterface[] getModelTransformers()

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

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

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

DataMapperInterface getDataMapper()

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

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

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

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 Исходные данные формы

null|string getDataClass()

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

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

null|string Класс данных или 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.
http://api.symfony.com/3.4/Symfony/Component/Form/ButtonBuilder.html

Spec-Zone.ru

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