ButtonBuilder
class ButtonBuilder implements 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.2/Symfony/Component/Form/ButtonBuilder.html