FieldTypePluginManager
class FieldTypePluginManager extends DefaultPluginManager implements FieldTypePluginManagerInterface (View source)
Plugin manager for 'field type' plugins.
Traits
Provides a trait for the CategorizingPluginManagerInterface.
Wrapper methods for \Drupal\Core\StringTranslation\TranslationInterface.
Provides methods to use a cache backend while respecting a 'use caches' flag.
Properties
| protected DiscoveryInterface | $discovery | The object that discovers plugins managed by this manager. |
from PluginManagerBase |
| protected FactoryInterface | $factory | The object that instantiates plugins managed by this manager. |
from PluginManagerBase |
| protected MapperInterface|null | $mapper | The object that returns the preconfigured plugin instance appropriate for a particular runtime condition. |
from PluginManagerBase |
| protected array | $definitions | Cached definitions array. |
from DiscoveryCachedTrait |
| protected CacheBackendInterface | $cacheBackend | Cache backend instance. |
from UseCacheBackendTrait |
| protected bool | $useCaches | Flag whether caches should be used or skipped. |
from UseCacheBackendTrait |
| protected string | $cacheKey | The cache key. |
from DefaultPluginManager |
| protected array | $cacheTags | An array of cache tags to use for the cached definitions. |
from DefaultPluginManager |
| protected string | $alterHook | Name of the alter hook if one should be invoked. |
from DefaultPluginManager |
| protected string|bool | $subdir | The subdirectory within a namespace to look for plugins, or FALSE if the plugins are in the top level of the namespace. |
from DefaultPluginManager |
| protected ModuleHandlerInterface | $moduleHandler | The module handler to invoke the alter hook. |
from DefaultPluginManager |
| protected array | $defaults | A set of defaults to be referenced by $this->processDefinition() if additional processing of plugins is necessary or helpful for development purposes. |
from DefaultPluginManager |
| protected string | $pluginDefinitionAnnotationName | The name of the annotation that contains the plugin definition. |
from DefaultPluginManager |
| protected string|null | $pluginInterface | The interface each plugin should implement. |
from DefaultPluginManager |
| protected Traversable | $namespaces | An object that implements \Traversable which contains the root paths keyed by the corresponding namespace to look for plugin implementations. |
from DefaultPluginManager |
| protected string[] | $additionalAnnotationNamespaces | Additional namespaces the annotation discovery mechanism should scan for annotation definitions. |
from DefaultPluginManager |
| protected TranslationInterface | $stringTranslation | The string translation service. |
from StringTranslationTrait |
| protected TypedDataManagerInterface | $typedDataManager | The typed data manager. |
Methods
Gets a specific plugin definition.
Creates a pre-configured instance of a plugin.
Allows plugin managers to specify custom behavior if a plugin is not found.
Gets a preconfigured instance of a plugin.
Fetches from the cache backend, respecting the use caches flag.
Stores data in the persistent cache, respecting the use caches flag.
Constructs the FieldTypePluginManager object.
Initialize the cache backend.
Clears static and persistent plugin definition caches.
Returns the cached plugin definitions of the decorated discovery class.
Sets a cache of plugin definitions for the decorated discovery class.
Performs extra processing on plugin definitions.
Extracts the provider from a plugin definition.
Invokes the hook to alter the definitions if the alter hook is set.
Determines if the provider of a definition exists.
The cache contexts associated with this object.
Translates a string to the current language or to a given language.
Formats a string containing a count of items.
Returns the number of plurals supported by a given language.
Gets the string translation service.
Processes a plugin definition to ensure there is a category.
Gets the name of a provider.
Returns the module handler used.
{@inheritdoc}
{@inheritdoc}
Creates a new field item list.
Creates a new field item as part of a field item list.
Returns the default storage-level settings for a field type.
Returns the default field-level settings for a field type.
Gets the definition of all field types that can be added via UI.
Returns preconfigured field options for a field type.
Returns the PHP class that implements the field type plugin.
Details
abstract
getDefinitions()
{@inheritdoc}
getDefinition($plugin_id, $exception_on_invalid = TRUE)
{@inheritdoc}
protected array|null
doGetDefinition(array $definitions, string $plugin_id, bool $exception_on_invalid)
Gets a specific plugin definition.
hasDefinition($plugin_id)
{@inheritdoc}
protected DiscoveryInterface
getDiscovery()
Gets the plugin discovery.
protected FactoryInterface
getFactory()
Gets the plugin factory.
object
createInstance(string $field_type, array $configuration = [])
Creates a pre-configured instance of a plugin.
protected object
handlePluginNotFound(string $plugin_id, array $configuration)
Allows plugin managers to specify custom behavior if a plugin is not found.
object|false
getInstance(array $options)
Gets a preconfigured instance of a plugin.
protected object|false
cacheGet(string $cid)
Fetches from the cache backend, respecting the use caches flag.
protected
cacheSet(string $cid, mixed $data, int $expire = Cache::PERMANENT, array $tags = [])
Stores data in the persistent cache, respecting the use caches flag.
__construct(Traversable $namespaces, CacheBackendInterface $cache_backend, ModuleHandlerInterface $module_handler, TypedDataManagerInterface $typed_data_manager)
Constructs the FieldTypePluginManager object.
setCacheBackend(CacheBackendInterface $cache_backend, string $cache_key, array $cache_tags = [])
Initialize the cache backend.
Plugin definitions are cached using the provided cache backend.
protected
alterInfo(string $alter_hook)
Sets the alter hook name.
clearCachedDefinitions()
Clears static and persistent plugin definition caches.
Don't resort to calling \Drupal::cache()->delete() and friends to make Drupal detect new or updated plugin definitions. Always use this method on the appropriate plugin type's plugin manager!
protected array|null
getCachedDefinitions()
Returns the cached plugin definitions of the decorated discovery class.
protected
setCachedDefinitions(array $definitions)
Sets a cache of plugin definitions for the decorated discovery class.
useCaches(bool $use_caches = FALSE)
Disable the use of caches.
Can be used to ensure that uncached plugin definitions are returned, without invalidating all cached information.
This will also remove all local/static caches.
processDefinition($definition, $plugin_id)
Performs extra processing on plugin definitions.
By default we add defaults for the type to the definition. If a type has additional processing logic they can do that by replacing or extending the method.
protected array
findDefinitions()
Finds plugin definitions.
protected string|null
extractProviderFromDefinition(mixed $plugin_definition)
Extracts the provider from a plugin definition.
protected
alterDefinitions($definitions)
Invokes the hook to alter the definitions if the alter hook is set.
protected bool
providerExists($provider)
Determines if the provider of a definition exists.
string[]
getCacheContexts()
The cache contexts associated with this object.
These identify a specific variation/representation of the object.
Cache contexts are tokens: placeholders that are converted to cache keys by the @cache_contexts_manager service. The replacement value depends on the request context (the current URL, language, and so on). They're converted before storing an object in cache.
string[]
getCacheTags()
The cache tags associated with this object.
When this object is modified, these cache tags will be invalidated.
int
getCacheMaxAge()
The maximum age for which this object may be cached.
protected TranslatableMarkup
t(string $string, array $args = [], array $options = [])
Translates a string to the current language or to a given language.
See \Drupal\Core\StringTranslation\TranslatableMarkup::__construct() for important security information and usage guidelines.
In order for strings to be localized, make them available in one of the ways supported by the
protected
formatPlural($count, $singular, $plural, array $args = [], array $options = [])
Formats a string containing a count of items.
protected
getNumberOfPlurals($langcode = NULL)
Returns the number of plurals supported by a given language.
protected TranslationInterface
getStringTranslation()
Gets the string translation service.
$this
setStringTranslation(TranslationInterface $translation)
Sets the string translation service to use.
protected
processDefinitionCategory(array $definition)
Processes a plugin definition to ensure there is a category.
If the definition lacks a category, it defaults to the providing module.
protected string
getProviderName(string $provider)
Gets the name of a provider.
ModuleHandlerInterface
getModuleHandler()
Returns the module handler used.
getCategories()
{@inheritdoc}
getSortedDefinitions(array $definitions = NULL, $label_key = 'label')
{@inheritdoc}
getGroupedDefinitions(array $definitions = NULL, $label_key = 'label')
{@inheritdoc}
FieldItemListInterface
createFieldItemList(FieldableEntityInterface $entity, string $field_name, mixed $values = NULL)
Creates a new field item list.
The provided entity is assigned as the parent of the created item list. However, it is the responsibility of the caller (usually the parent entity itself) to make the parent aware of the field as a new child.
FieldItemInterface
createFieldItem(FieldItemListInterface $items, int $index, array|null $values = NULL)
Creates a new field item as part of a field item list.
The provided item list is assigned as the parent of the created item. It However, it is the responsibility of the caller (usually the parent list itself) to have the parent aware of the item as a new child.
array
getDefaultStorageSettings(string $type)
Returns the default storage-level settings for a field type.
array
getDefaultFieldSettings(string $type)
Returns the default field-level settings for a field type.
array
getUiDefinitions()
Gets the definition of all field types that can be added via UI.
array
getPreconfiguredOptions(string $field_type)
Returns preconfigured field options for a field type.
This is a wrapper around \Drupal\Core\Field\PreconfiguredFieldUiOptionsInterface::getPreconfiguredOptions() allowing modules to alter the result of this method by implementing hook_field_ui_preconfigured_options_alter().
string
getPluginClass(string $type)
Returns the PHP class that implements the field type plugin.