You are here

Home » API reference » Salesforce Suite 8.4 » SalesforceAuthProviderPluginManager.php

class SalesforceAuthProviderPluginManager in Salesforce Suite 8.4

Same name and namespace in other branches
  1. 8.3 src/SalesforceAuthProviderPluginManager.php \Drupal\salesforce\SalesforceAuthProviderPluginManager
  2. 5.0.x src/SalesforceAuthProviderPluginManager.php \Drupal\salesforce\SalesforceAuthProviderPluginManager

Auth provider plugin manager.

Hierarchy

Expanded class hierarchy of SalesforceAuthProviderPluginManager

3 files declare their use of SalesforceAuthProviderPluginManager
RestClientTest.php in tests/src/Unit/RestClientTest.php
SalesforcePushQueueProcessorRestTest.php in modules/salesforce_push/tests/src/Unit/SalesforcePushQueueProcessorRestTest.php
TestSalesforceAuthProviderPluginManager.php in src/Tests/TestSalesforceAuthProviderPluginManager.php
1 string reference to 'SalesforceAuthProviderPluginManager'
salesforce.services.yml in ./salesforce.services.yml
salesforce.services.yml
1 service uses SalesforceAuthProviderPluginManager
plugin.manager.salesforce.auth_providers in ./salesforce.services.yml
Drupal\salesforce\SalesforceAuthProviderPluginManager

File

src/SalesforceAuthProviderPluginManager.php, line 16

Namespace

Drupal\salesforce
View source 
class SalesforceAuthProviderPluginManager extends DefaultPluginManager implements SalesforceAuthProviderPluginManagerInterface {

  /**
   * Config from salesforce.settings.
   *
   * @var \Drupal\Core\Config\ImmutableConfig
   */
  protected $config;

  /**
   * Entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $etm;

  /**
   * Salesforce Auth storage.
   *
   * @var \Drupal\Core\Config\Entity\ConfigEntityStorageInterface
   */
  protected $authStorage;

  /**
   * Active auth config.
   *
   * @var \Drupal\salesforce\Entity\SalesforceAuthConfig
   */
  protected $authConfig;

  /**
   * Active auth provider.
   *
   * @var \Drupal\salesforce\SalesforceAuthProviderInterface
   */
  protected $authProvider;

  /**
   * Active credentials.
   *
   * @var \Drupal\salesforce\Consumer\SalesforceCredentialsInterface
   */
  protected $authCredentials;

  /**
   * Active auth token.
   *
   * @var \OAuth\OAuth2\Token\TokenInterface|null
   */
  protected $authToken;

  /**
   * Constructor.
   *
   * @param \Traversable $namespaces
   *   An object that implements \Traversable which contains the root paths
   *   keyed by the corresponding namespace to look for plugin implementations.
   * @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
   *   Cache backend instance to use.
   * @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
   *   The module handler.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $etm
   *   Entity type manager service.
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, EntityTypeManagerInterface $etm) {
    parent::__construct('Plugin/SalesforceAuthProvider', $namespaces, $module_handler, 'Drupal\\salesforce\\SalesforceAuthProviderInterface');
    $this
      ->alterInfo('salesforce_auth_provider_info');
    $this
      ->setCacheBackend($cache_backend, 'salesforce_auth_provider');
    $this->etm = $etm;
  }

  /**
   * Wrapper for salesforce_auth storage service.
   *
   * @return \Drupal\Core\Config\Entity\ConfigEntityStorageInterface
   *   Storage for salesforce_auth.
   *
   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
   */
  protected function authStorage() {
    if (empty($this->authStorage)) {
      $this->authStorage = $this->etm
        ->getStorage('salesforce_auth');
    }
    return $this->authStorage;
  }

  /**
   * {@inheritdoc}
   */
  public function getProviders() {
    return $this
      ->authStorage()
      ->loadMultiple();
  }

  /**
   * {@inheritdoc}
   */
  public function hasProviders() {
    return $this
      ->authStorage()
      ->hasData();
  }

  /**
   * {@inheritdoc}
   */
  public function getConfig() {
    if (!$this->authConfig) {
      $provider_id = $this
        ->config()
        ->get('salesforce_auth_provider');
      if (empty($provider_id)) {
        return NULL;
      }
      $this->authConfig = SalesforceAuthConfig::load($provider_id);
    }
    return $this->authConfig;
  }

