class SubmitButtonBuilder extends ButtonBuilder

A builder for {@link SubmitButton} instances.

Methods

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

Creates a new button builder.

add(string|integer|FormBuilderInterface $child, string|FormTypeInterface $type = null, array $options = array())

Unsupported method.

create(string $name, string|FormTypeInterface $type = null, array $options = array())

Unsupported method.

get(string $name)

Unsupported method.

remove(string $name)

Unsupported method.

Boolean
has(string $name)

Unsupported method.

array
all()

Returns the children.

getForm()

Creates the button.

addEventListener(string $eventName, callable $listener, integer $priority)

Unsupported method.

addViewTransformer(DataTransformerInterface $viewTransformer, Boolean $forcePrepend = false)

Unsupported method.

addModelTransformer(DataTransformerInterface $modelTransformer, Boolean $forceAppend = false)

Unsupported method.

setAttribute(string $name, string $value)

Sets the value for an attribute.

setAttributes(array $attributes)

Sets the attributes.

setDataMapper(DataMapperInterface $dataMapper = null)

Unsupported method.

setDisabled(Boolean $disabled)

Set whether the button is disabled.

setEmptyData(mixed $emptyData)

Unsupported method.

setErrorBubbling(Boolean $errorBubbling)

Unsupported method.

setRequired(Boolean $required)

Unsupported method.

setPropertyPath(null|string|PropertyPathInterface $propertyPath)

Unsupported method.

setMapped(Boolean $mapped)

Unsupported method.

setByReference(Boolean $byReference)

Unsupported method.

setVirtual(Boolean $virtual)

Unsupported method.

setCompound(Boolean $compound)

Unsupported method.

setData(array $data)

Unsupported method.

setDataLocked(Boolean $locked)

Unsupported method.

setFormFactory(FormFactoryInterface $formFactory)

Unsupported method.

setAction(string $action)

Unsupported method.

setMethod(string $method)

Unsupported method.

setAutoInitialize(Boolean $initialize)

Unsupported method.

setInheritData(Boolean $inheritData)

Unsupported method.

getFormConfig()

Builds and returns the button configuration.

string
getName()

Returns the name of the form used as HTTP parameter.

getPropertyPath()

Unsupported method.

Boolean
getMapped()

Unsupported method.

Boolean
getByReference()

Unsupported method.

Boolean
getVirtual()

Unsupported method.

Boolean
getCompound()

Unsupported method.

getType()

Returns the form type used to construct the button.

getDataMapper()

Unsupported method.

Boolean
getRequired()

Unsupported method.

Boolean
getDisabled()

Returns whether the button is disabled.

Boolean
getErrorBubbling()

Unsupported method.

mixed
getEmptyData()

Unsupported method.

array
getAttributes()

Returns additional attributes of the button.

Boolean
hasAttribute(string $name)

Returns whether the attribute with the given name exists.

mixed
getAttribute(string $name, mixed $default = null)

Returns the value of the given attribute.

mixed
getData()

Unsupported method.

string
getDataClass()

Unsupported method.

Boolean
getDataLocked()

Unsupported method.

getFormFactory()

Unsupported method.

string
getAction()

Unsupported method.

string
getMethod()

Unsupported method.

Boolean
getAutoInitialize()

Unsupported method.

Boolean
getInheritData()

Unsupported method.

array
getOptions()

Returns all options passed during the construction of the button.

Boolean
hasOption(string $name)

Returns whether a specific option exists.

mixed
getOption(string $name, mixed $default = null)

Returns the value of a specific option.

integer
count()

Unsupported method.

getIterator()

Unsupported method.

Details

in ButtonBuilder at line line 63
__construct(string $name, array $options = array())

Creates a new button builder.

Parameters

string $name The name of the button.
array $options The button's options.

Exceptions

InvalidArgumentException If the name is empty.

in ButtonBuilder at line line 84
FormBuilderInterface add(string|integer|FormBuilderInterface $child, string|FormTypeInterface $type = null, array $options = array())

Unsupported method.

This method should not be invoked.

Parameters

string|integer|FormBuilderInterface $child
string|FormTypeInterface $type
array $options

Return Value

FormBuilderInterface The builder object.

Exceptions

BadMethodCallException

in ButtonBuilder at line line 100
FormBuilderInterface create(string $name, string|FormTypeInterface $type = null, array $options = array())

Unsupported method.

This method should not be invoked.

Parameters

string $name The name of the form or the name of the property
string|FormTypeInterface $type The type of the form or null if name is a property
array $options The options

Return Value

FormBuilderInterface The created builder.

Exceptions

BadMethodCallException

in ButtonBuilder at line line 114
FormBuilderInterface get(string $name)

