class DiffGeneratorPluginManager in Entity Share 8.3
Provides a DiffManager 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\entity_share_diff\DiffGenerator\DiffGeneratorPluginManager
- class \Drupal\Core\Plugin\DefaultPluginManager implements CachedDiscoveryInterface, PluginManagerInterface, CacheableDependencyInterface uses DiscoveryCachedTrait, UseCacheBackendTrait
Expanded class hierarchy of DiffGeneratorPluginManager
See also
\Drupal\entity_share_diff\Annotation\DiffGenerator
\Drupal\entity_share_diff\DiffGenerator\DiffGeneratorInterface
1 file declares its use of DiffGeneratorPluginManager
- EntityParser.php in modules/
entity_share_diff/ src/ Service/ EntityParser.php
1 string reference to 'DiffGeneratorPluginManager'
- entity_share_diff.services.yml in modules/
entity_share_diff/ entity_share_diff.services.yml - modules/entity_share_diff/entity_share_diff.services.yml
1 service uses DiffGeneratorPluginManager
File
- modules/
entity_share_diff/ src/ DiffGenerator/ DiffGeneratorPluginManager.php, line 20
Namespace
Drupal\entity_share_diff\DiffGeneratorView source
class DiffGeneratorPluginManager extends DefaultPluginManager {
/**
* Plugin definitions.
*
* @var array
*/
protected $pluginDefinitions;
/**
* Constructs a DiffManager object.
*
* @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/DiffGenerator', $namespaces, $module_handler, 'Drupal\\entity_share_diff\\DiffGenerator\\DiffGeneratorInterface', 'Drupal\\entity_share_diff\\Annotation\\DiffGenerator');
$this
->setCacheBackend($cache_backend, 'field_diff_generator_plugins');
}
/**
* Creates a plugin instance for a field definition.
*
* Creates the instance based on the selected plugin for the field.
*
* @param string $field_type
* The field type.
*
* @return \Drupal\entity_share_diff\DiffGenerator\DiffGeneratorInterface|null
* The plugin instance, NULL if none.
*
* @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
* @throws \Drupal\Component\Plugin\Exception\PluginException
*/
public function createInstanceForFieldDefinition(string $field_type) {
if (!isset($this->pluginDefinitions)) {
foreach ($this
->getDefinitions() as $plugin_definition) {
if (isset($plugin_definition['field_types'])) {
// Iterate through all the field types this plugin supports
// and for every such field type add the id of the plugin.
if (!isset($plugin_definition['weight'])) {
$plugin_definition['weight'] = 0;
}
foreach ($plugin_definition['field_types'] as $id) {
$this->pluginDefinitions[$id][$plugin_definition['id']]['weight'] = $plugin_definition['weight'];
}
$plugins = $this->pluginDefinitions;
}
}
}
else {
$plugins = $this->pluginDefinitions;
}
// Build a list of all diff plugins supporting the field type of the field.
$plugin_options = [];
if (isset($plugins[$field_type])) {
// Sort the plugins based on their weight.
uasort($plugins[$field_type], 'Drupal\\Component\\Utility\\SortArray::sortByWeightElement');
foreach (array_keys($plugins[$field_type]) as $id) {
$definition = $this
->getDefinition($id, FALSE);
// Check if the plugin is applicable.
if (isset($definition['class']) && in_array($field_type, $definition['field_types'])) {
$plugin_options[$id] = $this
->getDefinitions()[$id]['label'];
}
}
$settings = key($plugin_options);
return $this
->createInstance($settings, []);
}
return NULL;
}
}
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 |
DiffGeneratorPluginManager:: |
protected | property | Plugin definitions. | |
DiffGeneratorPluginManager:: |
public | function | Creates a plugin instance for a field definition. | |
DiffGeneratorPluginManager:: |
public | function |
Constructs a DiffManager object. Overrides DefaultPluginManager:: |
|
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 |
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. |