class ConfigFilterPluginManager in Config Filter 8

Provides the Config filter plugin 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\config_filter\Plugin\ConfigFilterPluginManager implements ConfigFilterManagerInterface

1 string reference to 'ConfigFilterPluginManager'

config_filter.services.yml in ./config_filter.services.yml

config_filter.services.yml

1 service uses ConfigFilterPluginManager

plugin.manager.config_filter in ./config_filter.services.yml

Drupal\config_filter\Plugin\ConfigFilterPluginManager

File

src/Plugin/ConfigFilterPluginManager.php, line 13

Namespace

Drupal\config_filter\Plugin

class ConfigFilterPluginManager extends DefaultPluginManager implements ConfigFilterManagerInterface {

  /**
   * Constructor for ConfigFilterPluginManager objects.
   *
   * @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 to invoke the alter hook with.
   */
  public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler) {
    parent::__construct('Plugin/ConfigFilter', $namespaces, $module_handler, 'Drupal\\config_filter\\Plugin\\ConfigFilterInterface', 'Drupal\\config_filter\\Annotation\\ConfigFilter');
    $this
      ->alterInfo('config_filter_info');
    $this
      ->setCacheBackend($cache_backend, 'config_filter_plugins');
  }

  /**
   * {@inheritdoc}
   */
  public function getFiltersForStorages(array $storage_names, array $excluded = []) {
    $definitions = $this
      ->getDefinitions();
    $filters = [];
    foreach ($definitions as $id => $definition) {
      if ($definition['status'] && array_intersect($storage_names, $definition['storages']) && !in_array($id, $excluded)) {
        $filters[$id] = $this
          ->createInstance($id, $definition);
      }
    }
    return $filters;
  }

  /**
   * {@inheritdoc}
   */
  public function getFilterInstance($id) {
    $definitions = $this
      ->getDefinitions();
    if (array_key_exists($id, $definitions)) {
      return $this
        ->createInstance($id, $definitions[$id]);
    }
    return NULL;
  }

  /**
   * {@inheritdoc}
   */
  protected function findDefinitions() {
    $definitions = array_map(function ($definition) {
      if (empty($definition['storages'])) {

        // The sync storage is the default.
        $definition['storages'] = [
          'config.storage.sync',
        ];
      }
      return $definition;
    }, parent::findDefinitions());

    // Sort the definitions by weight.
    uasort($definitions, [
      'Drupal\\Component\\Utility\\SortArray',
      'sortByWeightElement',
    ]);
    return $definitions;
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigFilterPluginManager::findDefinitions	protected	function	Finds plugin definitions. Overrides DefaultPluginManager::findDefinitions
ConfigFilterPluginManager::getFilterInstance	public	function	Get a configured filter instance by (plugin) id. Overrides ConfigFilterManagerInterface::getFilterInstance
ConfigFilterPluginManager::getFiltersForStorages	public	function	Get the applicable filters for given storage names. Overrides ConfigFilterManagerInterface::getFiltersForStorages
ConfigFilterPluginManager::__construct	public	function	Constructor for ConfigFilterPluginManager objects. Overrides DefaultPluginManager::__construct
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
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.