1. class
  2. Symfony
  3. Component
  4. Form
  5. SubmitButton

SubmitButton

class SubmitButton extends Button implements ClickableInterface

A button that submits the form.

Methods

__construct(FormConfigInterface $config)

Creates a new button from a form configuration.

from Button
bool
offsetExists(mixed $offset)

Unsupported method.

from Button
offsetGet(mixed $offset)

Unsupported method.

from Button
offsetSet(mixed $offset, mixed $value)

Unsupported method.

from Button
offsetUnset(mixed $offset)

Unsupported method.

from Button
FormInterface
setParent(FormInterface $parent = null)

Sets the parent form.

from Button
FormInterface|null
getParent()

Returns the parent form.

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

Unsupported method.

from Button
FormInterface
get(string $name)

Unsupported method.

from Button
bool
has(string $name)

Unsupported method.

from Button
FormInterface
remove(string $name)

Unsupported method.

from Button
FormInterface[]
all()

Returns all children in this group.

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

Returns the errors of this form.

from Button
FormInterface
setData(mixed $modelData)

Unsupported method.

from Button
mixed
getData()

Unsupported method.

from Button
mixed
getNormData()

Unsupported method.

from Button
mixed
getViewData()

Unsupported method.

from Button
array
getExtraData()

Unsupported method.

from Button
FormConfigInterface
getConfig()

Returns the button's configuration.

from Button
bool
isSubmitted()

Returns whether the button is submitted.

from Button
string
getName()

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

from Button
PropertyPathInterface
getPropertyPath()

Unsupported method.

from Button
FormInterface
addError(FormError $error)

Unsupported method.

from Button
bool
isValid()

Unsupported method.

from Button
bool
isRequired()

Unsupported method.

from Button
bool
isDisabled()

Returns whether this form is disabled.

from Button
bool
isEmpty()

Unsupported method.

from Button
bool
isSynchronized()

Unsupported method.

from Button
TransformationFailedException|null
getTransformationFailure()

Unsupported method.

from Button
FormInterface
initialize()

Unsupported method.

from Button
FormInterface
handleRequest(mixed $request = null)

Unsupported method.

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

Submits data to the button.

FormInterface
getRoot()

Returns the root of the form tree.

from Button
bool
isRoot()

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

from Button
FormView
createView(FormView $parent = null)

Creates a view.

from Button
int
count()

Unsupported method.

from Button
EmptyIterator
getIterator()

Unsupported method.

from Button
bool
isClicked()

Returns whether this element was clicked.

Details

in Button at line line 44
__construct(FormConfigInterface $config)

Creates a new button from a form configuration.

Parameters

FormConfigInterface $config The button's configuration.

in Button at line line 56
bool offsetExists(mixed $offset)

Unsupported method.

Parameters

mixed $offset

Return Value

bool Always returns false.

in Button at line line 70
offsetGet(mixed $offset)

Unsupported method.

This method should not be invoked.

Parameters

mixed $offset

Exceptions

BadMethodCallException

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

Unsupported method.

This method should not be invoked.

Parameters

mixed $offset
mixed $value

Exceptions

BadMethodCallException

in Button at line line 99
offsetUnset(mixed $offset)

Unsupported method.

This method should not be invoked.

Parameters

mixed $offset

Exceptions

BadMethodCallException

in Button at line line 107
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.

in Button at line line 115
FormInterface|null getParent()

Returns the parent form.

Return Value

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

in Button at line line 131
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

in Button at line line 145
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

in Button at line line 157
bool has(string $name)

Unsupported method.

Parameters

string $name The name of the child

Return Value

bool

in Button at line line 171
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

in Button at line line 179
FormInterface[] all()

Returns all children in this group.

Return Value

FormInterface[] An array of FormInterface instances

in Button at line line 187
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

in Button at line line 201
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

Exceptions

BadMethodCallException

in Button at line line 212
mixed getData()

Unsupported method.

Return Value

mixed

in Button at line line 221
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.

in Button at line line 230
mixed getViewData()

Unsupported method.

Return Value

mixed

in Button at line line 239
array getExtraData()

Unsupported method.

Return Value

array The submitted data which do not belong to a child

in Button at line line 249
FormConfigInterface getConfig()

Returns the button's configuration.

Return Value

FormConfigInterface The configuration.

in Button at line line 259
bool isSubmitted()

Returns whether the button is submitted.

Return Value

bool true if the form is submitted, false otherwise

in Button at line line 269
string getName()

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

Return Value

string The name of the form.

in Button at line line 279
PropertyPathInterface getPropertyPath()

Unsupported method.

Return Value

PropertyPathInterface The property path.

in Button at line line 290
FormInterface addError(FormError $error)

Unsupported method.

Parameters

FormError $error

Return Value

FormInterface The form instance

Exceptions

BadMethodCallException

in Button at line line 300
bool isValid()

Unsupported method.

Return Value

bool

in Button at line line 310
bool isRequired()

Unsupported method.

Return Value

bool

in Button at line line 318
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

in Button at line line 332
bool isEmpty()

Unsupported method.

Return Value

bool

in Button at line line 342
bool isSynchronized()

Unsupported method.

Return Value

bool

in Button at line line 352
TransformationFailedException|null getTransformationFailure()

Unsupported method.

Return Value

TransformationFailedException|null The transformation failure

in Button at line line 361
FormInterface initialize()

Unsupported method.

Return Value

FormInterface The form instance.

Exceptions

BadMethodCallException

in Button at line line 373
FormInterface handleRequest(mixed $request = null)

Unsupported method.

Parameters

mixed $request The request to handle.

Return Value

FormInterface The form instance.

Exceptions

BadMethodCallException

at line line 44
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 form has already been submitted.

in Button at line line 402
FormInterface getRoot()

Returns the root of the form tree.

Return Value

FormInterface The root of the tree

in Button at line line 410
bool isRoot()

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

Return Value

bool

in Button at line line 418
FormView createView(FormView $parent = null)

Creates a view.

Parameters

FormView $parent The parent view

Return Value

FormView The view

in Button at line line 440
int count()

Unsupported method.

Return Value

int Always returns 0.

in Button at line line 450
EmptyIterator getIterator()

Unsupported method.

Return Value

EmptyIterator Always returns an empty iterator.

at line line 29
bool isClicked()

Returns whether this element was clicked.

Return Value

bool Whether this element was clicked.