class ButtonBuilder implements IteratorAggregate, FormBuilderInterface

A builder for {@link Button} instances.

Properties

protected bool $locked

Methods

__construct(string|null $name, array $options = [])

No description

add(string|int|FormBuilderInterface $child, string|null $type = null, array $options = [])

Unsupported method.

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

Unsupported method.

get(string $name)

Unsupported method.

remove(string $name)

Unsupported method.

bool
has(string $name)

Unsupported method.

array
all()

Returns the children.

getForm()

Creates the button.

$this
addEventListener(string $eventName, callable $listener, int $priority = 0)

Unsupported method.

$this
addEventSubscriber(EventSubscriberInterface $subscriber)

Unsupported method.

$this
addViewTransformer(DataTransformerInterface $viewTransformer, bool $forcePrepend = false)

Unsupported method.

$this
resetViewTransformers()

Unsupported method.

$this
addModelTransformer(DataTransformerInterface $modelTransformer, bool $forceAppend = false)

Unsupported method.

$this
resetModelTransformers()

Unsupported method.

$this
setAttribute(string $name, mixed $value)

Sets the value for an attribute.

$this
setAttributes(array $attributes)

Sets the attributes.

$this
setDataMapper(DataMapperInterface $dataMapper = null)

Unsupported method.

$this
setDisabled(bool $disabled)

Set whether the button is disabled.

$this
setEmptyData(mixed $emptyData)

Unsupported method.

$this
setErrorBubbling(bool $errorBubbling)

Unsupported method.

$this
setRequired(bool $required)

Unsupported method.

$this
setPropertyPath(string|PropertyPathInterface|null $propertyPath)

Unsupported method.

$this
setMapped(bool $mapped)

Unsupported method.

$this
setByReference(bool $byReference)

Unsupported method.

$this
setCompound(bool $compound)

Unsupported method.

$this
setType(ResolvedFormTypeInterface $type)

Sets the type of the button.

$this
setData(mixed $data)

Unsupported method.

$this
setDataLocked(bool $locked)

Unsupported method.

setFormFactory(FormFactoryInterface $formFactory)

Unsupported method.

$this
setAction(string $action)

Unsupported method.

$this
setMethod(string $method)

Unsupported method.

$this
setRequestHandler(RequestHandlerInterface $requestHandler)

Unsupported method.

$this
setAutoInitialize(bool $initialize)

Unsupported method.

