SubmitButtonBuilder
extends ButtonBuilder
in package
A builder for {@link SubmitButton} instances.
Tags
Table of Contents
- $locked : mixed
- $attributes : array<string|int, mixed>
- $disabled : bool
- $name : string
- $options : array<string|int, mixed>
- $type : ResolvedFormTypeInterface
- __construct() : mixed
- add() : self
- Unsupported method.
- addEventListener() : mixed
- Unsupported method.
- addEventSubscriber() : mixed
- Unsupported method.
- addModelTransformer() : mixed
- Unsupported method.
- addViewTransformer() : mixed
- Unsupported method.
- all() : array<string|int, mixed>
- Returns the children.
- count() : int
- Unsupported method.
- create() : self
- Unsupported method.
- get() : self
- Unsupported method.
- getAction() : mixed
- 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() : mixed
- Unsupported method.
- getDataLocked() : bool
- Unsupported method.
- getDataMapper() : mixed
- Unsupported method.
- getDisabled() : bool
- Returns whether the button is disabled.
- getEmptyData() : mixed
- Unsupported method.
- getErrorBubbling() : bool
- Unsupported method.
- getEventDispatcher() : mixed
- Unsupported method.
- getForm() : SubmitButton
- Creates the button.
- getFormConfig() : FormConfigInterface
- Builds and returns the button configuration.
- getFormFactory() : mixed
- Unsupported method.
- getInheritData() : bool
- Unsupported method.
- getIterator() : EmptyIterator
- Unsupported method.
- getMapped() : bool
- Unsupported method.
- getMethod() : mixed
- Unsupported method.
- getModelTransformers() : array<string|int, mixed>
- Unsupported method.
- getName() : mixed
- {@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() : mixed
- Unsupported method.
- getRequestHandler() : mixed
- 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() : self
- Unsupported method.
- resetModelTransformers() : mixed
- Unsupported method.
- resetViewTransformers() : mixed
- Unsupported method.
- setAction() : mixed
- Unsupported method.
- setAttribute() : mixed
- {@inheritdoc}
- setAttributes() : mixed
- {@inheritdoc}
- setAutoInitialize() : $this
- Unsupported method.
- setByReference() : mixed
- Unsupported method.
- setCompound() : mixed
- Unsupported method.
- setData() : mixed
- Unsupported method.
- setDataLocked() : mixed
- Unsupported method.
- setDataMapper() : mixed
- Unsupported method.
- setDisabled() : $this
- Set whether the button is disabled.
- setEmptyData() : mixed
- Unsupported method.
- setErrorBubbling() : mixed
- Unsupported method.
- setFormFactory() : mixed
- Unsupported method.
- setInheritData() : mixed
- Unsupported method.
- setMapped() : mixed
- Unsupported method.
- setMethod() : mixed
- Unsupported method.
- setPropertyPath() : mixed
- Unsupported method.
- setRequestHandler() : mixed
- Unsupported method.
- setRequired() : mixed
- 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
ResolvedFormTypeInterface
$type
Methods
__construct()
public
__construct(string|null $name[, array<string|int, mixed> $options = [] ]) : mixed
Parameters
- $name : string|null
- $options : array<string|int, mixed> = []
Tags
Return values
mixed —add()
Unsupported method.
public
add(mixed $child[, mixed $type = null ][, array<string|int, mixed> $options = [] ]) : self
This method should not be invoked.
Parameters
- $child : mixed
- $type : mixed = null
- $options : array<string|int, mixed> = []
Tags
Return values
self —addEventListener()
Unsupported method.
public
addEventListener(mixed $eventName, mixed $listener, mixed $priority) : mixed
Parameters
- $eventName : mixed
- $listener : mixed
- $priority : mixed
Tags
Return values
mixed —addEventSubscriber()
Unsupported method.
public
addEventSubscriber(EventSubscriberInterface $subscriber) : mixed
Parameters
- $subscriber : EventSubscriberInterface
Tags
Return values
mixed —addModelTransformer()
Unsupported method.
public
addModelTransformer(DataTransformerInterface $modelTransformer[, mixed $forceAppend = false ]) : mixed
Parameters
- $modelTransformer : DataTransformerInterface
- $forceAppend : mixed = false
Tags
Return values
mixed —addViewTransformer()
Unsupported method.
public
addViewTransformer(DataTransformerInterface $viewTransformer[, mixed $forcePrepend = false ]) : mixed
Parameters
- $viewTransformer : DataTransformerInterface
- $forcePrepend : mixed = false
Tags
Return values
mixed —all()
Returns the children.
public
all() : array<string|int, mixed>
Return values
array<string|int, mixed> —Always returns an empty array
count()
Unsupported method.
public
count() : int
Return values
int —Always returns 0
create()
Unsupported method.
public
create(mixed $name[, mixed $type = null ][, array<string|int, mixed> $options = [] ]) : self
This method should not be invoked.
Parameters
- $name : mixed
-
The name of the form or the name of the property
- $type : mixed = null
-
The type of the form or null if name is a property
- $options : array<string|int, mixed> = []
Tags
Return values
self —get()
Unsupported method.
public
get(mixed $name) : self
Parameters
- $name : mixed
-
The name of the child
Tags
Return values
self —getAction()
Unsupported method.
public
getAction() : mixed
Return values
mixed —getAttribute()
Returns the value of the given attribute.
public
getAttribute(string $name[, mixed $default = null ]) : mixed
Parameters
- $name : string
-
The attribute name
- $default : mixed = null
-
The value returned if the attribute does not exist
Return values
mixed —The attribute value
getAttributes()
Returns additional attributes of the button.
public
getAttributes() : array<string|int, mixed>
Return values
array<string|int, mixed> —An array of key-value combinations
getAutoInitialize()
Unsupported method.
public
getAutoInitialize() : bool
Return values
bool —Always returns false
getByReference()
Unsupported method.
public
getByReference() : bool
Return values
bool —Always returns false
getCompound()
Unsupported method.
public
getCompound() : bool
Return values
bool —Always returns false
getData()
Unsupported method.
public
getData() : mixed
Return values
mixed —getDataClass()
Unsupported method.
public
getDataClass() : mixed
Return values
mixed —getDataLocked()
Unsupported method.
public
getDataLocked() : bool
Return values
bool —Always returns false
getDataMapper()
Unsupported method.
public
getDataMapper() : mixed
Return values
mixed —getDisabled()
Returns whether the button is disabled.
public
getDisabled() : bool
Return values
bool —Whether the button is disabled
getEmptyData()
Unsupported method.
public
getEmptyData() : mixed
Return values
mixed —getErrorBubbling()
Unsupported method.
public
getErrorBubbling() : bool
Return values
bool —Always returns false
getEventDispatcher()
Unsupported method.
public
getEventDispatcher() : mixed
Return values
mixed —getForm()
Creates the button.
public
getForm() : SubmitButton
Return values
SubmitButton —The button
getFormConfig()
Builds and returns the button configuration.
public
getFormConfig() : FormConfigInterface
Return values
FormConfigInterface —getFormFactory()
Unsupported method.
public
getFormFactory() : mixed
Return values
mixed —getInheritData()
Unsupported method.
public
getInheritData() : bool
Return values
bool —Always returns false
getIterator()
Unsupported method.
public
getIterator() : EmptyIterator
Return values
EmptyIterator —Always returns an empty iterator
getMapped()
Unsupported method.
public
getMapped() : bool
Return values
bool —Always returns false
getMethod()
Unsupported method.
public
getMethod() : mixed
Return values
mixed —getModelTransformers()
Unsupported method.
public
getModelTransformers() : array<string|int, mixed>
Return values
array<string|int, mixed> —Always returns an empty array
getName()
{@inheritdoc}
public
getName() : mixed
Return values
mixed —getOption()
Returns the value of a specific option.
public
getOption(string $name[, mixed $default = null ]) : mixed
Parameters
- $name : string
-
The option name
- $default : mixed = null
-
The value returned if the option does not exist
Return values
mixed —The option value
getOptions()
Returns all options passed during the construction of the button.
public
getOptions() : array<string|int, mixed>
Return values
array<string|int, mixed> —The passed options
getPropertyPath()
Unsupported method.
public
getPropertyPath() : mixed
Return values
mixed —getRequestHandler()
Unsupported method.
public
getRequestHandler() : mixed
Return values
mixed —getRequired()
Unsupported method.
public
getRequired() : bool
Return values
bool —Always returns false
getType()
Returns the form type used to construct the button.
public
getType() : ResolvedFormTypeInterface
Return values
ResolvedFormTypeInterface —The button's type
getViewTransformers()
Unsupported method.
public
getViewTransformers() : array<string|int, mixed>
Return values
array<string|int, mixed> —Always returns an empty array
has()
Unsupported method.
public
has(mixed $name) : bool
Parameters
- $name : mixed
Return values
bool —Always returns false
hasAttribute()
Returns whether the attribute with the given name exists.
public
hasAttribute(string $name) : bool
Parameters
- $name : string
-
The attribute name
Return values
bool —Whether the attribute exists
hasOption()
Returns whether a specific option exists.
public
hasOption(string $name) : bool
Parameters
- $name : string
-
The option name,
Return values
bool —Whether the option exists
remove()
Unsupported method.
public
remove(mixed $name) : self
Parameters
- $name : mixed
Tags
Return values
self —resetModelTransformers()
Unsupported method.
public
resetModelTransformers() : mixed
Tags
Return values
mixed —resetViewTransformers()
Unsupported method.
public
resetViewTransformers() : mixed
Tags
Return values
mixed —setAction()
Unsupported method.
public
setAction(mixed $action) : mixed
Parameters
- $action : mixed
Tags
Return values
mixed —setAttribute()
{@inheritdoc}
public
setAttribute(mixed $name, mixed $value) : mixed
Parameters
- $name : mixed
- $value : mixed
Return values
mixed —setAttributes()
{@inheritdoc}
public
setAttributes(array<string|int, mixed> $attributes) : mixed
Parameters
- $attributes : array<string|int, mixed>
Return values
mixed —setAutoInitialize()
Unsupported method.
public
setAutoInitialize(mixed $initialize) : $this
Parameters
- $initialize : mixed
Tags
Return values
$this —setByReference()
Unsupported method.
public
setByReference(mixed $byReference) : mixed
Parameters
- $byReference : mixed
Tags
Return values
mixed —setCompound()
Unsupported method.
public
setCompound(mixed $compound) : mixed
Parameters
- $compound : mixed
Tags
Return values
mixed —setData()
Unsupported method.
public
setData(mixed $data) : mixed
Parameters
- $data : mixed
Tags
Return values
mixed —setDataLocked()
Unsupported method.
public
setDataLocked(mixed $locked) : mixed
Parameters
- $locked : mixed
Tags
Return values
mixed —setDataMapper()
Unsupported method.
public
setDataMapper([DataMapperInterface $dataMapper = null ]) : mixed
Parameters
- $dataMapper : DataMapperInterface = null
Tags
Return values
mixed —setDisabled()
Set whether the button is disabled.
public
setDisabled(bool $disabled) : $this
Parameters
- $disabled : bool
-
Whether the button is disabled
Return values
$this —setEmptyData()
Unsupported method.
public
setEmptyData(mixed $emptyData) : mixed
Parameters
- $emptyData : mixed
Tags
Return values
mixed —setErrorBubbling()
Unsupported method.
public
setErrorBubbling(mixed $errorBubbling) : mixed
Parameters
- $errorBubbling : mixed
Tags
Return values
mixed —setFormFactory()
Unsupported method.
public
setFormFactory(FormFactoryInterface $formFactory) : mixed
Parameters
- $formFactory : FormFactoryInterface
Tags
Return values
mixed —setInheritData()
Unsupported method.
public
setInheritData(mixed $inheritData) : mixed
Parameters
- $inheritData : mixed
Tags
Return values
mixed —setMapped()
Unsupported method.
public
setMapped(mixed $mapped) : mixed
Parameters
- $mapped : mixed
Tags
Return values
mixed —setMethod()
Unsupported method.
public
setMethod(mixed $method) : mixed
Parameters
- $method : mixed
Tags
Return values
mixed —setPropertyPath()
Unsupported method.
public
setPropertyPath(mixed $propertyPath) : mixed
Parameters
- $propertyPath : mixed
Tags
Return values
mixed —setRequestHandler()
Unsupported method.
public
setRequestHandler(RequestHandlerInterface $requestHandler) : mixed
Parameters
- $requestHandler : RequestHandlerInterface
Tags
Return values
mixed —setRequired()
Unsupported method.
public
setRequired(mixed $required) : mixed
Parameters
- $required : mixed
Tags
Return values
mixed —setType()
Sets the type of the button.
public
setType(ResolvedFormTypeInterface $type) : $this
Parameters
- $type : ResolvedFormTypeInterface