class FieldTypeCategoryManager
Same name in other branches
- 11.x core/lib/Drupal/Core/Field/FieldTypeCategoryManager.php \Drupal\Core\Field\FieldTypeCategoryManager
Defines a field type category info plugin manager.
A module can define field type categories in a MODULE_NAME.field_type_categories.yml file contained in the module's base directory. Each plugin has the following structure:
CATEGORY_NAME:
label: STRING
description: STRING
weight: INTEGER
libraries:
- STRING
For example:
text:
label: Text
description: Text fields.
weight: 2
libraries:
- module_name/library_name
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\FieldTypeCategoryManager extends \Drupal\Core\Plugin\DefaultPluginManager implements \Drupal\Core\Field\FieldTypeCategoryManagerInterface, \Drupal\Component\Plugin\FallbackPluginManagerInterface
- 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 FieldTypeCategoryManager
See also
\Drupal\Core\Field\FieldTypeCategoryInterface
\Drupal\Core\Field\FieldTypeCategory
\hook_field_type_category_info_alter
1 string reference to 'FieldTypeCategoryManager'
- core.services.yml in core/
core.services.yml - core/core.services.yml
1 service uses FieldTypeCategoryManager
File
-
core/
lib/ Drupal/ Core/ Field/ FieldTypeCategoryManager.php, line 39
Namespace
Drupal\Core\FieldView source
class FieldTypeCategoryManager extends DefaultPluginManager implements FieldTypeCategoryManagerInterface, FallbackPluginManagerInterface {
/**
* {@inheritdoc}
*/
protected $defaults = [
'label' => '',
'description' => '',
'weight' => 0,
'class' => FieldTypeCategory::class,
];
/**
* Constructs a new FieldTypeCategoryManager.
*
* @param string $root
* The app root.
* @param \Drupal\Core\Extension\ModuleHandlerInterface $module_handler
* The module handler.
* @param \Drupal\Core\Cache\CacheBackendInterface $cache_backend
* The cache backend.
*/
public function __construct(string $root, ModuleHandlerInterface $module_handler, CacheBackendInterface $cache_backend) {
$this->moduleHandler = $module_handler;
$this->alterInfo('field_type_category_info');
$this->setCacheBackend($cache_backend, 'field_type_category_info_plugins');
}
/**
* {@inheritdoc}
*/
protected function getDiscovery() : YamlDiscovery {
if (!isset($this->discovery)) {
$directories = [
'core' => $this->root . '/core',
];
$directories += $this->moduleHandler
->getModuleDirectories();
$this->discovery = new YamlDiscovery('field_type_categories', $directories);
$this->discovery
->addTranslatableProperty('label')
->addTranslatableProperty('description');
}
return $this->discovery;
}
/**
* {@inheritdoc}
*/
protected function alterDefinitions(&$definitions) : void {
parent::alterDefinitions($definitions);
if (!isset($definitions[FieldTypeCategoryManagerInterface::FALLBACK_CATEGORY])) {
throw new \LogicException('Missing fallback category.');
}
}
/**
* {@inheritdoc}
*/
public function getFallbackPluginId($plugin_id, array $configuration = []) : string {
return FieldTypeCategoryManagerInterface::FALLBACK_CATEGORY;
}
}
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::$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::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::getFactory | protected | function | Gets the plugin factory. | Overrides PluginManagerBase::getFactory | |
DefaultPluginManager::processDefinition | public | function | Performs extra processing on plugin definitions. | 14 | |
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 | |||
FieldTypeCategoryManager::$defaults | protected | property | A set of defaults to be referenced by $this->processDefinition(). | Overrides DefaultPluginManager::$defaults | |
FieldTypeCategoryManager::alterDefinitions | protected | function | Invokes the hook to alter the definitions if the alter hook is set. | Overrides DefaultPluginManager::alterDefinitions | |
FieldTypeCategoryManager::getDiscovery | protected | function | Gets the plugin discovery. | Overrides DefaultPluginManager::getDiscovery | |
FieldTypeCategoryManager::getFallbackPluginId | public | function | Gets a fallback id for a missing plugin. | Overrides PluginManagerBase::getFallbackPluginId | |
FieldTypeCategoryManager::__construct | public | function | Constructs a new FieldTypeCategoryManager. | 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::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.