class WebformVariantManager in Webform 6.x
Same name and namespace in other branches
- 8.5 src/Plugin/WebformVariantManager.php \Drupal\webform\Plugin\WebformVariantManager
Manages webform variant plugins.
Hierarchy
- class \Drupal\Component\Plugin\PluginManagerBase implements PluginManagerInterface uses DiscoveryTrait
- class \Drupal\Core\Plugin\DefaultPluginManager implements CachedDiscoveryInterface, PluginManagerInterface, CacheableDependencyInterface uses DiscoveryCachedTrait, UseCacheBackendTrait
- class \Drupal\webform\Plugin\WebformVariantManager implements WebformVariantManagerInterface uses CategorizingPluginManagerTrait
- class \Drupal\Core\Plugin\DefaultPluginManager implements CachedDiscoveryInterface, PluginManagerInterface, CacheableDependencyInterface uses DiscoveryCachedTrait, UseCacheBackendTrait
Expanded class hierarchy of WebformVariantManager
See also
hook_webform_variant_info_alter()
\Drupal\webform\Annotation\WebformVariant
\Drupal\webform\Plugin\WebformVariantInterface
\Drupal\webform\Plugin\WebformVariantBase
1 string reference to 'WebformVariantManager'
1 service uses WebformVariantManager
File
- src/
Plugin/ WebformVariantManager.php, line 20
Namespace
Drupal\webform\PluginView source
class WebformVariantManager extends DefaultPluginManager implements WebformVariantManagerInterface {
use CategorizingPluginManagerTrait {
getSortedDefinitions as traitGetSortedDefinitions;
getGroupedDefinitions as traitGetGroupedDefinitions;
}
/**
* The configuration object factory.
*
* @var \Drupal\Core\Config\ConfigFactoryInterface
*/
protected $configFactory;
/**
* Constructs a WebformVariantManager 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 variant.
* @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
* The configuration object factory.
*/
public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, ConfigFactoryInterface $config_factory) {
parent::__construct('Plugin/WebformVariant', $namespaces, $module_handler, 'Drupal\\webform\\Plugin\\WebformVariantInterface', 'Drupal\\webform\\Annotation\\WebformVariant');
$this->configFactory = $config_factory;
$this
->alterInfo('webform_variant_info');
$this
->setCacheBackend($cache_backend, 'webform_variant_plugins');
}
/**
* {@inheritdoc}
*/
public function getSortedDefinitions(array $definitions = NULL, $sort_by = 'label') {
// Sort the plugins first by category, then by label.
$definitions = $this
->traitGetSortedDefinitions($definitions, $sort_by);
return $definitions;
}
/**
* {@inheritdoc}
*/
public function getGroupedDefinitions(array $definitions = NULL) {
$definitions = $this
->traitGetGroupedDefinitions($definitions);
// Do not display the 'broken' plugin in the UI.
unset($definitions[$this
->t('Broken')]['broken']);
return $definitions;
}
/**
* {@inheritdoc}
*/
public function removeExcludeDefinitions(array $definitions) {
$definitions = isset($definitions) ? $definitions : $this
->getDefinitions();
// Exclude 'broken' variant.
unset($definitions['broken']);
$excluded = $this->configFactory
->get('webform.settings')
->get('variant.excluded_variants') ?: [];
return $excluded ? array_diff_key($definitions, $excluded) : $definitions;
}
/**
* {@inheritdoc}
*/
public function getFallbackPluginId($plugin_id, array $configuration = []) {
return 'broken';
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
CategorizingPluginManagerTrait:: |
public | function | ||
CategorizingPluginManagerTrait:: |
public | function | Aliased as: traitGetGroupedDefinitions | |
CategorizingPluginManagerTrait:: |
public | function | Returns the module handler used. | |
CategorizingPluginManagerTrait:: |
protected | function | Gets the name of a provider. | |
CategorizingPluginManagerTrait:: |
public | function | Aliased as: traitGetSortedDefinitions | |
CategorizingPluginManagerTrait:: |
protected | function | Processes a plugin definition to ensure there is a category. | |
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:: |
6 |
DefaultPluginManager:: |
protected | function | Extracts the provider from a plugin definition. | |
DefaultPluginManager:: |
protected | function | Finds plugin definitions. | 7 |
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:: |
6 |
PluginManagerBase:: |
protected | function | Allows plugin managers to specify custom behavior if a plugin is not found. | 1 |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. | |
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. | |
UseCacheBackendTrait:: |
protected | function | Stores data in the persistent cache, respecting the use caches flag. | |
WebformVariantManager:: |
protected | property | The configuration object factory. | |
WebformVariantManager:: |
public | function |
Gets a fallback id for a missing plugin. Overrides FallbackPluginManagerInterface:: |
|
WebformVariantManager:: |
public | function |
Gets sorted plugin definitions grouped by category. Overrides CategorizingPluginManagerInterface:: |
|
WebformVariantManager:: |
public | function |
Gets sorted plugin definitions. Overrides CategorizingPluginManagerInterface:: |
|
WebformVariantManager:: |
public | function |
Remove excluded plugin definitions. Overrides WebformPluginManagerExcludedInterface:: |
|
WebformVariantManager:: |
public | function |
Constructs a WebformVariantManager object. Overrides DefaultPluginManager:: |