You are here

Home » API reference » Authorization 8 » ProviderPluginBase.php

abstract class ProviderPluginBase in Authorization 8

Base class for Authorization provider plugins.

Hierarchy

Expanded class hierarchy of ProviderPluginBase

1 file declares its use of ProviderPluginBase
Dummy.php in tests/modules/authorization_test/src/Plugin/authorization/Provider/Dummy.php

File

src/Provider/ProviderPluginBase.php, line 12

Namespace

Drupal\authorization\Provider
View source 
abstract class ProviderPluginBase extends ConfigurableAuthorizationPluginBase implements ProviderInterface {

  /**
   * Defines the type, for example used by getToken().
   *
   * @var string
   */
  protected $type = 'provider';

  /**
   * List of modules handling this provider.
   *
   * Can potentially be removed.
   *
   * @var array
   */
  protected $handlers = [];

  /**
   * Whether this provider supports sync on user logon.
   *
   * @var bool
   *   Sync on logon supported.
   */
  protected $syncOnLogonSupported = FALSE;

  /**
   * Whether this provider supports revocation.
   *
   * @var bool
   *   Revocation supported.
   */
  protected $revocationSupported = FALSE;

  /**
   * {@inheritdoc}
   */
  public function isSyncOnLogonSupported() : bool {
    return $this->syncOnLogonSupported;
  }

  /**
   * {@inheritdoc}
   */
  public function revocationSupported() : bool {
    return $this->revocationSupported;
  }

  /**
   * Which modules are handling this provider.
   *
   * Potentially unused.
   *
   * @return array
   *   Handlers.
   */
  public function getHandlers() : array {
    return $this->handlers;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
ConfigurableAuthorizationPluginBase::buildConfigurationForm public function Form constructor. Overrides PluginFormInterface::buildConfigurationForm 1
ConfigurableAuthorizationPluginBase::buildRowDescription public function Builds the authorization row description. Overrides ConfigurableAuthorizationPluginInterface::buildRowDescription
ConfigurableAuthorizationPluginBase::buildRowForm public function Builds the authorization form row. Overrides ConfigurableAuthorizationPluginInterface::buildRowForm 1
ConfigurableAuthorizationPluginBase::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
ConfigurableAuthorizationPluginBase::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create 1
ConfigurableAuthorizationPluginBase::defaultConfiguration public function Gets default configuration for this plugin. Overrides ConfigurableInterface::defaultConfiguration
ConfigurableAuthorizationPluginBase::getConfiguration public function Unused, configuration is saved in the profile, required by base class. Overrides ConfigurableInterface::getConfiguration
ConfigurableAuthorizationPluginBase::getDescription public function Returns the plugin's description. Overrides ConfigurableAuthorizationPluginInterface::getDescription
ConfigurableAuthorizationPluginBase::getTokens public function Tokens for the relevant plugin. Overrides ConfigurableAuthorizationPluginInterface::getTokens
ConfigurableAuthorizationPluginBase::getType public function
ConfigurableAuthorizationPluginBase::label public function Returns the label for use on the administration pages. Overrides ConfigurableAuthorizationPluginInterface::label
ConfigurableAuthorizationPluginBase::setConfiguration public function Unused, configuration is saved in the profile, required by base class. Overrides ConfigurableInterface::setConfiguration
ConfigurableAuthorizationPluginBase::submitConfigurationForm public function Form submission handler. Overrides PluginFormInterface::submitConfigurationForm
ConfigurableAuthorizationPluginBase::submitRowForm public function Submits the authorization form row. Overrides ConfigurableAuthorizationPluginInterface::submitRowForm
ConfigurableAuthorizationPluginBase::validateConfigurationForm public function Form validation handler. Overrides PluginFormInterface::validateConfigurationForm
ConfigurableAuthorizationPluginBase::validateRowForm public function Validates the authorization form row. Overrides ConfigurableAuthorizationPluginInterface::validateRowForm
ConfigurableAuthorizationPluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. Overrides PluginBase::__construct 1
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
ProviderInterface::filterProposals public function Provider-side filtering. 1
ProviderInterface::getProposals public function Get the proposals for this users. 1
ProviderInterface::sanitizeProposals public function Sanitize proposals. 1
ProviderPluginBase::$handlers protected property List of modules handling this provider.
ProviderPluginBase::$revocationSupported protected property Whether this provider supports revocation.
ProviderPluginBase::$syncOnLogonSupported protected property Whether this provider supports sync on user logon.
ProviderPluginBase::$type protected property Defines the type, for example used by getToken(). Overrides ConfigurableAuthorizationPluginBase::$type
ProviderPluginBase::getHandlers public function Which modules are handling this provider.
ProviderPluginBase::isSyncOnLogonSupported public function Provides sync on logon. Overrides ProviderInterface::isSyncOnLogonSupported
ProviderPluginBase::revocationSupported public function Provides revocation. Overrides ProviderInterface::revocationSupported
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.