SubmitButton (Component\Form)
Symfony\Component\Form\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(int|string|FormInterface $child, 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(string $modelData) Unsupported method. | from Button |
null | getData() Unsupported method. | from Button |
null | getNormData() Unsupported method. | from Button |
null | 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 |
null | 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 |
null | getTransformationFailure() Unsupported method. | from Button |
FormInterface | initialize() Unsupported method. | from Button |
FormInterface | handleRequest(mixed $request = null) Unsupported method. | from Button |
SubmitButton | submit(null|string $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
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(string $modelData)
Unsupported method.
This method should not be invoked.
public null getData()
Unsupported method.
public null getNormData()
Unsupported method.
public null 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 null 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 null getTransformationFailure()
Unsupported method.
public FormInterface initialize()
Unsupported method.
public FormInterface handleRequest(mixed $request = null)
Unsupported method.
public SubmitButton 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.
public bool isClicked()
Returns whether this element was clicked.
© 2004–2016 Fabien Potencier
Licensed under the MIT License.
http://api.symfony.com/3.0/Symfony/Component/Form/SubmitButton.html