W3cubDocs

/Symfony 2.8

Symfony\Component\Form\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(int|string|FormInterface $child, 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.
Button submit(null|string $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

public __construct(FormConfigInterface $config)

Creates a new button from a form configuration.

Parameters

FormConfigInterface $config The button's configuration.

public bool offsetExists(mixed $offset)

Unsupported method.

Parameters

mixed $offset

Return Value

bool Always returns false.

public offsetGet(mixed $offset)

Unsupported method.

This method should not be invoked.

Parameters

mixed $offset

Exceptions

BadMethodCallException

public offsetSet(mixed $offset, mixed $value)

Unsupported method.

This method should not be invoked.

Parameters

mixed $offset
mixed $value

Exceptions

BadMethodCallException

public offsetUnset(mixed $offset)

Unsupported method.

This method should not be invoked.

Parameters

mixed $offset

Exceptions

BadMethodCallException

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

public FormInterface|null getParent()

Returns the parent form.

Return Value

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

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

Unsupported method.

This method should not be invoked.

Parameters

int|string|FormInterface $child The FormInterface instance or the name of the child.
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

public 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

public bool has(string $name)

Unsupported method.

Parameters

string $name The name of the child

Return Value

bool Always returns false.

public 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

public FormInterface[] all()

Returns all children in this group.

Return Value

FormInterface[] An array of FormInterface instances

public 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

public 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

public mixed getData()

Unsupported method.

Return Value

mixed

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

public mixed getViewData()

Unsupported method.

Return Value

mixed

public array getExtraData()

Unsupported method.

Return Value

array Always returns an empty array.

public FormConfigInterface getConfig()

Returns the button's configuration.

Return Value

FormConfigInterface The configuration.

public bool isSubmitted()

Returns whether the button is submitted.

Return Value

bool true if the button was submitted.

public string getName()

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

Return Value

string The name of the button.

public PropertyPathInterface getPropertyPath()

Unsupported method.

Return Value

PropertyPathInterface The property path.

public FormInterface addError(FormError $error)

Unsupported method.

Parameters

FormError $error

Return Value

FormInterface The form instance

Exceptions

BadMethodCallException

public bool isValid()

Unsupported method.

Return Value

bool Always returns true.

public bool isRequired()

Unsupported method.

Return Value

bool Always returns false.

public 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

public bool isEmpty()

Unsupported method.

Return Value

bool Always returns true.

public bool isSynchronized()

Unsupported method.

Return Value

bool Always returns true.

public TransformationFailedException|null getTransformationFailure()

Unsupported method.

Return Value

TransformationFailedException|null The transformation failure

public FormInterface initialize()

Unsupported method.

Return Value

FormInterface The form instance.

Exceptions

BadMethodCallException

public FormInterface handleRequest(mixed $request = null)

Unsupported method.

Parameters

mixed $request The request to handle.

Return Value

FormInterface The form instance.

Exceptions

BadMethodCallException

public Button submit(null|string $submittedData, bool $clearMissing = true)

Submits data to the button.

Parameters

null|string $submittedData The data.
bool $clearMissing Not used.

Return Value

Button The button instance

Exceptions

AlreadySubmittedException If the button has already been submitted.

public FormInterface getRoot()

Returns the root of the form tree.

Return Value

FormInterface The root of the tree

public bool isRoot()

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

Return Value

bool

public FormView createView(FormView $parent = null)

Creates a view.

Parameters

FormView $parent The parent view

Return Value

FormView The view

public int count()

Unsupported method.

Return Value

int Always returns 0.

public EmptyIterator getIterator()

Unsupported method.

Return Value

EmptyIterator Always returns an empty iterator.

© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/2.8/Symfony/Component/Form/Button.html