You are here

interface ConfigurableAuthorizationPluginInterface in Authorization 8

Describes a configurable Authorization plugin.

Hierarchy

Expanded class hierarchy of ConfigurableAuthorizationPluginInterface

All classes that implement ConfigurableAuthorizationPluginInterface

2 files declare their use of ConfigurableAuthorizationPluginInterface
ConsumerInterface.php in src/Consumer/ConsumerInterface.php
ProviderInterface.php in src/Provider/ProviderInterface.php

File

src/Plugin/ConfigurableAuthorizationPluginInterface.php, line 19

Namespace

Drupal\authorization\Plugin
View source
interface ConfigurableAuthorizationPluginInterface extends PluginInspectionInterface, DerivativeInspectionInterface, ConfigurableInterface, DependentPluginInterface, PluginFormInterface, ContainerFactoryPluginInterface {

  /**
   * Returns the label for use on the administration pages.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup
   *   The administration label.
   */
  public function label() : TranslatableMarkup;

  /**
   * Returns the plugin's description.
   *
   * @return \Drupal\Core\StringTranslation\TranslatableMarkup|string
   *   A string describing the plugin. Might contain HTML and should be already
   *   sanitized for output.
   */
  public function getDescription();

  /**
   * Builds the authorization form row.
   *
   * Return array.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   * @param int $index
   *   The row number of the mapping.
   */
  public function buildRowForm(array $form, FormStateInterface $form_state, $index);

  /**
   * Builds the authorization row description.
   *
   * Return string.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function buildRowDescription(array $form, FormStateInterface $form_state);

  /**
   * Validates the authorization form row.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function validateRowForm(array &$form, FormStateInterface $form_state) : void;

  /**
   * Submits the authorization form row.
   *
   * @param array $form
   *   An associative array containing the structure of the form.
   * @param \Drupal\Core\Form\FormStateInterface $form_state
   *   The current state of the form.
   */
  public function submitRowForm(array &$form, FormStateInterface $form_state) : void;

  /**
   * Tokens for the relevant plugin.
   *
   * @return array
   *   Placeholders for string replacement.
   */
  public function getTokens() : array;

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigurableAuthorizationPluginInterface::buildRowDescription public function Builds the authorization row description. 1
ConfigurableAuthorizationPluginInterface::buildRowForm public function Builds the authorization form row. 1
ConfigurableAuthorizationPluginInterface::getDescription public function Returns the plugin's description. 1
ConfigurableAuthorizationPluginInterface::getTokens public function Tokens for the relevant plugin. 1
ConfigurableAuthorizationPluginInterface::label public function Returns the label for use on the administration pages. 1
ConfigurableAuthorizationPluginInterface::submitRowForm public function Submits the authorization form row. 1
ConfigurableAuthorizationPluginInterface::validateRowForm public function Validates the authorization form row. 1
ConfigurableInterface::defaultConfiguration public function Gets default configuration for this plugin. 11
ConfigurableInterface::getConfiguration public function Gets this plugin's configuration. 12
ConfigurableInterface::setConfiguration public function Sets the configuration for this plugin instance. 12
ContainerFactoryPluginInterface::create public static function Creates an instance of the plugin. 112
DependentPluginInterface::calculateDependencies public function Calculates dependencies for the configured plugin. 19
DerivativeInspectionInterface::getBaseId public function Gets the base_plugin_id of the plugin instance. 1
DerivativeInspectionInterface::getDerivativeId public function Gets the derivative_id of the plugin instance. 1
PluginFormInterface::buildConfigurationForm public function Form constructor. 36
PluginFormInterface::submitConfigurationForm public function Form submission handler. 32
PluginFormInterface::validateConfigurationForm public function Form validation handler. 18
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