Search for all
| Title | Object type | File name | Summary |
|---|---|---|---|
| FormState::$no_redirect | property | core/ |
If set to TRUE the form will NOT perform a redirect, even if self::$redirect is set. |
| FormState::$process_input | property | core/ |
TRUE signifies correct form submission. This is always TRUE for programmed forms coming from \Drupal\Core\Form\FormBuilderInterface::submitForm() (see 'programmed' key), or if the form_id coming from the \Drupal::request()->request data… |
| FormState::$programmed | property | core/ |
If TRUE, the form was submitted programmatically, usually invoked via \Drupal\Core\Form\FormBuilderInterface::submitForm(). Defaults to FALSE. |
| FormState::$programmed_bypass_access_check | property | core/ |
If TRUE, programmatic form submissions are processed without taking #access into account. Set this to FALSE when submitting a form programmatically with values that may have been input by the user executing the current request; this will cause #access… |
| FormState::$rebuild | property | core/ |
Normally, after the entire form processing is completed and submit handlers have run, a form is considered to be done and \Drupal\Core\Form\FormSubmitterInterface::redirectForm() will redirect the user to a new page using a GET request (so a browser… |
| FormState::$rebuild_info | property | core/ |
Similar to self::$build_info, but pertaining to \Drupal\Core\Form\FormBuilderInterface::rebuildForm(). |
| FormState::$redirect | property | core/ |
Used to redirect the form on submission. |
| FormState::$requestMethod | property | core/ |
The HTTP method used by the request building or processing this form. |
| FormState::$response | property | core/ |
Used when a form needs to return some kind of a \Symfony\Component\HttpFoundation\Response object, e.g., a \Symfony\Component\HttpFoundation\BinaryFileResponse when triggering a file download. If you use self::setRedirect() or… |
| FormState::$storage | property | core/ |
This is not a special key, and no specific support is provided for it in the Form API. By tradition it was the location where application-specific data was stored for communication between the submit, validation, and form builder functions, especially… |
| FormState::$submitted | property | core/ |
If TRUE, the form has been submitted. Defaults to FALSE. |
| FormState::$submit_handlers | property | core/ |
Stores the gathered submission handlers. |
| FormState::$temporary | property | core/ |
Holds temporary data accessible during the current page request only. |
| FormState::$triggering_element | property | core/ |
The form element that triggered submission, which may or may not be a button (in the case of Ajax forms). This key is often used to distinguish between various buttons in a submit handler, and is also used in Ajax handlers. |
| FormState::$validate_handlers | property | core/ |
Stores the gathered validation handlers. |
| FormState::$validation_complete | property | core/ |
Tracks if the form has finished validation. |
| FormState::$values | property | core/ |
An associative array of values submitted to the form. |
| FormState::addBuildInfo | function | core/ |
Adds a value to the build info. |
| FormState::addCleanValueKey | function | core/ |
Adds a key to the array of form values that will be cleaned. |
| FormState::addRebuildInfo | function | core/ |
Adds a value to the rebuild info. |
| FormState::cleanValues | function | core/ |
Removes internal Form API elements and buttons from submitted form values. |
| FormState::clearErrors | function | core/ |
Clears all errors against all form elements made by self::setErrorByName(). |
| FormState::disableCache | function | core/ |
Prevents the form from being cached. |
| FormState::disableRedirect | function | core/ |
Prevents the form from redirecting. |
| FormState::get | function | core/ |
Gets any arbitrary property. |
| FormState::getAlwaysProcess | function | core/ |
Determines if this form should always be processed. |
| FormState::getBuildInfo | function | core/ |
Returns the build info for the form. |
| FormState::getButtons | function | core/ |
Returns the submit and button elements for the form. |
| FormState::getCacheableArray | function | core/ |
Returns an array representation of the cacheable portion of the form state. |
| FormState::getCleanValueKeys | function | core/ |
Gets the keys of the form values that will be cleaned. |
| FormState::getCompleteForm | function | core/ |
Returns a reference to the complete form array. |
| FormState::getError | function | core/ |
Returns the error message filed against the given form element. |
| FormState::getErrors | function | core/ |
Returns an associative array of all errors. |
| FormState::getFormObject | function | core/ |
Returns the form object that is responsible for building this form. |
| FormState::getGroups | function | core/ |
Returns references to details elements to render them within vertical tabs. |
| FormState::getLimitValidationErrors | function | core/ |
Retrieves the limited validation error sections. |
| FormState::getRebuildInfo | function | core/ |
Gets the rebuild info. |
| FormState::getRedirect | function | core/ |
Gets the value to use for redirecting after the form has been executed. |
| FormState::getResponse | function | core/ |
Gets a response for this form. |
| FormState::getStorage | function | core/ |
Returns the entire set of arbitrary data. |
| FormState::getSubmitHandlers | function | core/ |
Gets the submit handlers. |
| FormState::getTemporary | function | core/ |
Gets temporary data. |
| FormState::getTemporaryValue | function | core/ |
Gets an arbitrary value from temporary storage. |
| FormState::getTriggeringElement | function | core/ |
Gets the form element that triggered submission. |
| FormState::getUserInput | function | core/ |
Returns the form values as they were submitted by the user. |
| FormState::getValidateHandlers | function | core/ |
Gets the validate handlers. |
| FormState::getValues | function | core/ |
Implements \Drupal\Core\Form\FormStateInterface::getValues() |
| FormState::has | function | core/ |
Determines if an arbitrary property is present. |
| FormState::hasAnyErrors | function | core/ |
Determines if any forms have any errors. |
| FormState::hasFileElement | function | core/ |
Returns whether this form has a file element. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.