Unsupported method.

This method should not be invoked.

Parameters

string $name The name of the child

Return Value

FormBuilderInterface The builder for the child

Exceptions

BadMethodCallException

in ButtonBuilder at line line 128
FormBuilderInterface remove(string $name)

Unsupported method.

This method should not be invoked.

Parameters

string $name

Return Value

FormBuilderInterface The builder object.

Exceptions

BadMethodCallException

in ButtonBuilder at line line 140
Boolean has(string $name)

Unsupported method.

Parameters

string $name

Return Value

Boolean

in ButtonBuilder at line line 150
array all()

Returns the children.

Return Value

array

at line line 26
Form getForm()

Creates the button.

Return Value

Form The form

in ButtonBuilder at line line 176
FormConfigBuilderInterface addEventListener(string $eventName, callable $listener, integer $priority)

Unsupported method.

This method should not be invoked.

Parameters

string $eventName The name of the event to listen to.
callable $listener The listener to execute.
integer $priority The priority of the listener. Listeners with a higher priority are called before listeners with a lower priority.

Return Value

FormConfigBuilderInterface The configuration object.

Exceptions

BadMethodCallException

in ButtonBuilder at line line 190
FormConfigBuilderInterface addEventSubscriber(EventSubscriberInterface $subscriber)

Unsupported method.

This method should not be invoked.

Parameters

EventSubscriberInterface $subscriber The subscriber to attach.

Return Value

FormConfigBuilderInterface The configuration object.

Exceptions

BadMethodCallException

in ButtonBuilder at line line 205
FormConfigBuilderInterface addViewTransformer(DataTransformerInterface $viewTransformer, Boolean $forcePrepend = false)

Unsupported method.

This method should not be invoked.

Parameters

DataTransformerInterface $viewTransformer
Boolean $forcePrepend if set to true, prepend instead of appending

Return Value

FormConfigBuilderInterface The configuration object.

Exceptions

BadMethodCallException

in ButtonBuilder at line line 217
FormConfigBuilderInterface resetViewTransformers()

Unsupported method.

This method should not be invoked.

Return Value

FormConfigBuilderInterface The configuration object.

Exceptions

BadMethodCallException

in ButtonBuilder at line line 232
FormConfigBuilderInterface addModelTransformer(DataTransformerInterface $modelTransformer, Boolean $forceAppend = false)

Unsupported method.

This method should not be invoked.

Parameters

DataTransformerInterface $modelTransformer
Boolean $forceAppend if set to true, append instead of prepending

Return Value

FormConfigBuilderInterface The configuration object.

Exceptions

BadMethodCallException

in ButtonBuilder at line line 244
FormConfigBuilderInterface resetModelTransformers()

Unsupported method.

This method should not be invoked.

Return Value

FormConfigBuilderInterface The configuration object.

Exceptions

BadMethodCallException

in ButtonBuilder at line line 252
FormConfigBuilderInterface setAttribute(string $name, string $value)

Sets the value for an attribute.

Parameters

string $name The name of the attribute
string $value The value of the attribute

Return Value

FormConfigBuilderInterface The configuration object.

in ButtonBuilder at line line 260
FormConfigBuilderInterface setAttributes(array $attributes)

Sets the attributes.

Parameters

array $attributes The attributes.

Return Value

FormConfigBuilderInterface The configuration object.

in ButtonBuilder at line line 274
FormConfigBuilderInterface setDataMapper(DataMapperInterface $dataMapper = null)

Unsupported method.

This method should not be invoked.

Parameters

DataMapperInterface $dataMapper

Return Value

FormConfigBuilderInterface The configuration object.

Exceptions

BadMethodCallException

in ButtonBuilder at line line 286
FormConfigBuilderInterface setDisabled(Boolean $disabled)

Set whether the button is disabled.

Parameters

Boolean $disabled Whether the form is disabled

Return Value

FormConfigBuilderInterface The configuration object.

in ButtonBuilder at line line 300
FormConfigBuilderInterface setEmptyData(mixed $emptyData)

Unsupported method.

This method should not be invoked.

Parameters

mixed $emptyData The empty data.

Return Value

FormConfigBuilderInterface The configuration object.

Exceptions

BadMethodCallException

in ButtonBuilder at line line 314
FormConfigBuilderInterface setErrorBubbling(Boolean $errorBubbling)

Unsupported method.

This method should not be invoked.

Parameters

Boolean $errorBubbling

Return Value

FormConfigBuilderInterface The configuration object.

Exceptions

BadMethodCallException

in ButtonBuilder at line line 328
FormConfigBuilderInterface setRequired(Boolean $required)

Unsupported method.