$this
setInheritData(bool $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.

bool
getMapped()

Unsupported method.

bool
getByReference()

Unsupported method.

bool
getCompound()

Unsupported method.

getType()

Returns the form type used to construct the button.

getDataMapper()

Unsupported method.

bool
getRequired()

Unsupported method.

bool
getDisabled()

Returns whether the button is disabled.

bool
getErrorBubbling()

Unsupported method.

mixed
getEmptyData()

Unsupported method.

array
getAttributes()

Returns additional attributes of the button.

bool
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|null
getDataClass()

Unsupported method.

bool
getDataLocked()

Unsupported method.

getFormFactory()

Unsupported method.

string
getAction()

Unsupported method.

string
getMethod()

Unsupported method.

bool
getAutoInitialize()

Unsupported method.

bool
getInheritData()

Unsupported method.

array
getOptions()

Returns all options passed during the construction of the button.

bool
hasOption(string $name)

Returns whether a specific option exists.

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

Returns the value of a specific option.

int
count()

Unsupported method.

getIterator()

Unsupported method.

Details

at line 58
__construct(string|null $name, array $options = [])

Parameters

string|null $name
array $options

Exceptions

InvalidArgumentException if the name is empty

at line 91
FormBuilderInterface add(string|int|FormBuilderInterface $child, string|null $type = null, array $options = [])

Unsupported method.

This method should not be invoked.

Parameters

string|int|FormBuilderInterface $child
string|null $type
array $options

Return Value

FormBuilderInterface

Exceptions

BadMethodCallException

at line 107
FormBuilderInterface create(string $name, string|null $type = null, array $options = [])

Unsupported method.

This method should not be invoked.

Parameters

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

Return Value

FormBuilderInterface

Exceptions

BadMethodCallException

at line 121
FormBuilderInterface get(string $name)

Unsupported method.

This method should not be invoked.

Parameters

string $name The name of the child

Return Value

FormBuilderInterface

Exceptions

BadMethodCallException

at line 135
FormBuilderInterface remove(string $name)

Unsupported method.

This method should not be invoked.

Parameters

string $name

Return Value

FormBuilderInterface

Exceptions

BadMethodCallException

at line 147
bool has(string $name)

Unsupported method.

Parameters

string $name

Return Value

bool

at line 157
array all()

Returns the children.

Return Value

array

at line 167
FormInterface getForm()

Creates the button.

Return Value

FormInterface The form

at line 183
$this addEventListener(string $eventName, callable $listener, int $priority = 0)

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
int $priority The priority of the listener. Listeners with a higher priority are called before listeners with a lower priority.

Return Value

$this The configuration object

Exceptions

BadMethodCallException

at line 195
$this addEventSubscriber(EventSubscriberInterface $subscriber)

Unsupported method.

This method should not be invoked.

Parameters

EventSubscriberInterface $subscriber

Return Value

$this The configuration object

Exceptions

BadMethodCallException

at line 210
$this addViewTransformer(DataTransformerInterface $viewTransformer, bool $forcePrepend = false)

Unsupported method.

This method should not be invoked.

Parameters

DataTransformerInterface $viewTransformer
bool $forcePrepend If set to true, prepend instead of appending

Return Value

$this The configuration object

Exceptions

BadMethodCallException

at line 222
$this resetViewTransformers()

Unsupported method.

This method should not be invoked.

Return Value

$this The configuration object

Exceptions

BadMethodCallException

at line 237
$this addModelTransformer(DataTransformerInterface $modelTransformer, bool $forceAppend = false)

Unsupported method.

This method should not be invoked.

Parameters

DataTransformerInterface $modelTransformer
bool $forceAppend If set to true, append instead of prepending

Return Value

$this The configuration object

Exceptions

BadMethodCallException

at line 249
$this resetModelTransformers()

Unsupported method.

This method should not be invoked.

Return Value

$this The configuration object

Exceptions

BadMethodCallException

at line 257
$this setAttribute(string $name, mixed $value)

Sets the value for an attribute.

Parameters

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

Return Value

$this The configuration object

at line 267
$this setAttributes(array $attributes)

Sets the attributes.

Parameters

array $attributes

Return Value

$this The configuration object

at line 281
$this setDataMapper(DataMapperInterface $dataMapper = null)

Unsupported method.

This method should not be invoked.

Parameters

DataMapperInterface $dataMapper

Return Value

$this The configuration object

Exceptions

BadMethodCallException

at line 293
$this setDisabled(bool $disabled)

Set whether the button is disabled.

Parameters

bool $disabled Whether the form is disabled

Return Value

$this The configuration object

at line 309
$this setEmptyData(mixed $emptyData)

Unsupported method.

This method should not be invoked.

Parameters

mixed $emptyData The empty data

Return Value

$this The configuration object

Exceptions

BadMethodCallException

at line 323
$this setErrorBubbling(bool $errorBubbling)

Unsupported method.

This method should not be invoked.

Parameters

bool $errorBubbling

Return Value

$this The configuration object

Exceptions

BadMethodCallException

at line 337
$this setRequired(bool $required)

Unsupported method.

This method should not be invoked.

Parameters

bool $required

Return Value

$this The configuration object

Exceptions

BadMethodCallException

at line 351
$this setPropertyPath(string|PropertyPathInterface|null $propertyPath)

Unsupported method.

This method should not be invoked.

Parameters

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

Return Value

$this The configuration object

Exceptions

BadMethodCallException

at line 365
$this setMapped(bool $mapped)

Unsupported method.

This method should not be invoked.

Parameters

bool $mapped Whether the form should be mapped

Return Value

$this The configuration object

Exceptions

BadMethodCallException

at line 379
$this setByReference(bool $byReference)

Unsupported method.

This method should not be invoked.

Parameters

bool $byReference Whether the data should be modified by reference

Return Value

$this The configuration object

Exceptions

BadMethodCallException

at line 393
$this setCompound(bool $compound)

Unsupported method.

This method should not be invoked.

Parameters

bool $compound Whether the form should be compound

Return Value

$this The configuration object

Exceptions

BadMethodCallException

at line 403
$this setType(ResolvedFormTypeInterface $type)

Sets the type of the button.

Parameters

ResolvedFormTypeInterface $type

Return Value

$this The configuration object

at line 419
$this setData(mixed $data)

Unsupported method.

This method should not be invoked.

Parameters

mixed $data The data of the form in application format

Return Value

$this The configuration object

Exceptions

BadMethodCallException

at line 433
$this setDataLocked(bool $locked)

Unsupported method.

This method should not be invoked.

Parameters

bool $locked Whether to lock the default data

Return Value

$this The configuration object

Exceptions

BadMethodCallException

at line 445
setFormFactory(FormFactoryInterface $formFactory)

Unsupported method.

This method should not be invoked.

Parameters

FormFactoryInterface $formFactory

Exceptions

BadMethodCallException

at line 457
$this setAction(string $action)

Unsupported method.

Parameters

string $action The target URL of the form

Return Value

$this The configuration object

Exceptions

BadMethodCallException

at line 469
$this setMethod(string $method)

Unsupported method.

Parameters

string $method The HTTP method of the form

Return Value

$this The configuration object

Exceptions

BadMethodCallException

at line 479
$this setRequestHandler(RequestHandlerInterface $requestHandler)

Unsupported method.

Parameters

RequestHandlerInterface $requestHandler

Return Value

$this The configuration object

Exceptions

BadMethodCallException

at line 493
$this setAutoInitialize(bool $initialize)

Unsupported method.

Parameters

bool $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

$this The configuration object

Exceptions

BadMethodCallException

at line 509
$this setInheritData(bool $inheritData)

Unsupported method.

Parameters

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

Return Value

$this The configuration object

Exceptions

BadMethodCallException

at line 519
FormConfigInterface getFormConfig()

Builds and returns the button configuration.

Return Value

FormConfigInterface

at line 531
EventDispatcherInterface getEventDispatcher()

Unsupported method.

Return Value

EventDispatcherInterface The dispatcher

at line 538
string getName()

Returns the name of the form used as HTTP parameter.

Return Value

string The form name

at line 546
PropertyPathInterface|null getPropertyPath()

Unsupported method.

Return Value

PropertyPathInterface|null The property path

at line 555
bool getMapped()

Unsupported method.

Return Value

bool Whether the form is mapped

at line 565
bool getByReference()

Unsupported method.

Return Value

bool Whether to modify the form's data by reference

at line 575
bool getCompound()

Unsupported method.

Return Value

bool Whether the form is compound

at line 585
ResolvedFormTypeInterface getType()

Returns the form type used to construct the button.

Return Value

ResolvedFormTypeInterface The form's type

at line 595
DataTransformerInterface[] getViewTransformers()

Unsupported method.

Return Value

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

at line 605
DataTransformerInterface[] getModelTransformers()

Unsupported method.

Return Value

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

at line 613
DataMapperInterface|null getDataMapper()

Unsupported method.

Return Value

DataMapperInterface|null The data mapper

at line 622
bool getRequired()

Unsupported method.

Return Value

bool Whether the form is required

at line 632
bool getDisabled()

Returns whether the button is disabled.

Return Value

bool Whether the form is disabled

at line 642
bool getErrorBubbling()

Unsupported method.

Return Value

bool Whether errors will bubble up

at line 650
mixed getEmptyData()

Unsupported method.

Return Value

mixed The data returned if the form is empty

at line 659
array getAttributes()

Returns additional attributes of the button.

Return Value

array An array of key-value combinations

at line 671
bool hasAttribute(string $name)

Returns whether the attribute with the given name exists.

Parameters

string $name The attribute name

Return Value

bool Whether the attribute exists

at line 684
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

at line 692
mixed getData()

Unsupported method.

Return Value

mixed The initial form data

at line 699
string|null getDataClass()

Unsupported method.

Return Value

string|null The data class or null

at line 708
bool getDataLocked()

Unsupported method.

Return Value

bool Whether the data is locked

at line 716
FormFactoryInterface getFormFactory()

Unsupported method.

Return Value

FormFactoryInterface The form factory

at line 723
string getAction()

Unsupported method.

Return Value

string The target URL of the form

at line 730
string getMethod()

Unsupported method.

Return Value

string The HTTP method of the form

at line 737
RequestHandlerInterface getRequestHandler()

Unsupported method.

Return Value

RequestHandlerInterface The request handler

at line 746
bool getAutoInitialize()

Unsupported method.

Return Value

bool returns true if the form should be initialized when created, false otherwise

at line 756
bool getInheritData()

Unsupported method.

Return Value

bool Whether the form should inherit its parent's data

at line 766
array getOptions()

Returns all options passed during the construction of the button.

Return Value

array The passed options

at line 778
bool hasOption(string $name)

Returns whether a specific option exists.

Parameters

string $name The option name,

Return Value

bool Whether the option exists

at line 791
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

at line 801
int count()

Unsupported method.

Return Value

int Always returns 0

at line 811
EmptyIterator getIterator()

Unsupported method.

Return Value

EmptyIterator Always returns an empty iterator