Button (Component\Form)
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.
public bool offsetExists(mixed $offset)
Unsupported method.
public offsetGet(mixed $offset)
Unsupported method.
This method should not be invoked.
public offsetSet(mixed $offset, mixed $value)
Unsupported method.
This method should not be invoked.
public offsetUnset(mixed $offset)
Unsupported method.
This method should not be invoked.
public FormInterface setParent(FormInterface $parent = null)
Sets the parent form.
public FormInterface|null getParent()
Returns the parent form.
public FormInterface add(int|string|FormInterface $child, null $type = null, array $options = array())
Unsupported method.
This method should not be invoked.
public FormInterface get(string $name)
Unsupported method.
This method should not be invoked.
public bool has(string $name)
Unsupported method.
public FormInterface remove(string $name)
Unsupported method.
This method should not be invoked.
public FormInterface[] all()
Returns all children in this group.
public FormErrorIterator getErrors(bool $deep = false, bool $flatten = true)
Returns the errors of this form.
public FormInterface setData(mixed $modelData)
Unsupported method.
This method should not be invoked.
public mixed getData()
Unsupported method.
public mixed getNormData()
Unsupported method.
public mixed getViewData()
Unsupported method.
public array getExtraData()
Unsupported method.
public FormConfigInterface getConfig()
Returns the button's configuration.
public bool isSubmitted()
Returns whether the button is submitted.
public string getName()
Returns the name by which the button is identified in forms.
public PropertyPathInterface getPropertyPath()
Unsupported method.
public FormInterface addError(FormError $error)
Unsupported method.
public bool isValid()
Unsupported method.
public bool isRequired()
Unsupported method.
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.
public bool isEmpty()
Unsupported method.
public bool isSynchronized()
Unsupported method.
public TransformationFailedException|null getTransformationFailure()
Unsupported method.
public FormInterface initialize()
Unsupported method.
public FormInterface handleRequest(mixed $request = null)
Unsupported method.
public Button submit(null|string $submittedData, bool $clearMissing = true)
Submits data to the button.
public FormInterface getRoot()
Returns the root of the form tree.
public bool isRoot()
Returns whether the field is the root of the form tree.
public FormView createView(FormView $parent = null)
Creates a view.
public int count()
Unsupported method.
public EmptyIterator getIterator()
Unsupported method.
© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Form/Button.html