  /**
   * {@inheritdoc}
   */
  public function getProvider() {
    if (!$this->authProvider) {
      if (!$this
        ->getConfig()) {
        return NULL;
      }
      $this->authProvider = $this
        ->getConfig()
        ->getPlugin();
    }
    return $this->authProvider;
  }

  /**
   * {@inheritdoc}
   */
  public function getCredentials() {
    if (!$this->authCredentials) {
      if (!$this
        ->getProvider()) {
        return NULL;
      }
      $this->authCredentials = $this
        ->getProvider()
        ->getCredentials();
    }
    return $this->authCredentials;
  }

  /**
   * {@inheritdoc}
   */
  public function getToken() {
    if (!$this->authToken) {
      if (!($config = $this
        ->getConfig())) {
        return NULL;
      }
      if (!($provider = $config
        ->getPlugin())) {
        return NULL;
      }
      try {
        $this->authToken = $provider
          ->getAccessToken();
      } catch (TokenNotFoundException $e) {
        return NULL;
      }
    }
    return $this->authToken;
  }

  /**
   * {@inheritdoc}
   */
  public function refreshToken() {
    if (!($config = $this
      ->getConfig())) {
      return NULL;
    }
    if (!($provider = $config
      ->getPlugin())) {
      return NULL;
    }
    $token = $this
      ->getToken() ?: new StdOAuth2Token();
    $this->authToken = $provider
      ->refreshAccessToken($token);
    return $this->authToken;
  }

  /**
   * Wrapper for salesforce.settings config.
   *
   * @return \Drupal\Core\Config\ImmutableConfig
   *   Salesforce settings config.
   */
  protected function config() {
    if (!$this->config) {
      $this->config = \Drupal::config('salesforce.settings');
    }
    return $this->config;
  }

