1. trait
  2. Drupal
  3. \
  4. Core
  5. \
  6. Ajax
  7. \
  8. AjaxFormHelperTrait

AjaxFormHelperTrait

trait AjaxFormHelperTrait (View source)

internal  
 

Provides a helper to for submitting an AJAX form.

Traits

AjaxHelperTrait

Provides a helper to determine if the current request is via AJAX.

Methods

bool
isAjax()

Determines if the current request is via AJAX.

from  AjaxHelperTrait
string|null
getRequestWrapperFormat()

Gets the wrapper format of the current request.

from  AjaxHelperTrait
AjaxResponse
ajaxSubmit(array $form, FormStateInterface $form_state)

Submit form dialog #ajax callback.

AjaxResponse
successfulAjaxSubmit(array $form, FormStateInterface $form_state)

Allows the form to respond to a successful AJAX submission.

Details

in AjaxHelperTrait at line 20
protected bool isAjax()

Determines if the current request is via AJAX.

Return Value

bool

TRUE if the current request is via AJAX, FALSE otherwise.

in AjaxHelperTrait at line 33
protected string|null getRequestWrapperFormat()

Gets the wrapper format of the current request.

Return Value

string|null

The wrapper format. NULL if the wrapper format is not set.

at line 28
AjaxResponse ajaxSubmit(array $form, FormStateInterface $form_state)

Submit form dialog #ajax callback.

Parameters

array $form

An associative array containing the structure of the form.
FormStateInterface $form_state

The current state of the form.

Return Value

AjaxResponse

An AJAX response that display validation error messages or represents a successful submission.

at line 55
abstract protected AjaxResponse successfulAjaxSubmit(array $form, FormStateInterface $form_state)

Allows the form to respond to a successful AJAX submission.

Parameters

array $form

An associative array containing the structure of the form.
FormStateInterface $form_state

The current state of the form.

Return Value

AjaxResponse

An AJAX response.