ButtonBuilder

__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

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

Unsupported method.

This method should not be invoked.

Parameters

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

Return Value

FormBuilderInterface

Exceptions

BadMethodCallException

FormBuilderInterface create(string $name, string|null $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|null	$type	The type of the form or null if name is a property
array	$options	The options

Return Value

FormBuilderInterface

Exceptions

BadMethodCallException

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

FormBuilderInterface remove(string $name)

Unsupported method.

This method should not be invoked.

Parameters

string

$name

Return Value

FormBuilderInterface

Exceptions

BadMethodCallException

bool has(string $name)

Unsupported method.

Parameters

string

$name

Return Value

bool

array all()

Returns the children.

Return Value

array

FormInterface getForm()

Creates the button.

Return Value

FormInterface

The form

$this addEventListener(string $eventName, callable $listener, int $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
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

$this addEventSubscriber(EventSubscriberInterface $subscriber)

Unsupported method.

This method should not be invoked.

Parameters

EventSubscriberInterface

$subscriber

Return Value

$this

The configuration object

Exceptions

BadMethodCallException

$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

$this resetViewTransformers()

Unsupported method.

This method should not be invoked.

Return Value

$this

The configuration object

Exceptions

BadMethodCallException

$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

$this resetModelTransformers()

Unsupported method.

This method should not be invoked.

Return Value

$this

The configuration object

Exceptions

BadMethodCallException

$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

$this setAttributes(array $attributes)

Sets the attributes.

Parameters

array

$attributes

Return Value

$this

The configuration object

$this setDataMapper(DataMapperInterface $dataMapper = null)

Unsupported method.

This method should not be invoked.

Parameters

DataMapperInterface

$dataMapper

Return Value

$this

The configuration object

Exceptions

BadMethodCallException

$this setDisabled(bool $disabled)

Set whether the button is disabled.

Parameters

bool

$disabled

Whether the form is disabled

Return Value

$this

The configuration object

$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

$this setErrorBubbling(bool $errorBubbling)

Unsupported method.

This method should not be invoked.

Parameters

bool

$errorBubbling

Return Value

$this

The configuration object

Exceptions

BadMethodCallException

$this setRequired(bool $required)

Unsupported method.

This method should not be invoked.

Parameters

bool

$required

Return Value

$this

The configuration object

Exceptions

BadMethodCallException

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

$this

The configuration object

Exceptions

BadMethodCallException

$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

$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

$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

$this setType(ResolvedFormTypeInterface $type)

Sets the type of the button.

Parameters

ResolvedFormTypeInterface

$type

Return Value

$this

The configuration object

$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

$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

setFormFactory(FormFactoryInterface $formFactory)

Unsupported method.

This method should not be invoked.

Parameters

FormFactoryInterface

$formFactory

Exceptions

BadMethodCallException

$this setAction(string $action)

Unsupported method.

Parameters

string

$action

The target URL of the form

Return Value

$this

The configuration object

Exceptions

BadMethodCallException

$this setMethod(string $method)

Unsupported method.

Parameters

string

$method

The HTTP method of the form

Return Value

$this

The configuration object

Exceptions

BadMethodCallException

$this setRequestHandler(RequestHandlerInterface $requestHandler)

Unsupported method.

Parameters

RequestHandlerInterface

$requestHandler

Return Value

$this

The configuration object

Exceptions

BadMethodCallException

$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

$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

FormConfigInterface getFormConfig()

Builds and returns the button configuration.

Return Value

FormConfigInterface

EventDispatcherInterface getEventDispatcher()

Unsupported method.

Return Value

EventDispatcherInterface

The dispatcher

string getName()

Returns the name of the form used as HTTP parameter.

Return Value

string

The form name

null|PropertyPathInterface getPropertyPath()

Unsupported method.

Return Value

null|PropertyPathInterface

The property path

bool getMapped()

Unsupported method.

Return Value

bool	Whether the form is mapped

bool getByReference()

Unsupported method.

Return Value

bool	Whether to modify the form's data by reference

bool getCompound()

Unsupported method.

Return Value

bool	Whether the form is compound

ResolvedFormTypeInterface getType()

Returns the form type used to construct the button.

Return Value

ResolvedFormTypeInterface

The form's type

DataTransformerInterface[] getViewTransformers()

Unsupported method.

Return Value

DataTransformerInterface[]

An array of {@link DataTransformerInterface} instances

DataTransformerInterface[] getModelTransformers()

Unsupported method.

Return Value

DataTransformerInterface[]

An array of {@link DataTransformerInterface} instances

DataMapperInterface getDataMapper()

Unsupported method.

Return Value

DataMapperInterface

The data mapper

bool getRequired()

Unsupported method.

Return Value

bool	Whether the form is required

bool getDisabled()

Returns whether the button is disabled.

Return Value

bool	Whether the form is disabled

bool getErrorBubbling()

Unsupported method.

Return Value

bool	Whether errors will bubble up

mixed getEmptyData()

Unsupported method.

Return Value

mixed

The data returned if the form is empty

array getAttributes()

Returns additional attributes of the button.

Return Value

array

An array of key-value combinations

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

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

mixed getData()

Unsupported method.

Return Value

mixed

The initial form data

null|string getDataClass()

Unsupported method.

Return Value

null|string

The data class or null

bool getDataLocked()

Unsupported method.

Return Value

bool	Whether the data is locked

FormFactoryInterface getFormFactory()

Unsupported method.

Return Value

FormFactoryInterface

The form factory

string getAction()

Unsupported method.

Return Value

string

The target URL of the form

string getMethod()

Unsupported method.

Return Value

string

The HTTP method of the form

RequestHandlerInterface getRequestHandler()

Unsupported method.

Return Value

RequestHandlerInterface

The request handler

bool getAutoInitialize()

Unsupported method.

Return Value

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

bool getInheritData()

Unsupported method.

Return Value

bool	Whether the form should inherit its parent's data

array getOptions()

Returns all options passed during the construction of the button.

Return Value

array

The passed options

bool hasOption(string $name)

Returns whether a specific option exists.

Parameters

string

$name

The option name,

Return Value

bool	Whether the option exists

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

int count()

Unsupported method.

Return Value

int	Always returns 0

EmptyIterator getIterator()

Unsupported method.

Return Value

EmptyIterator

Always returns an empty iterator