  /**
   * {@inheritdoc}
   */
  public function getFallbackPluginId($plugin_id, array $configuration = []) {
    return 'broken';
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DefaultPluginManager::$additionalAnnotationNamespaces protected property Additional namespaces the annotation discovery mechanism should scan for annotation definitions.
DefaultPluginManager::$alterHook protected property Name of the alter hook if one should be invoked.
DefaultPluginManager::$cacheKey protected property The cache key.
DefaultPluginManager::$cacheTags protected property An array of cache tags to use for the cached definitions.
DefaultPluginManager::$defaults protected property A set of defaults to be referenced by $this->processDefinition() if additional processing of plugins is necessary or helpful for development purposes. 9
DefaultPluginManager::$moduleHandler protected property The module handler to invoke the alter hook. 1
DefaultPluginManager::$namespaces protected property An object that implements \Traversable which contains the root paths keyed by the corresponding namespace to look for plugin implementations.
DefaultPluginManager::$pluginDefinitionAnnotationName protected property The name of the annotation that contains the plugin definition.
DefaultPluginManager::$pluginInterface protected property The interface each plugin should implement. 1
DefaultPluginManager::$subdir protected property The subdirectory within a namespace to look for plugins, or FALSE if the plugins are in the top level of the namespace.
DefaultPluginManager::alterDefinitions protected function Invokes the hook to alter the definitions if the alter hook is set. 1
DefaultPluginManager::alterInfo protected function Sets the alter hook name.
DefaultPluginManager::clearCachedDefinitions public function Clears static and persistent plugin definition caches. Overrides CachedDiscoveryInterface::clearCachedDefinitions 5
DefaultPluginManager::extractProviderFromDefinition protected function Extracts the provider from a plugin definition.
DefaultPluginManager::findDefinitions protected function Finds plugin definitions. 7
DefaultPluginManager::fixContextAwareDefinitions private function Fix the definitions of context-aware plugins.
DefaultPluginManager::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyInterface::getCacheContexts
DefaultPluginManager::getCachedDefinitions protected function Returns the cached plugin definitions of the decorated discovery class.
DefaultPluginManager::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyInterface::getCacheMaxAge
DefaultPluginManager::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyInterface::getCacheTags
DefaultPluginManager::getDefinitions public function Gets the definition of all plugins for this type. Overrides DiscoveryTrait::getDefinitions 2
DefaultPluginManager::getDiscovery protected function Gets the plugin discovery. Overrides PluginManagerBase::getDiscovery 12
DefaultPluginManager::getFactory protected function Gets the plugin factory. Overrides PluginManagerBase::getFactory
DefaultPluginManager::processDefinition public function Performs extra processing on plugin definitions. 13
DefaultPluginManager::providerExists protected function Determines if the provider of a definition exists. 3
DefaultPluginManager::setCacheBackend public function Initialize the cache backend.
DefaultPluginManager::setCachedDefinitions protected function Sets a cache of plugin definitions for the decorated discovery class.
DefaultPluginManager::useCaches public function Disable the use of caches. Overrides CachedDiscoveryInterface::useCaches 1
DiscoveryCachedTrait::$definitions protected property Cached definitions array. 1
DiscoveryCachedTrait::getDefinition public function Overrides DiscoveryTrait::getDefinition 3
DiscoveryTrait::doGetDefinition protected function Gets a specific plugin definition.
DiscoveryTrait::hasDefinition public function
PluginManagerBase::$discovery protected property The object that discovers plugins managed by this manager.
PluginManagerBase::$factory protected property The object that instantiates plugins managed by this manager.
PluginManagerBase::$mapper protected property The object that returns the preconfigured plugin instance appropriate for a particular runtime condition.
PluginManagerBase::createInstance public function Creates a pre-configured instance of a plugin. Overrides FactoryInterface::createInstance 12
PluginManagerBase::getInstance public function Gets a preconfigured instance of a plugin. Overrides MapperInterface::getInstance 7
PluginManagerBase::handlePluginNotFound protected function Allows plugin managers to specify custom behavior if a plugin is not found. 1
SalesforceAuthProviderPluginManager::$authConfig protected property Active auth config.
SalesforceAuthProviderPluginManager::$authCredentials protected property Active credentials.
SalesforceAuthProviderPluginManager::$authProvider protected property Active auth provider.
SalesforceAuthProviderPluginManager::$authStorage protected property Salesforce Auth storage.
SalesforceAuthProviderPluginManager::$authToken protected property Active auth token.
SalesforceAuthProviderPluginManager::$config protected property Config from salesforce.settings.
SalesforceAuthProviderPluginManager::$etm protected property Entity type manager.
SalesforceAuthProviderPluginManager::authStorage protected function Wrapper for salesforce_auth storage service.
SalesforceAuthProviderPluginManager::config protected function Wrapper for salesforce.settings config.
SalesforceAuthProviderPluginManager::getConfig public function Get the active auth service provider, or null if it has not been assigned. Overrides SalesforceAuthProviderPluginManagerInterface::getConfig 1
SalesforceAuthProviderPluginManager::getCredentials public function The credentials for the active auth provider plugin, or null. Overrides SalesforceAuthProviderPluginManagerInterface::getCredentials
SalesforceAuthProviderPluginManager::getFallbackPluginId public function Gets a fallback id for a missing plugin. Overrides FallbackPluginManagerInterface::getFallbackPluginId
SalesforceAuthProviderPluginManager::getProvider public function The auth provider plugin of the active service provider, or null. Overrides SalesforceAuthProviderPluginManagerInterface::getProvider 1
SalesforceAuthProviderPluginManager::getProviders public function All Salesforce auth providers. Overrides SalesforceAuthProviderPluginManagerInterface::getProviders
SalesforceAuthProviderPluginManager::getToken public function Get the active token, or null if it has not been assigned. Overrides SalesforceAuthProviderPluginManagerInterface::getToken 1
SalesforceAuthProviderPluginManager::hasProviders public function TRUE if any auth providers are defined. Overrides SalesforceAuthProviderPluginManagerInterface::hasProviders 1
SalesforceAuthProviderPluginManager::refreshToken public function Force a refresh of the active token and return the fresh token. Overrides SalesforceAuthProviderPluginManagerInterface::refreshToken
SalesforceAuthProviderPluginManager::__construct public function Constructor. Overrides DefaultPluginManager::__construct
UseCacheBackendTrait::$cacheBackend protected property Cache backend instance.
UseCacheBackendTrait::$useCaches protected property Flag whether caches should be used or skipped.
UseCacheBackendTrait::cacheGet protected function Fetches from the cache backend, respecting the use caches flag. 1
UseCacheBackendTrait::cacheSet protected function Stores data in the persistent cache, respecting the use caches flag.