interface PrivateMessageConfigFormPluginInterface in Private Message 8.2

Interface for PrivateMessageConfigForm plugins.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Core\Plugin\ContainerFactoryPluginInterface
  • interface \Drupal\private_message\Plugin\PrivateMessageConfigForm\PrivateMessageConfigFormPluginInterface

File

src/Plugin/PrivateMessageConfigForm/PrivateMessageConfigFormPluginInterface.php, line 12

Namespace

Drupal\private_message\Plugin\PrivateMessageConfigForm

interface PrivateMessageConfigFormPluginInterface extends PluginInspectionInterface, ContainerFactoryPluginInterface {

  /**
   * Return the name of the crm tester plugin.
   *
   * @return string
   *   The name of the plugin.
   */
  public function getName();

  /**
   * Return the id of the crm tester plugin.
   *
   * @return string
   *   The id of the plugin.
   */
  public function getId();

  /**
   * Build the section of the form as it will appear on the settings page.
   *
   * @param \Drupal\Core\Form\FormStateInterface $formState
   *   The Drupal form state.
   *
   * @return array
   *   A render array containing the form elements this plugin provides.
   */
  public function buildForm(FormStateInterface $formState);

  /**
   * Validate this section of the form.
   *
   * @param array $form
   *   The form render array.
   * @param \Drupal\Core\Form\FormStateInterface $formState
   *   The Drupal form state.
   *
   * @return array
   *   A render array containing the form elements this plugin provides.
   */
  public function validateForm(array &$form, FormStateInterface $formState);

  /**
   * Handle submission of the form added to the settings page.
   *
   * @param array $values
   *   An array of values for form elements added by this plugin.
   */
  public function submitForm(array $values);

}

Members

Name	Modifiers	Type	Description	Overrides
ContainerFactoryPluginInterface::create	public static	function	Creates an instance of the plugin.	112
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
PrivateMessageConfigFormPluginInterface::buildForm	public	function	Build the section of the form as it will appear on the settings page.
PrivateMessageConfigFormPluginInterface::getId	public	function	Return the id of the crm tester plugin.	1
PrivateMessageConfigFormPluginInterface::getName	public	function	Return the name of the crm tester plugin.	1
PrivateMessageConfigFormPluginInterface::submitForm	public	function	Handle submission of the form added to the settings page.
PrivateMessageConfigFormPluginInterface::validateForm	public	function	Validate this section of the form.	1