ButtonBuilder
class ButtonBuilder implements IteratorAggregate, FormBuilderInterface
Построитель экземпляров {@link Button}.
Методы
| __construct(string $name, array $options = array()) Создаёт новый билдер кнопки. | ||
| FormBuilderInterface | add(string|int|FormBuilderInterface $child, string|FormTypeInterface $type = null, array $options = array()) Неподдерживаемый метод. | |
| FormBuilderInterface | create(string $name, string|FormTypeInterface $type = null, array $options = array()) Неподдерживаемый метод. | |
| FormBuilderInterface | get(string $name) Неподдерживаемый метод. | |
| FormBuilderInterface | remove(string $name) Неподдерживаемый метод. | |
| bool | has(string $name) Неподдерживаемый метод. | |
| array | all() Возвращает дочерние элементы. | |
| Form | 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 | Если имя пустое. |
FormBuilderInterface add(string|int|FormBuilderInterface $child, string|FormTypeInterface $type = null, array $options = array())
Метод не поддерживается.
Этот метод вызывать не следует.
Параметры
| string|int|FormBuilderInterface | $child | |
| string|FormTypeInterface | $type | |
| array | $options |
Возвращаемое значение
| FormBuilderInterface | Объект билдера. |
Исключения
| BadMethodCallException |
FormBuilderInterface create(string $name, string|FormTypeInterface $type = null, array $options = array())
Метод не поддерживается.
Этот метод вызывать не следует.
Параметры
| string | $name | Имя формы или имя свойства. |
| string|FormTypeInterface | $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 |
Form getForm()
Создаёт кнопку.
Возвращаемое значение
| Form | Форма |
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)
Устанавливает значение для атрибута.
Параметры
| строка | $name | Имя атрибута |
| смешанный тип | $value | Значение атрибута |
Возвращаемое значение
| FormConfigBuilderInterface | Объект конфигурации. |
FormConfigBuilderInterface setAttributes(array $attributes)
Устанавливает атрибуты.
Параметры
| массив | $attributes | Атрибуты. |
Возвращаемое значение
| FormConfigBuilderInterface | Объект конфигурации. |
FormConfigBuilderInterface setDataMapper(DataMapperInterface $dataMapper = null)
Неподдерживаемый метод.
Этот метод вызывать нельзя.
Параметры
| DataMapperInterface | $dataMapper |
Возвращаемое значение
| FormConfigBuilderInterface | Объект конфигурации. |
Исключения
| BadMethodCallException |
FormConfigBuilderInterface setDisabled(bool $disabled)
Устанавливает, является ли кнопка отключенной.
Параметры
| логическое | $disabled | Является ли форма отключенной |
Возвращаемое значение
| FormConfigBuilderInterface | Объект конфигурации. |
FormConfigBuilderInterface setEmptyData(mixed $emptyData)
Неподдерживаемый метод.
Этот метод вызывать нельзя.
Параметры
| смешанный тип | $emptyData | Пустые данные. |
Возвращаемое значение
| FormConfigBuilderInterface | Объект конфигурации. |
Исключения
| BadMethodCallException |
FormConfigBuilderInterface setErrorBubbling(bool $errorBubbling)
Неподдерживаемый метод.
Этот метод вызывать нельзя.
Параметры
| логическое | $errorBubbling |
Возвращаемое значение
| FormConfigBuilderInterface | Объект конфигурации. |
Исключения
| BadMethodCallException |
FormConfigBuilderInterface setRequired(bool $required)
Неподдерживаемый метод.
Этот метод вызывать нельзя.
Параметры
| логическое | $required |
Возвращаемое значение
| FormConfigBuilderInterface | Объект конфигурации. |
Исключения
| BadMethodCallException |
FormConfigBuilderInterface setPropertyPath(null|string|PropertyPathInterface $propertyPath)
Неподдерживаемый метод.
Этот метод вызывать нельзя.
Параметры
| null|строка|PropertyPathInterface | $propertyPath | Путь к свойству или null, если путь должен быть установлен автоматически на основе имени формы. |
Возвращаемое значение
| FormConfigBuilderInterface | Объект конфигурации. |
Исключения
| BadMethodCallException |
FormConfigBuilderInterface setMapped(bool $mapped)
Неподдерживаемый метод.
Этот метод вызывать нельзя.
Параметры
| логическое | $mapped | Следует ли отображать форму. |
Возвращаемое значение
| FormConfigBuilderInterface | Объект конфигурации. |
Исключения
| BadMethodCallException |
FormConfigBuilderInterface setByReference(bool $byReference)
Неподдерживаемый метод.
Этот метод вызывать нельзя.
Параметры
| логическое | $byReference | Следует ли изменять данные по ссылке. |
Возвращаемое значение
| FormConfigBuilderInterface | Объект конфигурации. |
Исключения
| BadMethodCallException |
FormConfigBuilderInterface setCompound(bool $compound)
Неподдерживаемый метод.
Этот метод вызывать нельзя.
Параметры
| логическое | $compound | Следует ли делать форму составной. |
Возвращаемое значение
| FormConfigBuilderInterface | Объект конфигурации. |
Исключения
| BadMethodCallException |
FormConfigBuilderInterface setType(ResolvedFormTypeInterface $type)
Устанавливает тип кнопки.
Параметры
| ResolvedFormTypeInterface | $type | Тип формы. |
Возвращаемое значение
| FormConfigBuilderInterface | Объект конфигурации. |
FormConfigBuilderInterface setData(mixed $data)
Неподдерживаемый метод.
Этот метод вызывать нельзя.
Параметры
| смешанный тип | $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 | Инициализировать форму автоматически (true), или запретить автоматическую инициализацию (false). В последнем случае необходимо вручную вызвать {@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.0/Symfony/Component/Form/ButtonBuilder.html
