interface MessageNotifyUiSenderSettingsFormInterface in Message UI 8

Defines an interface for Message notify ui sender settings form plugins.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface
  • interface \Drupal\message_notify_ui\MessageNotifyUiSenderSettingsFormInterface

1 file declares its use of MessageNotifyUiSenderSettingsFormInterface

MessageNotifyUiSenderMailSettingsForm.php in modules/message_notify_ui/src/Plugin/MessageNotifyUiSenderSettingsForm/MessageNotifyUiSenderMailSettingsForm.php

File

modules/message_notify_ui/src/MessageNotifyUiSenderSettingsFormInterface.php, line 12

Namespace

Drupal\message_notify_ui

interface MessageNotifyUiSenderSettingsFormInterface extends PluginInspectionInterface {

  /**
   * The form settings for the plugin.
   *
   * @return array
   *   The form with the setting of the plugin.
   */
  public function form();

  /**
   * Validating the form.
   *
   * @param array $form
   *   The form API element.
   * @param \Drupal\Core\Form\FormStateInterface $formState
   *   The form state object.
   */
  public function validate(array $form, FormStateInterface $formState);

  /**
   * Implementing logic for sender which relate to the plugin.
   *
   * Each plugin of this type provide UI for a notifier plugin. After the form
   * is submitted this function will be invoked.
   *
   * @param \Drupal\message_notify\MessageNotifier $notifier
   *   The notifier which the plugin take care.
   * @param \Drupal\Core\Form\FormStateInterface $formState
   *   The form state object.
   */
  public function submit(MessageNotifier $notifier, FormStateInterface $formState);

}

Members

Name	Modifiers	Type	Description	Overrides
MessageNotifyUiSenderSettingsFormInterface::form	public	function	The form settings for the plugin.	1
MessageNotifyUiSenderSettingsFormInterface::submit	public	function	Implementing logic for sender which relate to the plugin.	1
MessageNotifyUiSenderSettingsFormInterface::validate	public	function	Validating the form.	1
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