class SalesforceAuthProviderPluginManager in Salesforce Suite 8.3
Same name and namespace in other branches
- 8.4 src/SalesforceAuthProviderPluginManager.php \Drupal\salesforce\SalesforceAuthProviderPluginManager
- 5.0.x src/SalesforceAuthProviderPluginManager.php \Drupal\salesforce\SalesforceAuthProviderPluginManager
Auth provider plugin manager.
Hierarchy
- class \Drupal\Component\Plugin\PluginManagerBase implements PluginManagerInterface uses DiscoveryTrait
- class \Drupal\Core\Plugin\DefaultPluginManager implements CachedDiscoveryInterface, PluginManagerInterface, CacheableDependencyInterface uses DiscoveryCachedTrait, UseCacheBackendTrait
- class \Drupal\salesforce\SalesforceAuthProviderPluginManager
- class \Drupal\Core\Plugin\DefaultPluginManager implements CachedDiscoveryInterface, PluginManagerInterface, CacheableDependencyInterface uses DiscoveryCachedTrait, UseCacheBackendTrait
Expanded class hierarchy of SalesforceAuthProviderPluginManager
4 files declare their use of SalesforceAuthProviderPluginManager
- RestClient.php in src/
Rest/ RestClient.php - salesforce.install in ./
salesforce.install - Salesforce install file.
- SalesforceAuthTokenStorage.php in src/
Storage/ SalesforceAuthTokenStorage.php - TestSalesforceAuthProviderPluginManager.php in src/
Tests/ TestSalesforceAuthProviderPluginManager.php
1 string reference to 'SalesforceAuthProviderPluginManager'
1 service uses SalesforceAuthProviderPluginManager
File
- src/
SalesforceAuthProviderPluginManager.php, line 18
Namespace
Drupal\salesforceView source
class SalesforceAuthProviderPluginManager extends DefaultPluginManager {
/**
* 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;
/**
* 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;
}
/**
* Backwards-compatibility for legacy singleton auth.
*
* @deprecated BC legacy auth scheme only, do not use, will be removed.
*/
public static function updateAuthConfig() {
$oauth = self::getAuthConfig();
$config = \Drupal::configFactory()
->getEditable('salesforce.settings');
$settings = [
'consumer_key' => $config
->get('consumer_key'),
'consumer_secret' => $config
->get('consumer_secret'),
'login_url' => $config
->get('login_url'),
];
$oauth
->set('provider_settings', $settings)
->save();
}
/**
* Backwards-compatibility for legacy singleton auth.
*
* @deprecated BC legacy auth scheme only, do not use, will be removed.
*/
public static function getAuthConfig() {
$config = \Drupal::configFactory()
->getEditable('salesforce.settings');
$auth_provider = $config
->get('salesforce_auth_provider');
if (!$auth_provider || !($oauth = SalesforceAuthConfig::load($auth_provider))) {
// Config to new plugin config system.
$values = [
'id' => 'oauth_default',
'label' => 'OAuth Default',
'provider' => 'oauth',
];
$oauth = SalesforceAuthConfig::create($values);
$config
->set('salesforce_auth_provider', 'oauth_default')
->save();
}
return $oauth;
}
/**
* 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;
}
/**
* All Salesforce auth providers.
*
* @return \Drupal\salesforce\Entity\SalesforceAuthConfig[]
* All auth provider plugins.
*
* @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
public function getProviders() {
return $this
->authStorage()
->loadMultiple();
}
/**
* TRUE if any auth providers are defined.
*
* @return bool
* TRUE if any auth providers are defined.
*
* @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
*/
public function hasProviders() {
return $this
->authStorage()
->hasData();
}
/**
* Get the active auth service provider, or null if it has not been assigned.
*
* @return \Drupal\salesforce\Entity\SalesforceAuthConfig|null
* The active service provider, or null if it has not been assigned.
*/
public function getConfig() {
$provider_id = $this
->config()
->get('salesforce_auth_provider');
if (empty($provider_id)) {
return NULL;
}
return SalesforceAuthEntity::load($provider_id);
}
/**
* The auth provider plugin of the active service provider, or null.
*
* @return \Drupal\salesforce\SalesforceAuthProviderInterface|null
* The auth provider plugin of the active service provider, or null.
*/
public function getProvider() {
if (!$this
->getConfig()) {
return NULL;
}
return $this
->getConfig()
->getPlugin();
}
/**
* Get the active token, or null if it has not been assigned.
*
* @return \OAuth\OAuth2\Token\TokenInterface
* The token of the plugin of the active config, or null.
*/
public function getToken() {
if (!($config = $this
->getConfig())) {
return NULL;
}
if (!($provider = $config
->getPlugin())) {
return NULL;
}
try {
return $provider
->getAccessToken();
} catch (TokenNotFoundException $e) {
return NULL;
}
}
/**
* Force a refresh of the active token and return the fresh token.
*
* @return \OAuth\OAuth2\Token\TokenInterface|null
* The token.
*/
public function refreshToken() {
if (!($config = $this
->getConfig())) {
return NULL;
}
if (!($provider = $config
->getPlugin())) {
return NULL;
}
$token = $this
->getToken() ?: new StdOAuth2Token();
return $provider
->refreshAccessToken($token);
}
/**
* 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;
}
}
Members
Name![]() |
Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DefaultPluginManager:: |
protected | property | Additional namespaces the annotation discovery mechanism should scan for annotation definitions. | |
DefaultPluginManager:: |
protected | property | Name of the alter hook if one should be invoked. | |
DefaultPluginManager:: |
protected | property | The cache key. | |
DefaultPluginManager:: |
protected | property | An array of cache tags to use for the cached definitions. | |
DefaultPluginManager:: |
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:: |
protected | property | The module handler to invoke the alter hook. | 1 |
DefaultPluginManager:: |
protected | property | An object that implements \Traversable which contains the root paths keyed by the corresponding namespace to look for plugin implementations. | |
DefaultPluginManager:: |
protected | property | The name of the annotation that contains the plugin definition. | |
DefaultPluginManager:: |
protected | property | The interface each plugin should implement. | 1 |
DefaultPluginManager:: |
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:: |
protected | function | Invokes the hook to alter the definitions if the alter hook is set. | 1 |
DefaultPluginManager:: |
protected | function | Sets the alter hook name. | |
DefaultPluginManager:: |
public | function |
Clears static and persistent plugin definition caches. Overrides CachedDiscoveryInterface:: |
5 |
DefaultPluginManager:: |
protected | function | Extracts the provider from a plugin definition. | |
DefaultPluginManager:: |
protected | function | Finds plugin definitions. | 7 |
DefaultPluginManager:: |
private | function | Fix the definitions of context-aware plugins. | |
DefaultPluginManager:: |
public | function |
The cache contexts associated with this object. Overrides CacheableDependencyInterface:: |
|
DefaultPluginManager:: |
protected | function | Returns the cached plugin definitions of the decorated discovery class. | |
DefaultPluginManager:: |
public | function |
The maximum age for which this object may be cached. Overrides CacheableDependencyInterface:: |
|
DefaultPluginManager:: |
public | function |
The cache tags associated with this object. Overrides CacheableDependencyInterface:: |
|
DefaultPluginManager:: |
public | function |
Gets the definition of all plugins for this type. Overrides DiscoveryTrait:: |
2 |
DefaultPluginManager:: |
protected | function |
Gets the plugin discovery. Overrides PluginManagerBase:: |
12 |
DefaultPluginManager:: |
protected | function |
Gets the plugin factory. Overrides PluginManagerBase:: |
|
DefaultPluginManager:: |
public | function | Performs extra processing on plugin definitions. | 13 |
DefaultPluginManager:: |
protected | function | Determines if the provider of a definition exists. | 3 |
DefaultPluginManager:: |
public | function | Initialize the cache backend. | |
DefaultPluginManager:: |
protected | function | Sets a cache of plugin definitions for the decorated discovery class. | |
DefaultPluginManager:: |
public | function |
Disable the use of caches. Overrides CachedDiscoveryInterface:: |
1 |
DiscoveryCachedTrait:: |
protected | property | Cached definitions array. | 1 |
DiscoveryCachedTrait:: |
public | function |
Overrides DiscoveryTrait:: |
3 |
DiscoveryTrait:: |
protected | function | Gets a specific plugin definition. | |
DiscoveryTrait:: |
public | function | ||
PluginManagerBase:: |
protected | property | The object that discovers plugins managed by this manager. | |
PluginManagerBase:: |
protected | property | The object that instantiates plugins managed by this manager. | |
PluginManagerBase:: |
protected | property | The object that returns the preconfigured plugin instance appropriate for a particular runtime condition. | |
PluginManagerBase:: |
public | function |
Creates a pre-configured instance of a plugin. Overrides FactoryInterface:: |
12 |
PluginManagerBase:: |
public | function |
Gets a preconfigured instance of a plugin. Overrides MapperInterface:: |
7 |
PluginManagerBase:: |
protected | function | Allows plugin managers to specify custom behavior if a plugin is not found. | 1 |
SalesforceAuthProviderPluginManager:: |
protected | property | Salesforce Auth storage. | |
SalesforceAuthProviderPluginManager:: |
protected | property | Config from salesforce.settings. | |
SalesforceAuthProviderPluginManager:: |
protected | property | Entity type manager. | |
SalesforceAuthProviderPluginManager:: |
protected | function | Wrapper for salesforce_auth storage service. | |
SalesforceAuthProviderPluginManager:: |
protected | function | Wrapper for salesforce.settings config. | |
SalesforceAuthProviderPluginManager:: |
public static | function | Backwards-compatibility for legacy singleton auth. | |
SalesforceAuthProviderPluginManager:: |
public | function | Get the active auth service provider, or null if it has not been assigned. | 1 |
SalesforceAuthProviderPluginManager:: |
public | function | The auth provider plugin of the active service provider, or null. | 1 |
SalesforceAuthProviderPluginManager:: |
public | function | All Salesforce auth providers. | |
SalesforceAuthProviderPluginManager:: |
public | function | Get the active token, or null if it has not been assigned. | 1 |
SalesforceAuthProviderPluginManager:: |
public | function | TRUE if any auth providers are defined. | 1 |
SalesforceAuthProviderPluginManager:: |
public | function | Force a refresh of the active token and return the fresh token. | |
SalesforceAuthProviderPluginManager:: |
public static | function | Backwards-compatibility for legacy singleton auth. | |
SalesforceAuthProviderPluginManager:: |
public | function |
Constructor. Overrides DefaultPluginManager:: |
|
UseCacheBackendTrait:: |
protected | property | Cache backend instance. | |
UseCacheBackendTrait:: |
protected | property | Flag whether caches should be used or skipped. | |
UseCacheBackendTrait:: |
protected | function | Fetches from the cache backend, respecting the use caches flag. | 1 |
UseCacheBackendTrait:: |
protected | function | Stores data in the persistent cache, respecting the use caches flag. |