Button

__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.

mixed getViewData()

Unsupported method.

Return Value

mixed

array getExtraData()

Unsupported method.

Return Value

array

The submitted data which do not belong to a child

FormConfigInterface getConfig()

Returns the button's configuration.

Return Value

FormConfigInterface

The configuration.

bool isSubmitted()

Returns whether the button is submitted.

Return Value

bool	true if the form is submitted, false otherwise

string getName()

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

Return Value

string

The name of the form.

PropertyPathInterface getPropertyPath()

Unsupported method.

Return Value

PropertyPathInterface

The property path.

FormInterface addError(FormError $error)

Unsupported method.

Parameters

FormError

$error

Return Value

FormInterface

The form instance

Exceptions

BadMethodCallException

bool isValid()

Unsupported method.

Return Value

bool

bool isRequired()

Unsupported method.

Return Value

bool

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

bool isEmpty()

Unsupported method.

Return Value

bool

bool isSynchronized()

Unsupported method.

Return Value

bool

TransformationFailedException|null getTransformationFailure()

Unsupported method.

Return Value

TransformationFailedException|null

The transformation failure

FormInterface initialize()

Unsupported method.

Return Value

FormInterface

The form instance.

Exceptions

BadMethodCallException

FormInterface handleRequest(mixed $request = null)

Unsupported method.

Parameters

mixed

$request

The request to handle.

Return Value

FormInterface

The form instance.

Exceptions

BadMethodCallException

FormInterface submit(null|string|array $submittedData, bool $clearMissing = true)

Submits data to the button.

Parameters

null|string|array	$submittedData	The submitted data.
bool	$clearMissing	Whether to set fields to NULL when they are missing in the submitted data.

Return Value

FormInterface

The form instance

Exceptions

AlreadySubmittedException

If the button has already been submitted.

FormInterface getRoot()

Returns the root of the form tree.

Return Value

FormInterface

The root of the tree

bool isRoot()

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

Return Value

bool

FormView createView(FormView $parent = null)

Creates a view.

Parameters

FormView

$parent

The parent view

Return Value

FormView

The view

int count()

Unsupported method.

Return Value

int	Always returns 0.

EmptyIterator getIterator()

Unsupported method.

Return Value

EmptyIterator

Always returns an empty iterator.