Button

class Button implements IteratorAggregate, FormInterface

A form button.

Methods

	__construct(FormConfigInterface $config) Creates a new button from a form configuration.
bool	offsetExists(mixed $offset) Unsupported method.
	offsetGet(mixed $offset) Unsupported method.
	offsetSet(mixed $offset, mixed $value) Unsupported method.
	offsetUnset(mixed $offset) Unsupported method.
FormInterface	setParent(FormInterface $parent = null) Sets the parent form.
FormInterface\|null	getParent() Returns the parent form.
FormInterface	add(FormInterface\|string\|int $child, string\|null $type = null, array $options = array()) Unsupported method.
FormInterface	get(string $name) Unsupported method.
bool	has(string $name) Unsupported method.
FormInterface	remove(string $name) Unsupported method.
FormInterface[]	all() Returns all children in this group.
FormErrorIterator	getErrors(bool $deep = false, bool $flatten = true) Returns the errors of this form.
FormInterface	setData(mixed $modelData) Unsupported method.
mixed	getData() Unsupported method.
mixed	getNormData() Unsupported method.
mixed	getViewData() Unsupported method.
array	getExtraData() Unsupported method.
FormConfigInterface	getConfig() Returns the button's configuration.
bool	isSubmitted() Returns whether the button is submitted.
string	getName() Returns the name by which the button is identified in forms.
PropertyPathInterface	getPropertyPath() Unsupported method.
FormInterface	addError(FormError $error) Unsupported method.
bool	isValid() Unsupported method.
bool	isRequired() Unsupported method.
bool	isDisabled() Returns whether this form is disabled.
bool	isEmpty() Unsupported method.
bool	isSynchronized() Unsupported method.
TransformationFailedException\|null	getTransformationFailure() Unsupported method.
FormInterface	initialize() Unsupported method.
FormInterface	handleRequest(mixed $request = null) Unsupported method.
FormInterface	submit(null\|string\|array $submittedData, bool $clearMissing = true) Submits data to the button.
FormInterface	getRoot() Returns the root of the form tree.
bool	isRoot() Returns whether the field is the root of the form tree.
FormView	createView(FormView $parent = null) Creates a view.
int	count() Unsupported method.
EmptyIterator	getIterator() Unsupported method.

Details

__construct(FormConfigInterface $config)

Creates a new button from a form configuration.

Parameters

FormConfigInterface

$config

The button's configuration

bool offsetExists(mixed $offset)

Unsupported method.

Parameters

mixed

$offset

Return Value

bool	Always returns false

offsetGet(mixed $offset)

Unsupported method.

This method should not be invoked.

Parameters

mixed

$offset

Exceptions

BadMethodCallException

offsetSet(mixed $offset, mixed $value)

Unsupported method.

This method should not be invoked.

Parameters

mixed	$offset
mixed	$value

Exceptions

BadMethodCallException

offsetUnset(mixed $offset)

Unsupported method.

This method should not be invoked.

Parameters

mixed

$offset

Exceptions

BadMethodCallException

FormInterface setParent(FormInterface $parent = null)

Sets the parent form.

Parameters

FormInterface

$parent

The parent form or null if it's the root

Return Value

FormInterface

The form instance

Exceptions

AlreadySubmittedException	If the form has already been submitted.
LogicException	When trying to set a parent for a form with an empty name.

FormInterface|null getParent()

Returns the parent form.

Return Value

FormInterface|null

The parent form or null if there is none

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

Unsupported method.

This method should not be invoked.

Parameters

FormInterface\|string\|int	$child	The FormInterface instance or the name of the child
string\|null	$type	The child's type, if a name was passed
array	$options	The child's options, if a name was passed

Return Value

FormInterface

The form instance

Exceptions

BadMethodCallException

FormInterface get(string $name)

Unsupported method.

This method should not be invoked.

Parameters

string

$name

The name of the child

Return Value

FormInterface

The child form

Exceptions

BadMethodCallException

bool has(string $name)

Unsupported method.

Parameters

string

$name

The name of the child

Return Value

bool

FormInterface remove(string $name)

Unsupported method.

This method should not be invoked.

Parameters

string

$name

The name of the child to remove

Return Value

FormInterface

The form instance

Exceptions

BadMethodCallException

FormInterface[] all()

Returns all children in this group.

Return Value

FormInterface[]

An array of FormInterface instances

FormErrorIterator getErrors(bool $deep = false, bool $flatten = true)

Returns the errors of this form.

Parameters

bool	$deep	Whether to include errors of child forms as well
bool	$flatten	Whether to flatten the list of errors in case $deep is set to true

Return Value

FormErrorIterator

An iterator over the {@link FormError} instances that where added to this form

FormInterface setData(mixed $modelData)

Unsupported method.

This method should not be invoked.

Parameters

mixed

$modelData

The data formatted as expected for the underlying object

Return Value

FormInterface

The form instance

mixed getData()

Unsupported method.

Return Value

mixed

mixed getNormData()

Unsupported method.

Return Value

mixed

When the field is not submitted, the default data is returned When the field is submitted, the normalized submitted data is returned if the field is valid, null otherwise.