You are here

Home » API reference » Persistent URL 8 » ProviderManager.php

class ProviderManager in Persistent URL 8

Hierarchy

Expanded class hierarchy of ProviderManager

4 files declare their use of ProviderManager
ModifiersController.php in src/Controller/ModifiersController.php
ProvidersController.php in src/Controller/ProvidersController.php
RebuildIndex.php in src/Event/RebuildIndex.php
RequestSubscriber.php in src/Event/RequestSubscriber.php
1 string reference to 'ProviderManager'
purl.services.yml in ./purl.services.yml
purl.services.yml
1 service uses ProviderManager
purl.plugin.provider_manager in ./purl.services.yml
Drupal\purl\Plugin\ProviderManager

File

src/Plugin/ProviderManager.php, line 14

Namespace

Drupal\purl\Plugin
View source 
class ProviderManager extends DefaultPluginManager implements ContainerAwareInterface {
  use ContainerAwareTrait;

  /**
   * @var Drupal\purl\Plugin\Purl\Method\MethodInterface[]
   *
   * We store created instances here and return the right one when queried
   * for again. We only one one instance for each method plugin.
   */
  protected $providers = array();
  protected $connection;
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cacheBackend, ModuleHandlerInterface $moduleHandler) {
    parent::__construct('Plugin/Purl/Provider', $namespaces, $moduleHandler, 'Drupal\\purl\\Plugin\\Purl\\Provider\\ProviderInterface', 'Drupal\\purl\\Annotation\\PurlProvider');
    $this
      ->setCacheBackend($cacheBackend, 'purl_provider_plugins');
  }
  public function setConnection(Connection $connection) {
    $this->connection = $connection;
  }
  public function getProviderConfiguration($id) {
    $result = $this->connection
      ->select('purl_providers_settings', 'p')
      ->fields('p', array(
      'provider',
      'method',
      'settings',
    ))
      ->condition('provider', $id)
      ->execute();
    $row = $result
      ->fetch();
    return array(
      'method' => $row ? $row->method : null,
      'settings' => $row ? unserialize($row->settings) : array(),
    );
  }
  public function saveProviderConfiguration($providerId, $method, array $settings) {
    $this
      ->deleteProviderConfiguration($providerId);
    $this->connection
      ->insert('purl_providers_settings')
      ->fields(array(
      'provider' => $providerId,
      'method' => $method,
      'settings' => serialize($settings),
    ))
      ->execute();
    $definitions = $this
      ->findDefinitions();
    $definitions[$providerId] = array_merge($definitions[$providerId], array(
      'method' => $method,
      'settings' => $settings,
    ));
    $this
      ->setCachedDefinitions($definitions);
  }
  public function deleteProviderConfiguration($providerId) {
    $this->connection
      ->delete('purl_providers_settings')
      ->condition('provider', $providerId)
      ->execute();
    $definitions = $this
      ->findDefinitions();
    $definitions[$providerId] = array_merge($definitions[$providerId], array(
      'method' => null,
      'settings' => array(),
    ));
    $this
      ->setCachedDefinitions($definitions);
  }
  public function findDefinitions() {
    $definitions = parent::findDefinitions();
    foreach ($definitions as $id => $definition) {
      $config = $this
        ->getProviderConfiguration($id);
      $definitions[$id]['method'] = $config['method'];
      $definitions[$id]['settings'] = $config['settings'];
    }
    return $definitions;
  }
  public function getProvider($id) {
    if (!isset($this->providers[$id])) {
      $plugin = $this
        ->createInstance($id);
      $definition = $this
        ->getDefinition($id);
      $plugin
        ->setId($id);
      if ($plugin instanceof ContainerAwareInterface) {
        $plugin
          ->setContainer($this->container);
      }
      if ($plugin instanceof ConfigurableInterface) {
        $plugin
          ->setSettings($definition['settings']);
      }
      $this->providers[$id] = $plugin;
    }
    return $this->providers[$id];
  }
  public function hasProvider($id) {
    return isset($this->providers[$id]) || $this
      ->hasDefinition($id);
  }

}

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::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
ProviderManager::$connection protected property
ProviderManager::$providers protected property We store created instances here and return the right one when queried for again. We only one one instance for each method plugin.
ProviderManager::deleteProviderConfiguration public function
ProviderManager::findDefinitions public function Finds plugin definitions. Overrides DefaultPluginManager::findDefinitions
ProviderManager::getProvider public function
ProviderManager::getProviderConfiguration public function
ProviderManager::hasProvider public function
ProviderManager::saveProviderConfiguration public function
ProviderManager::setConnection public function
ProviderManager::__construct public function Creates the discovery object. 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.