class IconExtractorPluginManager
IconExtractor plugin manager.
@internal Icon is currently experimental and should only be leveraged by experimental modules and development releases of contributed modules. See https://www.drupal.org/core/experimental for more information.
Hierarchy
- class \Drupal\Component\Plugin\PluginManagerBase implements \Drupal\Component\Plugin\PluginManagerInterface uses \Drupal\Component\Plugin\Discovery\DiscoveryTrait
- class \Drupal\Core\Plugin\DefaultPluginManager extends \Drupal\Component\Plugin\PluginManagerBase implements \Drupal\Component\Plugin\PluginManagerInterface, \Drupal\Component\Plugin\Discovery\CachedDiscoveryInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Component\Plugin\Discovery\DiscoveryCachedTrait, \Drupal\Core\Cache\UseCacheBackendTrait
- class \Drupal\Core\Theme\Icon\IconExtractorPluginManager extends \Drupal\Core\Plugin\DefaultPluginManager
- class \Drupal\Core\Plugin\DefaultPluginManager extends \Drupal\Component\Plugin\PluginManagerBase implements \Drupal\Component\Plugin\PluginManagerInterface, \Drupal\Component\Plugin\Discovery\CachedDiscoveryInterface, \Drupal\Core\Cache\CacheableDependencyInterface uses \Drupal\Component\Plugin\Discovery\DiscoveryCachedTrait, \Drupal\Core\Cache\UseCacheBackendTrait
Expanded class hierarchy of IconExtractorPluginManager
1 file declares its use of IconExtractorPluginManager
- IconPackManager.php in core/
lib/ Drupal/ Core/ Theme/ Icon/ Plugin/ IconPackManager.php
File
-
core/
lib/ Drupal/ Core/ Theme/ Icon/ IconExtractorPluginManager.php, line 23
Namespace
Drupal\Core\Theme\IconView source
class IconExtractorPluginManager extends DefaultPluginManager {
public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, PluginFormFactoryInterface $pluginFormFactory) {
parent::__construct('Plugin/IconExtractor', $namespaces, $module_handler, IconExtractorInterface::class, IconExtractor::class);
$this->alterInfo('icon_extractor_info');
$this->setCacheBackend($cache_backend, 'icon_extractor_plugins');
}
/**
* Get multiple extractor settings form.
*
* @param array $icon_pack_configurations
* All the icon pack configurations containing the extractor.
*
* @return \Drupal\Core\Plugin\PluginFormInterface[]
* The extractor form indexed by extractor id.
*/
public function getExtractorForms(array $icon_pack_configurations) : array {
$extractor_forms = [];
foreach ($icon_pack_configurations as $icon_pack_configuration) {
$pack_id = $icon_pack_configuration['id'];
$form = $this->getExtractorForm($icon_pack_configuration);
if (NULL === $form) {
continue;
}
$extractor_forms[$pack_id] = $form;
}
return $extractor_forms;
}
/**
* Get an extractor settings form.
*
* @param array $icon_pack_configuration
* The extractor configuration.
*
* @return \Drupal\Core\Plugin\PluginFormInterface|null
* The extractor form or null.
*/
public function getExtractorForm(array $icon_pack_configuration) : ?PluginFormInterface {
if (!isset($icon_pack_configuration['settings'])) {
return NULL;
}
/** @var \Drupal\Core\Theme\Icon\IconExtractorInterface $plugin */
$plugin = $this->createInstance($icon_pack_configuration['extractor'], $icon_pack_configuration);
return $this->getPluginForm($plugin);
}
/**
* Retrieves the plugin form for a given icon extractor.
*
* @param \Drupal\Core\Theme\Icon\IconExtractorInterface $icon_extractor
* The ui icons extractor plugin.
*
* @return \Drupal\Core\Plugin\PluginFormInterface
* The plugin form for this plugin.
*/
protected function getPluginForm(IconExtractorInterface $icon_extractor) : PluginFormInterface {
if ($icon_extractor instanceof PluginWithFormsInterface) {
return $this->pluginFormFactory
->createInstance($icon_extractor, 'settings');
}
return $icon_extractor;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
DefaultPluginManager::$additionalAnnotationNamespaces | protected | property | Additional annotation namespaces. | ||
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(). | 12 | |
DefaultPluginManager::$moduleExtensionList | protected | property | The module extension list. | ||
DefaultPluginManager::$moduleHandler | protected | property | The module handler to invoke the alter hook. | 1 | |
DefaultPluginManager::$namespaces | protected | property | An object of root paths that are traversable. | ||
DefaultPluginManager::$pluginDefinitionAnnotationName | protected | property | The name of the annotation that contains the plugin definition. | ||
DefaultPluginManager::$pluginDefinitionAttributeName | protected | property | The name of the attribute 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. | ||
DefaultPluginManager::alterDefinitions | protected | function | Invokes the hook to alter the definitions if the alter hook is set. | 5 | |
DefaultPluginManager::alterInfo | protected | function | Sets the alter hook name. | ||
DefaultPluginManager::clearCachedDefinitions | public | function | Clears static and persistent plugin definition caches. | Overrides CachedDiscoveryInterface::clearCachedDefinitions | 11 |
DefaultPluginManager::extractProviderFromDefinition | protected | function | Extracts the provider from a plugin definition. | ||
DefaultPluginManager::findDefinitions | protected | function | Finds plugin definitions. | 7 | |
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 | 17 |
DefaultPluginManager::getFactory | protected | function | Gets the plugin factory. | Overrides PluginManagerBase::getFactory | |
DefaultPluginManager::processDefinition | public | function | Performs extra processing on plugin definitions. | 15 | |
DefaultPluginManager::providerExists | protected | function | Determines if the provider of a definition exists. | 6 | |
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 | |||
IconExtractorPluginManager::getExtractorForm | public | function | Get an extractor settings form. | ||
IconExtractorPluginManager::getExtractorForms | public | function | Get multiple extractor settings form. | ||
IconExtractorPluginManager::getPluginForm | protected | function | Retrieves the plugin form for a given icon extractor. | ||
IconExtractorPluginManager::__construct | public | function | Constructs a new \Drupal\Core\Plugin\DefaultPluginManager object. | Overrides DefaultPluginManager::__construct | |
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 | 15 | ||
PluginManagerBase::getFallbackPluginId | protected | function | Gets a fallback id for a missing plugin. | 6 | |
PluginManagerBase::getInstance | public | function | 6 | ||
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. | ||
UseCacheBackendTrait::cacheSet | protected | function | Stores data in the persistent cache, respecting the use caches flag. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.