Spec-Zone.ru › Symfony 3.1

ButtonBuilder

класс ButtonBuilder реализует IteratorAggregate, FormBuilderInterface

Создатель экземпляров {@link Button}.

Методы

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

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

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

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

$this remove(string $name)

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

bool has(string $name)

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

array all()

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

FormInterface getForm()

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

FormConfigBuilderInterface addEventListener(string $eventName, callable $listener, int $priority)

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

FormConfigBuilderInterface addEventSubscriber(EventSubscriberInterface $subscriber)

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

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

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

FormConfigBuilderInterface resetViewTransformers()

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

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

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

FormConfigBuilderInterface resetModelTransformers()

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

FormConfigBuilderInterface setAttribute(string $name, mixed $value)

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

FormConfigBuilderInterface setAttributes(array $attributes)

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

FormConfigBuilderInterface setDataMapper(DataMapperInterface $dataMapper = null)

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

FormConfigBuilderInterface setDisabled(bool $disabled)

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

FormConfigBuilderInterface setEmptyData(mixed $emptyData)

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

FormConfigBuilderInterface setErrorBubbling(bool $errorBubbling)

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

FormConfigBuilderInterface setRequired(bool $required)

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

FormConfigBuilderInterface setPropertyPath(null|string|PropertyPathInterface $propertyPath)

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

FormConfigBuilderInterface setMapped(bool $mapped)

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

FormConfigBuilderInterface setByReference(bool $byReference)

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

FormConfigBuilderInterface setCompound(bool $compound)

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

FormConfigBuilderInterface setType(ResolvedFormTypeInterface $type)

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

FormConfigBuilderInterface setData(mixed $data)

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

FormConfigBuilderInterface setDataLocked(bool $locked)

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

setFormFactory(FormFactoryInterface $formFactory)

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

FormConfigBuilderInterface setAction(string $action)

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

FormConfigBuilderInterface setMethod(string $method)

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

FormConfigBuilderInterface setRequestHandler(RequestHandlerInterface $requestHandler)

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

FormConfigBuilderInterface setAutoInitialize(bool $initialize)

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

FormConfigBuilderInterface 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()

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

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 Если имя пустое.

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

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

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

Параметры

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

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

$this

Исключения

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

$this remove(string $name)

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

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

Параметры

string $name

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

$this

Исключения

BadMethodCallException

bool has(string $name)

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

Параметры

string $name

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

bool

array all()

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

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

array

FormInterface getForm()

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

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

FormInterface Форма

FormConfigBuilderInterface addEventListener(string $eventName, callable $listener, int $priority)

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

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

Параметры

string $eventName Имя события для прослушивания
callable $listener Обработчик для выполнения
int $priority Приоритет обработчика. Обработчики с более высоким приоритетом вызываются до обработчиков с более низким приоритетом.

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

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

Исключения

BadMethodCallException

FormConfigBuilderInterface addEventSubscriber(EventSubscriberInterface $subscriber)

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

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

Параметры

EventSubscriberInterface $subscriber Подписчик для добавления

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

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

Исключения

BadMethodCallException

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

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

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

Параметры

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

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

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

Исключения

BadMethodCallException

FormConfigBuilderInterface resetViewTransformers()

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

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

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

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

Исключения

BadMethodCallException

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

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

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

Параметры

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

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

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

Исключения

BadMethodCallException

FormConfigBuilderInterface resetModelTransformers()

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

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

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

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

Исключения

BadMethodCallException

FormConfigBuilderInterface setAttribute(string $name, mixed $value)

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

Параметры

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

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

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

FormConfigBuilderInterface setAttributes(array $attributes)

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

Параметры

array $attributes Атрибуты

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

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

FormConfigBuilderInterface setDataMapper(DataMapperInterface $dataMapper = null)

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

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

Параметры

DataMapperInterface $dataMapper

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

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

Исключения

BadMethodCallException

FormConfigBuilderInterface setDisabled(bool $disabled)

Устанавливает, заблокирован ли элемент.

Параметры

bool $disabled Заблокирована ли форма

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

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

FormConfigBuilderInterface setEmptyData(mixed $emptyData)

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

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

Параметры

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

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

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

Исключения

BadMethodCallException

FormConfigBuilderInterface setErrorBubbling(bool $errorBubbling)

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

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

Параметры

bool $errorBubbling

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

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

Исключения

BadMethodCallException

FormConfigBuilderInterface setRequired(bool $required)

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

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

Параметры

bool $required

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

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

Исключения

BadMethodCallException

FormConfigBuilderInterface setPropertyPath(null|string|PropertyPathInterface $propertyPath)

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

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

Параметры

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

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

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

Исключения

BadMethodCallException

FormConfigBuilderInterface setMapped(bool $mapped)

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

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

Параметры

bool $mapped Должна ли форма быть связана с данными

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

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

Исключения

BadMethodCallException

FormConfigBuilderInterface setByReference(bool $byReference)

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

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

Параметры

bool $byReference Изменять данные по ссылке.

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

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

Исключения

BadMethodCallException

FormConfigBuilderInterface setCompound(bool $compound)

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

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

Параметры

bool $compound Должна ли форма быть составной

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

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

Исключения

BadMethodCallException

FormConfigBuilderInterface setType(ResolvedFormTypeInterface $type)

Устанавливает тип элемента.

Параметры

ResolvedFormTypeInterface $type Тип формы

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

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

FormConfigBuilderInterface setData(mixed $data)

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

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

Параметры

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

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

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

Исключения

BadMethodCallException

FormConfigBuilderInterface setDataLocked(bool $locked)

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

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

Параметры

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

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

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

Исключения

BadMethodCallException

setFormFactory(FormFactoryInterface $formFactory)

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

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

Параметры

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

Исключения

BadMethodCallException

FormConfigBuilderInterface setAction(string $action)

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

Параметры

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

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

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

Исключения

BadMethodCallException

FormConfigBuilderInterface setMethod(string $method)

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

Параметры

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

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

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

Исключения

BadMethodCallException

FormConfigBuilderInterface setRequestHandler(RequestHandlerInterface $requestHandler)

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

Параметры

RequestHandlerInterface $requestHandler

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

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

Исключения

BadMethodCallException

FormConfigBuilderInterface setAutoInitialize(bool $initialize)

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

Параметры

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

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

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

Исключения

BadMethodCallException

FormConfigBuilderInterface setInheritData(bool $inheritData)

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

Параметры

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

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

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

Исключения

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

string getDataClass()

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

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

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.1/Symfony/Component/Form/ButtonBuilder.html

Spec-Zone.ru

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