interface SiteimproveDomainInterface in Siteimprove 8

Defines an interface for Siteimprove domain plugins.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\siteimprove\Plugin\SiteimproveDomainInterface

1 file declares its use of SiteimproveDomainInterface

DomainAccess.php in siteimprove_domain_access/src/Plugin/SiteimproveDomain/DomainAccess.php

File

src/Plugin/SiteimproveDomainInterface.php, line 11

Namespace

Drupal\siteimprove\Plugin

interface SiteimproveDomainInterface extends PluginInspectionInterface {

  /**
   * Form constructor.
   *
   * Build Siteimprove Domain plugin settings form.
   *
   * @param array $form
   *   Build form for setting up plugin.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form state.
   * @param string $plugin_definition
   *   Plugin definition.
   */
  public function buildForm(array &$form, FormStateInterface &$form_state, $plugin_definition);

  /**
   * Form validation handler.
   *
   * If the plugin needs to perform a form validation, override this function.
   *
   * @param array $form
   *   Form to validate.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form state.
   */
  public function validateForm(array &$form, FormStateInterface $form_state);

  /**
   * Form submission handler.
   *
   * Submit Siteimprove Domain plugin settings.
   *
   * @param array $form
   *   Form to submit.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   Form state.
   */
  public function submitForm(array &$form, FormStateInterface $form_state);

}

Members

Name	Modifiers	Type	Description	Overrides
PluginInspectionInterface::getPluginDefinition	public	function	Gets the definition of the plugin implementation.	4
PluginInspectionInterface::getPluginId	public	function	Gets the plugin_id of the plugin instance.	2
SiteimproveDomainInterface::buildForm	public	function	Form constructor.	1
SiteimproveDomainInterface::submitForm	public	function	Form submission handler.	1
SiteimproveDomainInterface::validateForm	public	function	Form validation handler.	1