Defines a common interface for Views Wizard plugins.
Expanded class hierarchy of WizardInterface
All classes that implement WizardInterface
interface WizardInterface {
/**
* Form callback to build other elements in the "show" form.
*
* This method builds all form elements beside of the selection of the
* base table.
*
* @param array $form
* The full wizard form array.
* @param array $form_state
* The current state of the wizard form.
*
* @return array
* Returns the changed wizard form.
*/
public function buildForm(array $form, array &$form_state);
/**
* Validate form and values.
*
* @param array $form
* The full wizard form array.
* @param array $form_state
* The current state of the wizard form.
*
* @return array
* An empty array if the view is valid; an array of error strings if it is
* not.
*/
public function validateView(array $form, array &$form_state);
/**
* Creates a view from values that have already been validated.
*
* @param array $form
* The full wizard form array.
* @param array $form_state
* The current state of the wizard form.
*
* @return Drupal\views\ViewExecutable
* The created view object.
*
* @throws Drupal\views\Plugin\views\wizard\WizardException
*/
public function createView(array $form, array &$form_state);
}
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
WizardInterface:: |
public | function | Form callback to build other elements in the "show" form. | 1 |
WizardInterface:: |
public | function | Creates a view from values that have already been validated. | 1 |
WizardInterface:: |
public | function | Validate form and values. | 1 |