This method should not be invoked.

Parameters

Boolean $required

Return Value

FormConfigBuilderInterface The configuration object.

Exceptions

BadMethodCallException

in ButtonBuilder at line line 342
FormConfigBuilderInterface setPropertyPath(null|string|PropertyPathInterface $propertyPath)

Unsupported method.

This method should not be invoked.

Parameters

null|string|PropertyPathInterface $propertyPath The property path or null if the path should be set automatically based on the form's name.

Return Value

FormConfigBuilderInterface The configuration object.

Exceptions

BadMethodCallException

in ButtonBuilder at line line 356
FormConfigBuilderInterface setMapped(Boolean $mapped)

Unsupported method.

This method should not be invoked.

Parameters

Boolean $mapped Whether the form should be mapped.

Return Value

FormConfigBuilderInterface The configuration object.

Exceptions

BadMethodCallException

in ButtonBuilder at line line 370
FormConfigBuilderInterface setByReference(Boolean $byReference)

Unsupported method.

This method should not be invoked.

Parameters

Boolean $byReference Whether the data should be modified by reference.

Return Value

FormConfigBuilderInterface The configuration object.

Exceptions

BadMethodCallException

in ButtonBuilder at line line 384
setVirtual(Boolean $virtual)

Unsupported method.

This method should not be invoked.

Parameters

Boolean $virtual

Exceptions

BadMethodCallException

in ButtonBuilder at line line 398
FormConfigBuilderInterface setCompound(Boolean $compound)

Unsupported method.

This method should not be invoked.

Parameters

Boolean $compound Whether the form should be compound.

Return Value

FormConfigBuilderInterface The configuration object.

Exceptions

BadMethodCallException

in ButtonBuilder at line line 410
FormConfigBuilderInterface setType(ResolvedFormTypeInterface $type)

Sets the type of the button.

Parameters

ResolvedFormTypeInterface $type The type of the form.

Return Value

FormConfigBuilderInterface The configuration object.

in ButtonBuilder at line line 424
FormConfigBuilderInterface setData(array $data)

Unsupported method.

This method should not be invoked.

Parameters

array $data The data of the form in application format.

Return Value

FormConfigBuilderInterface The configuration object.

Exceptions

BadMethodCallException

in ButtonBuilder at line line 438
FormConfigBuilderInterface setDataLocked(Boolean $locked)

Unsupported method.

This method should not be invoked.

Parameters

Boolean $locked Whether to lock the default data.

Return Value

FormConfigBuilderInterface The configuration object.

Exceptions

BadMethodCallException

in ButtonBuilder at line line 454
setFormFactory(FormFactoryInterface $formFactory)

Unsupported method.

This method should not be invoked.

Parameters

FormFactoryInterface $formFactory The form factory.

Exceptions

BadMethodCallException

in ButtonBuilder at line line 466
FormConfigBuilderInterface setAction(string $action)

Unsupported method.

Parameters

string $action The target URL of the form.

Return Value

FormConfigBuilderInterface The configuration object.

Exceptions

BadMethodCallException

in ButtonBuilder at line line 478
FormConfigBuilderInterface setMethod(string $method)

Unsupported method.

Parameters

string $method The HTTP method of the form.

Return Value

FormConfigBuilderInterface The configuration object.

Exceptions

BadMethodCallException

in ButtonBuilder at line line 490
FormConfigBuilderInterface setRequestHandler(RequestHandlerInterface $requestHandler)

Unsupported method.

Parameters

RequestHandlerInterface $requestHandler

Return Value

FormConfigBuilderInterface The configuration object.

Exceptions

BadMethodCallException

in ButtonBuilder at line line 502
FormConfigBuilderInterface setAutoInitialize(Boolean $initialize)

Unsupported method.

Parameters

Boolean $initialize True to initialize the form automatically, false to suppress automatic initialization. In the second case, you need to call {@link FormInterface::initialize()} manually.

Return Value

FormConfigBuilderInterface The configuration object.

Exceptions

BadMethodCallException

in ButtonBuilder at line line 518
FormConfigBuilderInterface setInheritData(Boolean $inheritData)

Unsupported method.

Parameters

Boolean $inheritData Whether the form should inherit its parent's data.

Return Value

FormConfigBuilderInterface The configuration object.

Exceptions

BadMethodCallException

in ButtonBuilder at line line 528
FormConfigInterface getFormConfig()

Builds and returns the button configuration.

Return Value

FormConfigInterface

in ButtonBuilder at line line 542
EventDispatcherInterface getEventDispatcher()

Unsupported method.

Return Value

EventDispatcherInterface The dispatcher.

in ButtonBuilder at line line 550
string getName()

