1. interface
  2. Drupal
  3. \
  4. views
  5. \
  6. Plugin
  7. \
  8. views
  9. \
  10. wizard
  11. \
  12. WizardInterface

WizardInterface

interface WizardInterface (View source)

Defines a common interface for Views Wizard plugins.

Methods

array
buildForm(array $form, FormStateInterface $form_state)

Form callback to build other elements in the "show" form.

array
validateView(array $form, FormStateInterface $form_state)

Validate form and values.

ViewEntityInterface
createView(array $form, FormStateInterface $form_state)

Creates a view from values that have already been validated.

Details

at line 28
array buildForm(array $form, FormStateInterface $form_state)

Form callback to build other elements in the "show" form.

This method builds all form elements beside of the selection of the base table.

Parameters

array $form

The full wizard form array.
FormStateInterface $form_state

The current state of the wizard form.

Return Value

array

Returns the changed wizard form.

at line 42
array validateView(array $form, FormStateInterface $form_state)

Validate form and values.

Parameters

array $form

The full wizard form array.
FormStateInterface $form_state

The current state of the wizard form.

Return Value

array

An empty array if the view is valid; an array of error strings if it is not.

at line 57
ViewEntityInterface createView(array $form, FormStateInterface $form_state)

Creates a view from values that have already been validated.

Parameters

array $form

The full wizard form array.
FormStateInterface $form_state

The current state of the wizard form.

Return Value

ViewEntityInterface

The created view object.

Exceptions

WizardException