class FieldTypePluginManager
Same name in other branches
- 9 core/lib/Drupal/Core/Field/FieldTypePluginManager.php \Drupal\Core\Field\FieldTypePluginManager
- 8.9.x core/lib/Drupal/Core/Field/FieldTypePluginManager.php \Drupal\Core\Field\FieldTypePluginManager
- 10 core/lib/Drupal/Core/Field/FieldTypePluginManager.php \Drupal\Core\Field\FieldTypePluginManager
Plugin manager for 'field type' plugins.
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\Field\FieldTypePluginManager extends \Drupal\Core\Plugin\DefaultPluginManager implements \Drupal\Core\Field\FieldTypePluginManagerInterface uses \Drupal\Core\Plugin\CategorizingPluginManagerTrait
- 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 FieldTypePluginManager
Related topics
2 files declare their use of FieldTypePluginManager
- BaseFieldDefinitionTestBase.php in core/
tests/ Drupal/ Tests/ Core/ Field/ BaseFieldDefinitionTestBase.php - FieldTypePluginManagerTest.php in core/
tests/ Drupal/ Tests/ Core/ Field/ FieldTypePluginManagerTest.php
File
-
core/
lib/ Drupal/ Core/ Field/ FieldTypePluginManager.php, line 19
Namespace
Drupal\Core\FieldView source
class FieldTypePluginManager extends DefaultPluginManager implements FieldTypePluginManagerInterface {
use CategorizingPluginManagerTrait {
getGroupedDefinitions as protected getGroupedDefinitionsTrait;
}
/**
* Constructs the FieldTypePluginManager 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\TypedData\TypedDataManagerInterface $typedDataManager
* The typed data manager.
* @param \Drupal\Core\Field\FieldTypeCategoryManagerInterface $fieldTypeCategoryManager
* The field type category plugin manager.
*/
public function __construct(\Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, TypedDataManagerInterface $typedDataManager, FieldTypeCategoryManagerInterface $fieldTypeCategoryManager) {
parent::__construct('Plugin/Field/FieldType', $namespaces, $module_handler, FieldItemInterface::class, FieldType::class, 'Drupal\\Core\\Field\\Annotation\\FieldType');
$this->alterInfo('field_info');
$this->setCacheBackend($cache_backend, 'field_types_plugins');
}
/**
* {@inheritdoc}
*
* Creates a field item, which is not part of an entity or field item list.
*
* @param string $field_type
* The field type, for which a field item should be created.
* @param array $configuration
* The plugin configuration array, i.e. an array with the following keys:
* - field_definition: The field definition object, i.e. an instance of
* Drupal\Core\Field\FieldDefinitionInterface.
*
* @return \Drupal\Core\Field\FieldItemInterface
* The instantiated object.
*/
public function createInstance($field_type, array $configuration = []) {
$configuration['data_definition'] = $configuration['field_definition']->getItemDefinition();
return $this->typedDataManager
->createInstance("field_item:{$field_type}", $configuration);
}
/**
* {@inheritdoc}
*/
public function createFieldItemList(FieldableEntityInterface $entity, $field_name, $values = NULL) {
// Leverage prototyping of the Typed Data API for fast instantiation.
return $this->typedDataManager
->getPropertyInstance($entity->getTypedData(), $field_name, $values);
}
/**
* {@inheritdoc}
*/
public function createFieldItem(FieldItemListInterface $items, $index, $values = NULL) {
// Leverage prototyping of the Typed Data API for fast instantiation.
return $this->typedDataManager
->getPropertyInstance($items, $index, $values);
}
/**
* {@inheritdoc}
*/
public function processDefinition(&$definition, $plugin_id) {
parent::processDefinition($definition, $plugin_id);
if (!isset($definition['list_class'])) {
$definition['list_class'] = '\\Drupal\\Core\\Field\\FieldItemList';
}
if (empty($definition['category'])) {
$definition['category'] = FieldTypeCategoryManagerInterface::FALLBACK_CATEGORY;
}
}
/**
* {@inheritdoc}
*/
public function getDefaultStorageSettings($type) {
$plugin_definition = $this->getDefinition($type, FALSE);
if (!empty($plugin_definition['class'])) {
$plugin_class = DefaultFactory::getPluginClass($type, $plugin_definition);
return $plugin_class::defaultStorageSettings();
}
return [];
}
/**
* {@inheritdoc}
*/
public function getDefaultFieldSettings($type) {
$plugin_definition = $this->getDefinition($type, FALSE);
if (!empty($plugin_definition['class'])) {
$plugin_class = DefaultFactory::getPluginClass($type, $plugin_definition);
return $plugin_class::defaultFieldSettings();
}
return [];
}
/**
* {@inheritdoc}
*/
public function getStorageSettingsSummary(FieldStorageDefinitionInterface $storage_definition) : array {
$plugin_definition = $this->getDefinition($storage_definition->getType(), FALSE);
if (!empty($plugin_definition['class'])) {
$plugin_class = DefaultFactory::getPluginClass($storage_definition->getType(), $plugin_definition);
return $plugin_class::storageSettingsSummary($storage_definition);
}
return [];
}
/**
* {@inheritdoc}
*/
public function getFieldSettingsSummary(FieldDefinitionInterface $field_definition) : array {
$plugin_definition = $this->getDefinition($field_definition->getType(), FALSE);
if (!empty($plugin_definition['class'])) {
$plugin_class = DefaultFactory::getPluginClass($field_definition->getType(), $plugin_definition);
return $plugin_class::fieldSettingsSummary($field_definition);
}
return [];
}
/**
* Gets sorted field type definitions grouped by category.
*
* In addition to grouping, both categories and its entries are sorted,
* whereas plugin definitions are sorted by label.
*
* @param array[]|null $definitions
* (optional) The plugin definitions to group. If omitted, all plugin
* definitions are used.
* @param string $label_key
* (optional) The array key to use as the label of the field type.
* @param string $category_label_key
* (optional) The array key to use as the label of the category.
*
* @return array[]
* Keys are category names, and values are arrays of which the keys are
* plugin IDs and the values are plugin definitions.
*/
public function getGroupedDefinitions(?array $definitions = NULL, $label_key = 'label', $category_label_key = 'label') {
$grouped_categories = $this->getGroupedDefinitionsTrait($definitions, $label_key);
$category_info = $this->fieldTypeCategoryManager
->getDefinitions();
// Ensure that all the referenced categories exist.
foreach ($grouped_categories as $group => $definitions) {
if (!isset($category_info[$group])) {
assert(FALSE, "\"{$group}\" must be defined in MODULE_NAME.field_type_categories.yml");
if (!isset($grouped_categories[FieldTypeCategoryManagerInterface::FALLBACK_CATEGORY])) {
$grouped_categories[FieldTypeCategoryManagerInterface::FALLBACK_CATEGORY] = [];
}
$grouped_categories[FieldTypeCategoryManagerInterface::FALLBACK_CATEGORY] += $definitions;
unset($grouped_categories[$group]);
}
}
$normalized_grouped_categories = [];
foreach ($grouped_categories as $group => $definitions) {
$normalized_grouped_categories[(string) $category_info[$group][$category_label_key]] = $definitions;
}
return $normalized_grouped_categories;
}
/**
* {@inheritdoc}
*/
public function getUiDefinitions() {
$definitions = $this->getDefinitions();
// Filter out definitions that can not be configured in Field UI.
$definitions = array_filter($definitions, function ($definition) {
return empty($definition['no_ui']);
});
// Add preconfigured definitions.
foreach ($definitions as $id => $definition) {
if (is_subclass_of($definition['class'], '\\Drupal\\Core\\Field\\PreconfiguredFieldUiOptionsInterface')) {
foreach ($this->getPreconfiguredOptions($definition['id']) as $key => $option) {
$definitions["field_ui:{$id}:{$key}"] = array_intersect_key($option, [
'label' => 0,
'category' => 1,
'weight' => 1,
'description' => 0,
]) + $definition;
}
}
}
return $definitions;
}
/**
* {@inheritdoc}
*/
public function getEntityTypeUiDefinitions(string $entity_type_id) : array {
$ui_definitions = $this->getUiDefinitions();
$this->moduleHandler
->alter('field_info_entity_type_ui_definitions', $ui_definitions, $entity_type_id);
return $ui_definitions;
}
/**
* {@inheritdoc}
*/
public function getPreconfiguredOptions($field_type) {
$options = [];
$class = $this->getPluginClass($field_type);
if (is_subclass_of($class, '\\Drupal\\Core\\Field\\PreconfiguredFieldUiOptionsInterface')) {
$options = $class::getPreconfiguredOptions();
$this->moduleHandler
->alter('field_ui_preconfigured_options', $options, $field_type);
}
return $options;
}
/**
* {@inheritdoc}
*/
public function getPluginClass($type) {
return $this->getDefinition($type)['class'];
}
}
Members
Title Sort descending | Deprecated | Modifiers | Object type | Summary | Member alias | Overriden Title | Overrides |
---|---|---|---|---|---|---|---|
CategorizingPluginManagerTrait::getCategories | public | function | |||||
CategorizingPluginManagerTrait::getGroupedDefinitions | public | function | Aliased as: getGroupedDefinitionsTrait | ||||
CategorizingPluginManagerTrait::getModuleExtensionList | protected | function | Returns the module extension list used. | ||||
CategorizingPluginManagerTrait::getModuleHandler | Deprecated | public | function | Returns the module handler used. | |||
CategorizingPluginManagerTrait::getProviderName | protected | function | Gets the name of a provider. | ||||
CategorizingPluginManagerTrait::getSortedDefinitions | public | function | |||||
CategorizingPluginManagerTrait::processDefinitionCategory | protected | function | Processes a plugin definition to ensure there is a category. | ||||
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 | 16 | ||
DefaultPluginManager::getFactory | protected | function | Gets the plugin factory. | Overrides PluginManagerBase::getFactory | |||
DefaultPluginManager::providerExists | protected | function | Determines if the provider of a definition exists. | 5 | |||
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 | |||||
FieldTypePluginManager::createFieldItem | public | function | Creates a new field item as part of a field item list. | Overrides FieldTypePluginManagerInterface::createFieldItem | |||
FieldTypePluginManager::createFieldItemList | public | function | Creates a new field item list. | Overrides FieldTypePluginManagerInterface::createFieldItemList | |||
FieldTypePluginManager::createInstance | public | function | Creates a field item, which is not part of an entity or field item list. | Overrides PluginManagerBase::createInstance | |||
FieldTypePluginManager::getDefaultFieldSettings | public | function | Returns the default field-level settings for a field type. | Overrides FieldTypePluginManagerInterface::getDefaultFieldSettings | |||
FieldTypePluginManager::getDefaultStorageSettings | public | function | Returns the default storage-level settings for a field type. | Overrides FieldTypePluginManagerInterface::getDefaultStorageSettings | |||
FieldTypePluginManager::getEntityTypeUiDefinitions | public | function | Get the field type definitions that can be added via UI for an entity type. | Overrides FieldTypePluginManagerInterface::getEntityTypeUiDefinitions | |||
FieldTypePluginManager::getFieldSettingsSummary | public | function | Returns the summary of field-level settings for a field type. | Overrides FieldTypePluginManagerInterface::getFieldSettingsSummary | |||
FieldTypePluginManager::getGroupedDefinitions | public | function | Gets sorted field type definitions grouped by category. | Overrides CategorizingPluginManagerInterface::getGroupedDefinitions | |||
FieldTypePluginManager::getPluginClass | public | function | Returns the PHP class that implements the field type plugin. | Overrides FieldTypePluginManagerInterface::getPluginClass | |||
FieldTypePluginManager::getPreconfiguredOptions | public | function | Returns preconfigured field options for a field type. | Overrides FieldTypePluginManagerInterface::getPreconfiguredOptions | |||
FieldTypePluginManager::getStorageSettingsSummary | public | function | Returns the summary of storage-level settings for a field type. | Overrides FieldTypePluginManagerInterface::getStorageSettingsSummary | |||
FieldTypePluginManager::getUiDefinitions | public | function | Gets the definition of all field types that can be added via UI. | Overrides FieldTypePluginManagerInterface::getUiDefinitions | |||
FieldTypePluginManager::processDefinition | public | function | Performs extra processing on plugin definitions. | Overrides DefaultPluginManager::processDefinition | |||
FieldTypePluginManager::__construct | public | function | Constructs the FieldTypePluginManager 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::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 | |||
StringTranslationTrait::$stringTranslation | protected | property | The string translation service. | 3 | |||
StringTranslationTrait::formatPlural | protected | function | Formats a string containing a count of items. | ||||
StringTranslationTrait::getNumberOfPlurals | protected | function | Returns the number of plurals supported by a given language. | ||||
StringTranslationTrait::getStringTranslation | protected | function | Gets the string translation service. | ||||
StringTranslationTrait::setStringTranslation | public | function | Sets the string translation service to use. | 2 | |||
StringTranslationTrait::t | protected | function | Translates a string to the current language or to a given language. | ||||
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.