interface ProviderInterface in Authorization 8

Defines an interface for Authorization provider plugins.

Hierarchy

• interface \Drupal\Component\Plugin\PluginInspectionInterface; interface \Drupal\Component\Plugin\DerivativeInspectionInterface; interface \Drupal\Component\Plugin\ConfigurableInterface; interface \Drupal\Component\Plugin\DependentPluginInterface; interface \Drupal\Core\Plugin\PluginFormInterface; interface \Drupal\Core\Plugin\ContainerFactoryPluginInterface
  • interface \Drupal\authorization\Plugin\ConfigurableAuthorizationPluginInterface
    • interface \Drupal\authorization\Provider\ProviderInterface

File

src/Provider/ProviderInterface.php, line 13

Namespace

Drupal\authorization\Provider

interface ProviderInterface extends ConfigurableAuthorizationPluginInterface {

  /**
   * Provider-side filtering.
   *
   * @param array $proposals
   *   Available proposals.
   * @param array $providerMapping
   *   What the proposal should be filtered against in the provider.
   *
   * @return array
   *   Filtered proposals.
   */
  public function filterProposals(array $proposals, array $providerMapping) : array;

  /**
   * Get the proposals for this users.
   *
   * @param \Drupal\user\UserInterface $user
   *   The user to act upon.
   *
   * @return array
   *   Relevant proposals.
   */
  public function getProposals(UserInterface $user) : array;

  /**
   * Sanitize proposals.
   *
   * @param array $proposals
   *   Raw proposals.
   *
   * @return array
   *   Processed proposals.
   */
  public function sanitizeProposals(array $proposals) : array;

  /**
   * Provides sync on logon.
   *
   * @return bool
   *   Sync on logon supported.
   */
  public function isSyncOnLogonSupported() : bool;

  /**
   * Provides revocation.
   *
   * @return bool
   *   Revocation supported.
   */
  public function revocationSupported() : bool;

}

Members

Name	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
ProviderInterface::filterProposals	public	function	Provider-side filtering.	1
ProviderInterface::getProposals	public	function	Get the proposals for this users.	1
ProviderInterface::isSyncOnLogonSupported	public	function	Provides sync on logon.	1
ProviderInterface::revocationSupported	public	function	Provides revocation.	1
ProviderInterface::sanitizeProposals	public	function	Sanitize proposals.	1