ProviderPluginBase.php in Authorization 8

Namespace

Drupal\authorization\Provider

File

src/Provider/ProviderPluginBase.php

<?php

declare (strict_types=1);
namespace Drupal\authorization\Provider;

use Drupal\authorization\Plugin\ConfigurableAuthorizationPluginBase;

/**
 * Base class for Authorization provider plugins.
 */
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;
  }

}

Classes

Name	Description
ProviderPluginBase	Base class for Authorization provider plugins.