Returns the name of the form used as HTTP parameter.

Return Value

string The form name.

in ButtonBuilder at line line 560
null|PropertyPathInterface getPropertyPath()

Unsupported method.

Return Value

null|PropertyPathInterface The property path.

in ButtonBuilder at line line 570
Boolean getMapped()

Unsupported method.

Return Value

Boolean Whether the form is mapped.

in ButtonBuilder at line line 580
Boolean getByReference()

Unsupported method.

Return Value

Boolean Whether to modify the form's data by reference.

in ButtonBuilder at line line 590
Boolean getVirtual()

Unsupported method.

Return Value

Boolean Always returns false.

in ButtonBuilder at line line 600
Boolean getCompound()

Unsupported method.

Return Value

Boolean Whether the form is compound.

in ButtonBuilder at line line 610
ResolvedFormTypeInterface getType()

Returns the form type used to construct the button.

Return Value

ResolvedFormTypeInterface The form's type.

in ButtonBuilder at line line 620
DataTransformerInterface[] getViewTransformers()

Unsupported method.

Return Value

DataTransformerInterface[] An array of {@link DataTransformerInterface} instances.

in ButtonBuilder at line line 630
DataTransformerInterface[] getModelTransformers()

Unsupported method.

Return Value

DataTransformerInterface[] An array of {@link DataTransformerInterface} instances.

in ButtonBuilder at line line 640
DataMapperInterface getDataMapper()

Unsupported method.

Return Value

DataMapperInterface The data mapper.

in ButtonBuilder at line line 650
Boolean getRequired()

Unsupported method.

Return Value

Boolean Whether the form is required.

in ButtonBuilder at line line 660
Boolean getDisabled()

Returns whether the button is disabled.

Return Value

Boolean Whether the form is disabled.

in ButtonBuilder at line line 670
Boolean getErrorBubbling()

Unsupported method.

Return Value

Boolean Whether errors will bubble up.

in ButtonBuilder at line line 680
mixed getEmptyData()

Unsupported method.

Return Value

mixed The data returned if the form is empty.

in ButtonBuilder at line line 690
array getAttributes()

Returns additional attributes of the button.

Return Value

array An array of key-value combinations.

in ButtonBuilder at line line 702
Boolean hasAttribute(string $name)

Returns whether the attribute with the given name exists.

Parameters

string $name The attribute name.

Return Value

Boolean Whether the attribute exists.

in ButtonBuilder at line line 715
mixed getAttribute(string $name, mixed $default = null)

Returns the value of the given attribute.

Parameters

string $name The attribute name.
mixed $default The value returned if the attribute does not exist.

Return Value

mixed The attribute value.

in ButtonBuilder at line line 725
mixed getData()

Unsupported method.

Return Value

mixed The initial form data.

in ButtonBuilder at line line 735
string getDataClass()

Unsupported method.

Return Value

string The data class or null.

in ButtonBuilder at line line 745
Boolean getDataLocked()

Unsupported method.

Return Value

Boolean Whether the data is locked.

in ButtonBuilder at line line 755
FormFactoryInterface getFormFactory()

Unsupported method.

Return Value

FormFactoryInterface The form factory.

in ButtonBuilder at line line 765
string getAction()

Unsupported method.

Return Value

string The target URL of the form.

in ButtonBuilder at line line 775
string getMethod()

Unsupported method.

Return Value

string The HTTP method of the form.

in ButtonBuilder at line line 785
RequestHandlerInterface getRequestHandler()

Unsupported method.

Return Value

RequestHandlerInterface The request handler.

in ButtonBuilder at line line 795
Boolean getAutoInitialize()

Unsupported method.

Return Value

Boolean Returns true if the form should be initialized when created, false otherwise.

in ButtonBuilder at line line 805
Boolean getInheritData()

Unsupported method.

Return Value

Boolean Whether the form should inherit its parent's data.

in ButtonBuilder at line line 815
array getOptions()

Returns all options passed during the construction of the button.

Return Value

array The passed options.

in ButtonBuilder at line line 827
Boolean hasOption(string $name)

Returns whether a specific option exists.

Parameters

string $name The option name,

Return Value

Boolean Whether the option exists.

in ButtonBuilder at line line 840
mixed getOption(string $name, mixed $default = null)

Returns the value of a specific option.

Parameters

string $name The option name.
mixed $default The value returned if the option does not exist.

Return Value

mixed The option value.

in ButtonBuilder at line line 850
integer count()

Unsupported method.

Return Value

integer Always returns 0.

in ButtonBuilder at line line 860
EmptyIterator getIterator()

Unsupported method.

Return Value

EmptyIterator Always returns an empty iterator.