Sets the value of the form state.

Sets this form to always be processed.

This should only be used on RESTful GET forms that do NOT write data, as this could lead to security issues. It is useful so that searches do not need to have a form_id in their query arguments to trigger the search.

Determines if this form should always be processed.

Stores the submit and button elements for the form.

Returns the submit and button elements for the form.

Sets this form to be cached.

Determines if the form should be cached.

Prevents the form from being cached.

Sets that the form was submitted and has been processed and executed.

Determines if the form was submitted and has been processed and executed.

Sets references to details elements to render them within vertical tabs.

Returns references to details elements to render them within vertical tabs.

Sets that this form has a file element.

Returns whether this form has a file element.

Sets the limited validation error sections.

Retrieves the limited validation error sections.

Sets the HTTP method to use for the form's submission.

This is what the form's "method" attribute should be, not necessarily what the current request's HTTP method is. For example, a form can have a method attribute of POST, but the request that initially builds it uses GET.

Returns the HTTP form method.

Sets the HTTP method used by the request that is building the form.

Enforces that validation is run.

Checks if validation is enforced.

Prevents the form from redirecting.

Determines if redirecting has been prevented.

Sets that the form should process input.

Determines if the form input will be processed.

Sets that this form was submitted programmatically.

Returns if this form was submitted programmatically.

Sets if this form submission should bypass #access.

Determines if this form submission should bypass #access.

Sets the rebuild info.

Gets the rebuild info.

Adds a value to the rebuild info.

Sets the entire set of arbitrary data.

Returns the entire set of arbitrary data.

Sets the submit handlers.

Gets the submit handlers.

Sets that the form has been submitted.

Determines if the form has been submitted.

Sets temporary data.

Gets temporary data.

Gets an arbitrary value from temporary storage.

Sets an arbitrary value in temporary storage.

Determines if a temporary value is present.

Sets the form element that triggered submission.

Gets the form element that triggered submission.

Sets the validate handlers.

Gets the validate handlers.

Sets that validation has been completed.

Determines if validation has been completed.

Ensures an include file is loaded whenever the form is processed.

Example:

Returns an array representation of the cacheable portion of the form state.

Stores the complete form array.

Returns a reference to the complete form array.

Gets any arbitrary property.

Sets a value to an arbitrary property.

Determines if an arbitrary property is present.

Sets the build info for the form.

Returns the build info for the form.

Adds a value to the build info.

Returns the form values as they were submitted by the user.

These are raw and unvalidated, so should not be used without a thorough understanding of security implications. In almost all cases, code should use self::getValues() and self::getValue() exclusively.

Sets the form values as though they were submitted by a user.

Returns the submitted and sanitized form values.

Implements \Drupal\Core\Form\FormStateInterface::getValue()

Implements \Drupal\Core\Form\FormStateInterface::setValues()

Implements \Drupal\Core\Form\FormStateInterface::setValue()

Implements \Drupal\Core\Form\FormStateInterface::unsetValue()

Implements \Drupal\Core\Form\FormStateInterface::hasValue()

Implements \Drupal\Core\Form\FormStateInterface::isValueEmpty()

Implements \Drupal\Core\Form\FormStateInterface::setValueForElement()

Sets a response for this form.

If a response is set, it will be used during processing and returned directly. The form will not be rebuilt or redirected.

Gets a response for this form.

If a response is set, it will be used during processing and returned directly. The form will not be rebuilt or redirected.

Sets the redirect for the form.

Sets the redirect URL for the form.

Gets the value to use for redirecting after the form has been executed.

Determines if any forms have any errors.

Files an error against a form element.

When a validation error is detected, the validator calls this method to indicate which element needs to be changed and provide an error message. This causes the Form API to not execute the form submit handlers, and instead to re-display the form to the user with the corresponding elements rendered with an 'error' CSS class (shown as red by default).

The standard behavior of this method can be changed if a button provides the #limit_validation_errors property. Multistep forms not wanting to validate the whole form can set #limit_validation_errors on buttons to limit validation errors to only certain elements. For example, pressing the "Previous" button in a multistep form should not fire validation errors just because the current step has invalid values. If

limit_validation_errors is set on a clicked button, the button must also

define a #submit property (may be set to an empty array). Any #submit handlers will be executed even if there is invalid input, so extreme care should be taken with respect to any actions taken by them. This is typically not a problem with buttons like "Previous" or "Add more" that do not invoke persistent storage of the submitted form values. Do not use the

limit_validation_errors property on buttons that trigger saving of form

values to the database.

The #limit_validation_errors property is a list of "sections" within $form_state->getValues() that must contain valid values. Each "section" is an array with the ordered set of keys needed to reach that part of $form_state->getValues() (i.e., the #parents property of the element).

Example 1: Allow the "Previous" button to function, regardless of whether any user input is valid.

Flags an element as having an error.

Clears all errors against all form elements made by self::setErrorByName().

Returns the error message filed against the given form element.

Form errors higher up in the form structure override deeper errors as well as errors on the element itself.

Returns an associative array of all errors.

Sets the form to be rebuilt after processing.

Determines if the form should be rebuilt after processing.

Flags the form state as having or not an invalid token.

Determines if the form has an invalid token.

Converts support notations for a form callback to a valid callable.

Specifically, supports methods on the form/callback object as strings when they start with ::, for example "::submitForm()".

Sets the form object that is responsible for building this form.

Returns the form object that is responsible for building this form.

Gets the keys of the form values that will be cleaned.

Sets the keys of the form values that will be cleaned.

Adds a key to the array of form values that will be cleaned.

Removes internal Form API elements and buttons from submitted form values.

This function can be used when a module wants to store all submitted form values, for example, by serializing them into a single database column. In such cases, all internal Form API values and all form button elements should not be contained, and this function allows their removal before the module proceeds to storage. Next to button elements, the following internal values are removed by default.

• form_id
• form_token
• form_build_id
• op

Constructs a new instance.

Creates a new instance for a subform.

Gets the subform's parents relative to its parent form.

Gets the complete form state.