abstract class ConsumerPluginBase in Authorization 8

Base class for Authorization consumer plugins.

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\authorization\Plugin\ConfigurableAuthorizationPluginBase implements ConfigurableAuthorizationPluginInterface uses DependencyTrait
      • class \Drupal\authorization\Consumer\ConsumerPluginBase implements ConsumerInterface

2 files declare their use of ConsumerPluginBase

DrupalRolesConsumer.php in authorization_drupal_roles/src/Plugin/authorization/Consumer/DrupalRolesConsumer.php

Dummy.php in tests/modules/authorization_test/src/Plugin/authorization/Consumer/Dummy.php

File

src/Consumer/ConsumerPluginBase.php, line 12

Namespace

Drupal\authorization\Consumer

abstract class ConsumerPluginBase extends ConfigurableAuthorizationPluginBase implements ConsumerInterface {

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

  /**
   * Whether this plugins supports consumer target creation.
   *
   * @var bool
   */
  protected $allowConsumerTargetCreation = FALSE;

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

  /**
   * {@inheritdoc}
   */
  public function filterProposals(array $proposals, array $mapping) : array {
    if (!empty($proposals)) {
      $property = array_pop($mapping);
      return [
        $property => $property,
      ];
    }
    return [];
  }

}

Members

Name	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
ConsumerInterface::createConsumerTarget	public	function	Create authorization consumer targets.	2
ConsumerInterface::grantSingleAuthorization	public	function	Grant one individual proposal.	2
ConsumerInterface::revokeGrants	public	function	Revoke all previously applied and no longer valid grants.	2
ConsumerPluginBase::$allowConsumerTargetCreation	protected	property	Whether this plugins supports consumer target creation.	2
ConsumerPluginBase::$type	protected	property	Defines the type, for example used by getToken(). Overrides ConfigurableAuthorizationPluginBase::$type
ConsumerPluginBase::consumerTargetCreationAllowed	public	function	Are we allowed to create things. Overrides ConsumerInterface::consumerTargetCreationAllowed
ConsumerPluginBase::filterProposals	public	function	Consumer-side filtering. Overrides ConsumerInterface::filterProposals	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.
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.