class WidgetPluginManager in Drupal 10
Same name and namespace in other branches
- 8 core/lib/Drupal/Core/Field/WidgetPluginManager.php \Drupal\Core\Field\WidgetPluginManager
- 9 core/lib/Drupal/Core/Field/WidgetPluginManager.php \Drupal\Core\Field\WidgetPluginManager
Plugin type manager for field widgets.
Hierarchy
- class \Drupal\Component\Plugin\PluginManagerBase implements PluginManagerInterface uses DiscoveryTrait
- class \Drupal\Core\Plugin\DefaultPluginManager implements CachedDiscoveryInterface, PluginManagerInterface, CacheableDependencyInterface uses DiscoveryCachedTrait, UseCacheBackendTrait
- class \Drupal\Core\Field\WidgetPluginManager
- class \Drupal\Core\Plugin\DefaultPluginManager implements CachedDiscoveryInterface, PluginManagerInterface, CacheableDependencyInterface uses DiscoveryCachedTrait, UseCacheBackendTrait
Expanded class hierarchy of WidgetPluginManager
Related topics
1 string reference to 'WidgetPluginManager'
- core.services.yml in core/
core.services.yml - core/core.services.yml
1 service uses WidgetPluginManager
File
- core/
lib/ Drupal/ Core/ Field/ WidgetPluginManager.php, line 15
Namespace
Drupal\Core\FieldView source
class WidgetPluginManager extends DefaultPluginManager {
/**
* The field type manager to define field.
*
* @var \Drupal\Core\Field\FieldTypePluginManagerInterface
*/
protected $fieldTypeManager;
/**
* An array of widget options for each field type.
*
* @var array
*/
protected $widgetOptions;
/**
* Constructs a WidgetPluginManager 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.
* @param \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_manager
* The 'field type' plugin manager.
*/
public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, FieldTypePluginManagerInterface $field_type_manager) {
parent::__construct('Plugin/Field/FieldWidget', $namespaces, $module_handler, 'Drupal\\Core\\Field\\WidgetInterface', 'Drupal\\Core\\Field\\Annotation\\FieldWidget');
$this
->setCacheBackend($cache_backend, 'field_widget_types_plugins');
$this
->alterInfo('field_widget_info');
$this->fieldTypeManager = $field_type_manager;
}
/**
* Overrides PluginManagerBase::getInstance().
*
* @param array $options
* An array with the following key/value pairs:
* - field_definition: (FieldDefinitionInterface) The field definition.
* - form_mode: (string) The form mode.
* - prepare: (bool, optional) Whether default values should get merged in
* the 'configuration' array. Defaults to TRUE.
* - configuration: (array) the configuration for the widget. The
* following key value pairs are allowed, and are all optional if
* 'prepare' is TRUE:
* - type: (string) The widget to use. Defaults to the
* 'default_widget' for the field type. The default widget will also be
* used if the requested widget is not available.
* - settings: (array) Settings specific to the widget. Each setting
* defaults to the default value specified in the widget definition.
* - third_party_settings: (array) Settings provided by other extensions
* through hook_field_formatter_third_party_settings_form().
*
* @return \Drupal\Core\Field\WidgetInterface|false
* A Widget object or FALSE when plugin is not found.
*/
public function getInstance(array $options) {
// Fill in defaults for missing properties.
$options += [
'configuration' => [],
'prepare' => TRUE,
];
$configuration = $options['configuration'];
$field_definition = $options['field_definition'];
$field_type = $field_definition
->getType();
// Fill in default configuration if needed.
if ($options['prepare']) {
$configuration = $this
->prepareConfiguration($field_type, $configuration);
}
$plugin_id = $configuration['type'];
// Switch back to default widget if either:
// - the configuration does not specify a widget class
// - the field type is not allowed for the widget
// - the widget is not applicable to the field definition.
$definition = $this
->getDefinition($configuration['type'], FALSE);
if (!isset($definition['class']) || !in_array($field_type, $definition['field_types']) || !$definition['class']::isApplicable($field_definition)) {
// Grab the default widget for the field type.
$field_type_definition = $this->fieldTypeManager
->getDefinition($field_type);
if (empty($field_type_definition['default_widget'])) {
return FALSE;
}
$plugin_id = $field_type_definition['default_widget'];
}
$configuration += [
'field_definition' => $field_definition,
];
return $this
->createInstance($plugin_id, $configuration) ?? FALSE;
}
/**
* {@inheritdoc}
*/
public function createInstance($plugin_id, array $configuration = []) {
$plugin_definition = $this
->getDefinition($plugin_id);
$plugin_class = DefaultFactory::getPluginClass($plugin_id, $plugin_definition);
// If the plugin provides a factory method, pass the container to it.
if (is_subclass_of($plugin_class, 'Drupal\\Core\\Plugin\\ContainerFactoryPluginInterface')) {
return $plugin_class::create(\Drupal::getContainer(), $configuration, $plugin_id, $plugin_definition);
}
return new $plugin_class($plugin_id, $plugin_definition, $configuration['field_definition'], $configuration['settings'], $configuration['third_party_settings']);
}
/**
* Merges default values for widget configuration.
*
* @param string $field_type
* The field type.
* @param array $configuration
* An array of widget configuration.
*
* @return array
* The display properties with defaults added.
*/
public function prepareConfiguration($field_type, array $configuration) {
// Fill in defaults for missing properties.
$configuration += [
'settings' => [],
'third_party_settings' => [],
];
// If no widget is specified, use the default widget.
if (!isset($configuration['type'])) {
$field_type = $this->fieldTypeManager
->getDefinition($field_type);
$configuration['type'] = $field_type['default_widget'] ?? NULL;
}
// Filter out unknown settings, and fill in defaults for missing settings.
$default_settings = $this
->getDefaultSettings($configuration['type']);
$configuration['settings'] = array_intersect_key($configuration['settings'], $default_settings) + $default_settings;
return $configuration;
}
/**
* Returns an array of widget type options for a field type.
*
* @param string|null $field_type
* (optional) The name of a field type, or NULL to retrieve all widget
* options. Defaults to NULL.
*
* @return array
* If no field type is provided, returns a nested array of all widget types,
* keyed by field type human name.
*/
public function getOptions($field_type = NULL) {
if (!isset($this->widgetOptions)) {
$options = [];
$field_types = $this->fieldTypeManager
->getDefinitions();
$widget_types = $this
->getDefinitions();
uasort($widget_types, [
'Drupal\\Component\\Utility\\SortArray',
'sortByWeightElement',
]);
foreach ($widget_types as $name => $widget_type) {
foreach ($widget_type['field_types'] as $widget_field_type) {
// Check that the field type exists.
if (isset($field_types[$widget_field_type])) {
$options[$widget_field_type][$name] = $widget_type['label'];
}
}
}
$this->widgetOptions = $options;
}
if (isset($field_type)) {
return !empty($this->widgetOptions[$field_type]) ? $this->widgetOptions[$field_type] : [];
}
return $this->widgetOptions;
}
/**
* Returns the default settings of a field widget.
*
* @param string $type
* A field widget type name.
*
* @return array
* The widget type's default settings, as provided by the plugin
* definition, or an empty array if type or settings are undefined.
*/
public function getDefaultSettings($type) {
$plugin_definition = $this
->getDefinition($type, FALSE);
if (!empty($plugin_definition['class'])) {
$plugin_class = DefaultFactory::getPluginClass($type, $plugin_definition);
return $plugin_class::defaultSettings();
}
return [];
}
}
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:: |
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:: |
13 |
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:: |
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. | |
UseCacheBackendTrait:: |
protected | function | Stores data in the persistent cache, respecting the use caches flag. | |
WidgetPluginManager:: |
protected | property | The field type manager to define field. | |
WidgetPluginManager:: |
protected | property | An array of widget options for each field type. | |
WidgetPluginManager:: |
public | function |
Creates a pre-configured instance of a plugin. Overrides PluginManagerBase:: |
|
WidgetPluginManager:: |
public | function | Returns the default settings of a field widget. | |
WidgetPluginManager:: |
public | function |
Overrides PluginManagerBase::getInstance(). Overrides PluginManagerBase:: |
|
WidgetPluginManager:: |
public | function | Returns an array of widget type options for a field type. | |
WidgetPluginManager:: |
public | function | Merges default values for widget configuration. | |
WidgetPluginManager:: |
public | function |
Constructs a WidgetPluginManager object. Overrides DefaultPluginManager:: |