1. interface
  2. Drupal
  3. \
  4. views_ui
  5. \
  6. Form
  7. \
  8. Ajax
  9. \
  10. ViewsFormInterface

ViewsFormInterface

interface ViewsFormInterface implements FormInterface (View source)

Methods

string
getFormId()

Returns a unique string identifying the form.

from  FormInterface
array
buildForm(array $form, FormStateInterface $form_state)

Form constructor.

from  FormInterface
validateForm(array $form, FormStateInterface $form_state)

Form validation handler.

from  FormInterface
submitForm(array $form, FormStateInterface $form_state)

Form submission handler.

from  FormInterface
string
getFormKey()

Returns the key that represents this form.

FormStateInterface
getFormState(ViewEntityInterface $view, string|null $display_id, string $js)

Gets the form state for this form.

array
getForm(ViewEntityInterface $view, string|null $display_id, string $js)

Creates a new instance of this form.

Details

in FormInterface at line 22
string getFormId()

Returns a unique string identifying the form.

The returned ID should be a unique string that can be a valid PHP function name, since it's used in hook implementation names such as hook_form_FORM_ID_alter().

Return Value

string

The unique string identifying the form.

in FormInterface at line 35
array buildForm(array $form, FormStateInterface $form_state)

Form constructor.

Parameters

array $form

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

The current state of the form.

Return Value

array

The form structure.

in FormInterface at line 45
validateForm(array $form, FormStateInterface $form_state)

Form validation handler.

Parameters

array $form

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

The current state of the form.

in FormInterface at line 55
submitForm(array $form, FormStateInterface $form_state)

Form submission handler.

Parameters

array $form

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

The current state of the form.

at line 17
string getFormKey()

Returns the key that represents this form.

Return Value

string

The form key used in the URL, e.g., the string 'add-handler' in 'admin/structure/views/%/add-handler/%/%/%'.

at line 33
FormStateInterface getFormState(ViewEntityInterface $view, string|null $display_id, string $js)

Gets the form state for this form.

Parameters

ViewEntityInterface $view

The view being edited.
string|null $display_id

The display ID being edited, or NULL to load the first available display.
string $js

If this is an AJAX form, it will be the string 'ajax'. Otherwise, it will be 'nojs'. This determines the response.

Return Value

FormStateInterface

The current state of the form.

at line 53
array getForm(ViewEntityInterface $view, string|null $display_id, string $js)

Creates a new instance of this form.

When https://www.drupal.org/node/1843224 is in, this will return \Drupal\Core\Ajax\AjaxResponse instead of the array of AJAX commands.

Parameters

ViewEntityInterface $view

The view being edited.
string|null $display_id

The display ID being edited, or NULL to load the first available display.
string $js

If this is an AJAX form, it will be the string 'ajax'. Otherwise, it will be 'nojs'. This determines the response.

Return Value

array

An form for a specific operation in the Views UI, or an array of AJAX commands to render a form.