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.

setParent(FormInterface $parent = null)

Sets the parent form.

getParent()

Returns the parent form.

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

Unsupported method.

get(string $name)

Unsupported method.

bool
has(string $name)

Unsupported method.

$this
remove(string $name)

Unsupported method.

all()

Returns all children in this group.

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

Returns the errors of this form.

$this
setData(mixed $modelData)

Unsupported method.

mixed
getData()

Unsupported method.

mixed
getNormData()

Unsupported method.

mixed
getViewData()

Unsupported method.

array
getExtraData()

Unsupported method.

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.

getPropertyPath()

Unsupported method.

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

$this
initialize()

Unsupported method.

$this
handleRequest(mixed $request = null)

Unsupported method.

$this
submit(mixed $submittedData, bool $clearMissing = true)

Submits data to the button.

getRoot()

Returns the root of the form tree.

bool
isRoot()

Returns whether the field is the root of the form tree.

createView(FormView $parent = null)

Creates a view.

int
count()

Unsupported method.

getIterator()

Unsupported method.

Details

at line 44
__construct(FormConfigInterface $config)

Creates a new button from a form configuration.

Parameters

FormConfigInterface $config The button's configuration

at line 56
bool offsetExists(mixed $offset)

Unsupported method.

Parameters

mixed $offset

Return Value

bool Always returns false

at line 70
offsetGet(mixed $offset)

Unsupported method.

This method should not be invoked.

Parameters

mixed $offset

Exceptions

BadMethodCallException

at line 85
offsetSet(mixed $offset, mixed $value)

Unsupported method.

This method should not be invoked.

Parameters

mixed $offset
mixed $value

Exceptions

BadMethodCallException

at line 99
offsetUnset(mixed $offset)

Unsupported method.

This method should not be invoked.

Parameters

mixed $offset

Exceptions

BadMethodCallException

at line 107
FormInterface setParent(FormInterface $parent = null)

Sets the parent form.

Parameters

FormInterface $parent

Return Value

FormInterface

Exceptions

AlreadySubmittedException if the form has already been submitted
LogicException when trying to set a parent for a form with an empty name

at line 119
FormInterface|null getParent()

Returns the parent form.

Return Value

FormInterface|null The parent form or null if there is none

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

Exceptions

BadMethodCallException

at line 149
FormInterface get(string $name)

Unsupported method.

This method should not be invoked.

Parameters

string $name The name of the child

Return Value

FormInterface

Exceptions

BadMethodCallException

at line 161
bool has(string $name)

Unsupported method.

Parameters

string $name The name of the child

Return Value

bool

at line 175
$this remove(string $name)

Unsupported method.

This method should not be invoked.

Parameters

string $name The name of the child to remove

Return Value

$this

Exceptions

BadMethodCallException

at line 183
FormInterface[] all()

Returns all children in this group.

Return Value

FormInterface[]

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

at line 203
$this 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

$this

at line 212
mixed getData()

Unsupported method.

Return Value

mixed

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

at line 226
mixed getViewData()

Unsupported method.

Return Value

mixed

at line 235
array getExtraData()

Unsupported method.

Return Value

array The submitted data which do not belong to a child

at line 245
FormConfigInterface getConfig()

Returns the button's configuration.

Return Value

FormConfigInterface The configuration

at line 255
bool isSubmitted()

Returns whether the button is submitted.

Return Value

bool true if the form is submitted, false otherwise

at line 265
string getName()

Returns the name by which the button is identified in forms.

Return Value

string The name of the form

at line 273
PropertyPathInterface|null getPropertyPath()

Unsupported method.

Return Value

PropertyPathInterface|null The property path

at line 282
$this addError(FormError $error)

Unsupported method.

Parameters

FormError $error

Return Value

$this

Exceptions

BadMethodCallException

at line 292
bool isValid()

Unsupported method.

Return Value

bool

at line 302
bool isRequired()

Unsupported method.

Return Value

bool

at line 310
bool isDisabled()

Returns whether this form is disabled.

The content of a disabled form is displayed, but not allowed to be modified. The validation of modified disabled forms should fail.

Forms whose parents are disabled are considered disabled regardless of their own state.

Return Value

bool

at line 324
bool isEmpty()

Unsupported method.

Return Value

bool

at line 334
bool isSynchronized()

Unsupported method.

Return Value

bool

at line 342
TransformationFailedException|null getTransformationFailure()

Unsupported method.

Return Value

TransformationFailedException|null The transformation failure

at line 351
$this initialize()

Unsupported method.

Return Value

$this

Exceptions

BadMethodCallException

at line 363
$this handleRequest(mixed $request = null)

Unsupported method.

Parameters

mixed $request The request to handle

Return Value

$this

Exceptions

BadMethodCallException

at line 378
$this submit(mixed $submittedData, bool $clearMissing = true)

Submits data to the button.

Parameters

mixed $submittedData The submitted data
bool $clearMissing Whether to set fields to NULL when they are missing in the submitted data

Return Value

$this

Exceptions

AlreadySubmittedException if the button has already been submitted

at line 392
FormInterface getRoot()

Returns the root of the form tree.

Return Value

FormInterface The root of the tree

at line 400
bool isRoot()

Returns whether the field is the root of the form tree.

Return Value

bool

at line 408
FormView createView(FormView $parent = null)

Creates a view.

Parameters

FormView $parent

Return Value

FormView The view

at line 430
int count()

Unsupported method.

Return Value

int Always returns 0

at line 440
EmptyIterator getIterator()

Unsupported method.

Return Value

EmptyIterator Always returns an empty iterator