ButtonBuilder
in package
implements
IteratorAggregate, FormBuilderInterface
A builder for {@link Button} instances.
Tags
Table of Contents
Interfaces
- IteratorAggregate
- FormBuilderInterface
Properties
- $locked : mixed
- $attributes : array<string|int, mixed>
- $disabled : bool
- $name : string
- $options : array<string|int, mixed>
- $type : mixed
Methods
- __construct() : mixed
- add() : static
- Unsupported method.
- addEventListener() : static
- Unsupported method.
- addEventSubscriber() : static
- Unsupported method.
- addModelTransformer() : static
- Unsupported method.
- addViewTransformer() : static
- Unsupported method.
- all() : array<string, self>
- Returns the children.
- count() : int
- Unsupported method.
- create() : FormBuilderInterface
- Unsupported method.
- get() : FormBuilderInterface
- Unsupported method.
- getAction() : string
- Unsupported method.
- getAttribute() : mixed
- Returns the value of the given attribute.
- getAttributes() : array<string|int, mixed>
- Returns additional attributes of the button.
- getAutoInitialize() : bool
- Unsupported method.
- getByReference() : bool
- Unsupported method.
- getCompound() : bool
- Unsupported method.
- getData() : mixed
- Unsupported method.
- getDataClass() : string|null
- Unsupported method.
- getDataLocked() : bool
- Unsupported method.
- getDataMapper() : DataMapperInterface|null
- Unsupported method.
- getDisabled() : bool
- Returns whether the button is disabled.
- getEmptyData() : mixed
- Unsupported method.
- getErrorBubbling() : bool
- Unsupported method.
- getEventDispatcher() : EventDispatcherInterface
- Unsupported method.
- getForm() : Button
- Creates the button.
- getFormConfig() : FormConfigInterface
- Builds and returns the button configuration.
- getFormFactory() : FormFactoryInterface
- Unsupported method.
- getInheritData() : bool
- Unsupported method.
- getIsEmptyCallback() : callable|null
- Unsupported method.
- getIterator() : EmptyIterator
- Unsupported method.
- getMapped() : bool
- Unsupported method.
- getMethod() : string
- Unsupported method.
- getModelTransformers() : array<string|int, mixed>
- Unsupported method.
- getName() : string
- {@inheritdoc}
- getOption() : mixed
- Returns the value of a specific option.
- getOptions() : array<string|int, mixed>
- Returns all options passed during the construction of the button.
- getPropertyPath() : PropertyPathInterface|null
- Unsupported method.
- getRequestHandler() : RequestHandlerInterface
- Unsupported method.
- getRequired() : bool
- Unsupported method.
- getType() : ResolvedFormTypeInterface
- Returns the form type used to construct the button.
- getViewTransformers() : array<string|int, mixed>
- Unsupported method.
- has() : bool
- Unsupported method.
- hasAttribute() : bool
- Returns whether the attribute with the given name exists.
- hasOption() : bool
- Returns whether a specific option exists.
- remove() : static
- Unsupported method.
- resetModelTransformers() : static
- Unsupported method.
- resetViewTransformers() : static
- Unsupported method.
- setAction() : static
- Unsupported method.
- setAttribute() : static
- {@inheritdoc}
- setAttributes() : static
- {@inheritdoc}
- setAutoInitialize() : $this
- Unsupported method.
- setByReference() : static
- Unsupported method.
- setCompound() : static
- Unsupported method.
- setData() : static
- Unsupported method.
- setDataLocked() : static
- Unsupported method.
- setDataMapper() : static
- Unsupported method.
- setDisabled() : $this
- Set whether the button is disabled.
- setEmptyData() : static
- Unsupported method.
- setErrorBubbling() : static
- Unsupported method.
- setFormFactory() : mixed
- Unsupported method.
- setInheritData() : static
- Unsupported method.
- setIsEmptyCallback() : static
- Unsupported method.
- setMapped() : static
- Unsupported method.
- setMethod() : static
- Unsupported method.
- setPropertyPath() : static
- Unsupported method.
- setRequestHandler() : static
- Unsupported method.
- setRequired() : static
- Unsupported method.
- setType() : $this
- Sets the type of the button.
Properties
$locked
protected
mixed
$locked
= false
$attributes
private
array<string|int, mixed>
$attributes
= []
$disabled
private
bool
$disabled
= false
$name
private
string
$name
$options
private
array<string|int, mixed>
$options
$type
private
mixed
$type
Methods
__construct()
public
__construct(string|null $name[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $name : string|null
- $options : array<string|int, mixed> = []
Tags
add()
Unsupported method.
public
add(string|FormBuilderInterface $child[, string $type = null ][, array<string|int, mixed> $options = [] ]) : static
Parameters
- $child : string|FormBuilderInterface
- $type : string = null
- $options : array<string|int, mixed> = []
Tags
Return values
staticaddEventListener()
Unsupported method.
public
addEventListener(string $eventName, callable $listener[, int $priority = 0 ]) : static
Parameters
- $eventName : string
- $listener : callable
- $priority : int = 0
Tags
Return values
staticaddEventSubscriber()
Unsupported method.
public
addEventSubscriber(EventSubscriberInterface $subscriber) : static
Parameters
- $subscriber : EventSubscriberInterface
Tags
Return values
staticaddModelTransformer()
Unsupported method.
public
addModelTransformer(DataTransformerInterface $modelTransformer[, bool $forceAppend = false ]) : static
Parameters
- $modelTransformer : DataTransformerInterface
- $forceAppend : bool = false
Tags
Return values
staticaddViewTransformer()
Unsupported method.
public
addViewTransformer(DataTransformerInterface $viewTransformer[, bool $forcePrepend = false ]) : static
Parameters
- $viewTransformer : DataTransformerInterface
- $forcePrepend : bool = false
Tags
Return values
staticall()
Returns the children.
public
all() : array<string, self>
Return values
array<string, self>count()
Unsupported method.
public
count() : int
Return values
intcreate()
Unsupported method.
public
create(string $name[, string $type = null ][, array<string|int, mixed> $options = [] ]) : FormBuilderInterface
Parameters
- $name : string
-
The name of the form or the name of the property
- $type : string = null
-
The type of the form or null if name is a property
- $options : array<string|int, mixed> = []
Tags
Return values
FormBuilderInterfaceget()
Unsupported method.
public
get(string $name) : FormBuilderInterface
Parameters
- $name : string
Tags
Return values
FormBuilderInterfacegetAction()
Unsupported method.
public
getAction() : string
Tags
Return values
stringgetAttribute()
Returns the value of the given attribute.
public
getAttribute(string $name[, mixed $default = null ]) : mixed
Parameters
- $name : string
- $default : mixed = null
getAttributes()
Returns additional attributes of the button.
public
getAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed>getAutoInitialize()
Unsupported method.
public
getAutoInitialize() : bool
Return values
boolgetByReference()
Unsupported method.
public
getByReference() : bool
Return values
boolgetCompound()
Unsupported method.
public
getCompound() : bool
Return values
boolgetData()
Unsupported method.
public
getData() : mixed
getDataClass()
Unsupported method.
public
getDataClass() : string|null
Return values
string|nullgetDataLocked()
Unsupported method.
public
getDataLocked() : bool
Return values
boolgetDataMapper()
Unsupported method.
public
getDataMapper() : DataMapperInterface|null
Return values
DataMapperInterface|nullgetDisabled()
Returns whether the button is disabled.
public
getDisabled() : bool
Return values
boolgetEmptyData()
Unsupported method.
public
getEmptyData() : mixed
getErrorBubbling()
Unsupported method.
public
getErrorBubbling() : bool
Return values
boolgetEventDispatcher()
Unsupported method.
public
getEventDispatcher() : EventDispatcherInterface
Tags
Return values
EventDispatcherInterfacegetForm()
Creates the button.
public
getForm() : Button
Return values
ButtongetFormConfig()
Builds and returns the button configuration.
public
getFormConfig() : FormConfigInterface
Return values
FormConfigInterfacegetFormFactory()
Unsupported method.
public
getFormFactory() : FormFactoryInterface
Return values
FormFactoryInterfacegetInheritData()
Unsupported method.
public
getInheritData() : bool
Return values
boolgetIsEmptyCallback()
Unsupported method.
public
getIsEmptyCallback() : callable|null
Tags
Return values
callable|nullgetIterator()
Unsupported method.
public
getIterator() : EmptyIterator
Return values
EmptyIteratorgetMapped()
Unsupported method.
public
getMapped() : bool
Return values
boolgetMethod()
Unsupported method.
public
getMethod() : string
Tags
Return values
stringgetModelTransformers()
Unsupported method.
public
getModelTransformers() : array<string|int, mixed>
Return values
array<string|int, mixed>getName()
{@inheritdoc}
public
getName() : string
Return values
stringgetOption()
Returns the value of a specific option.
public
getOption(string $name[, mixed $default = null ]) : mixed
Parameters
- $name : string
- $default : mixed = null
getOptions()
Returns all options passed during the construction of the button.
public
getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed>getPropertyPath()
Unsupported method.
public
getPropertyPath() : PropertyPathInterface|null
Return values
PropertyPathInterface|nullgetRequestHandler()
Unsupported method.
public
getRequestHandler() : RequestHandlerInterface
Tags
Return values
RequestHandlerInterfacegetRequired()
Unsupported method.
public
getRequired() : bool
Return values
boolgetType()
Returns the form type used to construct the button.
public
getType() : ResolvedFormTypeInterface
Return values
ResolvedFormTypeInterfacegetViewTransformers()
Unsupported method.
public
getViewTransformers() : array<string|int, mixed>
Return values
array<string|int, mixed>has()
Unsupported method.
public
has(string $name) : bool
Parameters
- $name : string
Return values
boolhasAttribute()
Returns whether the attribute with the given name exists.
public
hasAttribute(string $name) : bool
Parameters
- $name : string
Return values
boolhasOption()
Returns whether a specific option exists.
public
hasOption(string $name) : bool
Parameters
- $name : string
Return values
boolremove()
Unsupported method.
public
remove(string $name) : static
Parameters
- $name : string
Tags
Return values
staticresetModelTransformers()
Unsupported method.
public
resetModelTransformers() : static
Tags
Return values
staticresetViewTransformers()
Unsupported method.
public
resetViewTransformers() : static
Tags
Return values
staticsetAction()
Unsupported method.
public
setAction(string $action) : static
Parameters
- $action : string
Tags
Return values
staticsetAttribute()
{@inheritdoc}
public
setAttribute(string $name, mixed $value) : static
Parameters
- $name : string
- $value : mixed
Return values
staticsetAttributes()
{@inheritdoc}
public
setAttributes(array<string|int, mixed> $attributes) : static
Parameters
- $attributes : array<string|int, mixed>
Return values
staticsetAutoInitialize()
Unsupported method.
public
setAutoInitialize(bool $initialize) : $this
Parameters
- $initialize : bool
Tags
Return values
$thissetByReference()
Unsupported method.
public
setByReference(bool $byReference) : static
Parameters
- $byReference : bool
Tags
Return values
staticsetCompound()
Unsupported method.
public
setCompound(bool $compound) : static
Parameters
- $compound : bool
Tags
Return values
staticsetData()
Unsupported method.
public
setData(mixed $data) : static
Parameters
- $data : mixed
Tags
Return values
staticsetDataLocked()
Unsupported method.
public
setDataLocked(bool $locked) : static
Parameters
- $locked : bool
Tags
Return values
staticsetDataMapper()
Unsupported method.
public
setDataMapper([DataMapperInterface $dataMapper = null ]) : static
Parameters
- $dataMapper : DataMapperInterface = null
Tags
Return values
staticsetDisabled()
Set whether the button is disabled.
public
setDisabled(bool $disabled) : $this
Parameters
- $disabled : bool
Return values
$thissetEmptyData()
Unsupported method.
public
setEmptyData(mixed $emptyData) : static
Parameters
- $emptyData : mixed
Tags
Return values
staticsetErrorBubbling()
Unsupported method.
public
setErrorBubbling(bool $errorBubbling) : static
Parameters
- $errorBubbling : bool
Tags
Return values
staticsetFormFactory()
Unsupported method.
public
setFormFactory(FormFactoryInterface $formFactory) : mixed
Parameters
- $formFactory : FormFactoryInterface
Tags
setInheritData()
Unsupported method.
public
setInheritData(bool $inheritData) : static
Parameters
- $inheritData : bool
Tags
Return values
staticsetIsEmptyCallback()
Unsupported method.
public
setIsEmptyCallback(callable|null $isEmptyCallback) : static
Parameters
- $isEmptyCallback : callable|null
Tags
Return values
staticsetMapped()
Unsupported method.
public
setMapped(bool $mapped) : static
Parameters
- $mapped : bool
Tags
Return values
staticsetMethod()
Unsupported method.
public
setMethod(string $method) : static
Parameters
- $method : string
Tags
Return values
staticsetPropertyPath()
Unsupported method.
public
setPropertyPath(string|PropertyPathInterface|null $propertyPath) : static
Parameters
- $propertyPath : string|PropertyPathInterface|null
Tags
Return values
staticsetRequestHandler()
Unsupported method.
public
setRequestHandler(RequestHandlerInterface $requestHandler) : static
Parameters
- $requestHandler : RequestHandlerInterface
Tags
Return values
staticsetRequired()
Unsupported method.
public
setRequired(bool $required) : static
Parameters
- $required : bool
Tags
Return values
staticsetType()
Sets the type of the button.
public
setType(ResolvedFormTypeInterface $type) : $this
Parameters
- $type : ResolvedFormTypeInterface