class FormatterPluginManager

Same name in other branches
  1. 9 core/lib/Drupal/Core/Field/FormatterPluginManager.php \Drupal\Core\Field\FormatterPluginManager
  2. 8.9.x core/lib/Drupal/Core/Field/FormatterPluginManager.php \Drupal\Core\Field\FormatterPluginManager
  3. 10 core/lib/Drupal/Core/Field/FormatterPluginManager.php \Drupal\Core\Field\FormatterPluginManager

Plugin type manager for field formatters.

Hierarchy

Expanded class hierarchy of FormatterPluginManager

Related topics

5 files declare their use of FormatterPluginManager
EntityField.php in core/modules/views/src/Plugin/views/field/EntityField.php
EntityFormDisplayAccessControlHandlerTest.php in core/tests/Drupal/Tests/Core/Entity/Access/EntityFormDisplayAccessControlHandlerTest.php
FieldBlock.php in core/modules/layout_builder/src/Plugin/Block/FieldBlock.php
FieldBlockDeriver.php in core/modules/layout_builder/src/Plugin/Derivative/FieldBlockDeriver.php
FieldBlockTest.php in core/modules/layout_builder/tests/src/Kernel/FieldBlockTest.php

File

core/lib/Drupal/Core/Field/FormatterPluginManager.php, line 16

Namespace

Drupal\Core\Field
View source
class FormatterPluginManager extends DefaultPluginManager {
    
    /**
     * An array of formatter options for each field type.
     *
     * @var array
     */
    protected $formatterOptions;
    
    /**
     * The field type manager to define field.
     *
     * @var \Drupal\Core\Field\FieldTypePluginManagerInterface
     */
    protected $fieldTypeManager;
    
    /**
     * Constructs a FormatterPluginManager 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/FieldFormatter', $namespaces, $module_handler, 'Drupal\\Core\\Field\\FormatterInterface', FieldFormatter::class, 'Drupal\\Core\\Field\\Annotation\\FieldFormatter');
        $this->setCacheBackend($cache_backend, 'field_formatter_types_plugins');
        $this->alterInfo('field_formatter_info');
        $this->fieldTypeManager = $field_type_manager;
    }
    
    /**
     * {@inheritdoc}
     */
    public function createInstance($plugin_id, array $configuration = []) {
        $plugin_definition = $this->getDefinition($plugin_id);
        $plugin_class = DefaultFactory::getPluginClass($plugin_id, $plugin_definition);
        // @todo This is copied from \Drupal\Core\Plugin\Factory\ContainerFactory.
        //   Find a way to restore sanity to
        //   \Drupal\Core\Field\FormatterBase::__construct().
        // 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['label'], $configuration['view_mode'], $configuration['third_party_settings']);
    }
    
    /**
     * Overrides PluginManagerBase::getInstance().
     *
     * @param array $options
     *   An array with the following key/value pairs:
     *   - field_definition: (FieldDefinitionInterface) The field definition.
     *   - view_mode: (string) The view mode.
     *   - prepare: (bool, optional) Whether default values should get merged in
     *     the 'configuration' array. Defaults to TRUE.
     *   - configuration: (array) the configuration for the formatter. The
     *     following key value pairs are allowed, and are all optional if
     *     'prepare' is TRUE:
     *     - label: (string) Position of the label. The default 'field' theme
     *       implementation supports the values 'inline', 'above' and 'hidden'.
     *       Defaults to 'above'.
     *     - type: (string) The formatter to use. Defaults to the
     *       'default_formatter' for the field type, The default formatter will
     *       also be used if the requested formatter is not available.
     *     - settings: (array) Settings specific to the formatter. Each setting
     *       defaults to the default value specified in the formatter definition.
     *     - third_party_settings: (array) Settings provided by other extensions
     *       through hook_field_formatter_third_party_settings_form().
     *
     * @return \Drupal\Core\Field\FormatterInterface|false
     *   A formatter object or FALSE when plugin is not found.
     */
    public function getInstance(array $options) {
        $configuration = $options['configuration'];
        $field_definition = $options['field_definition'];
        $field_type = $field_definition->getType();
        // Fill in default configuration if needed.
        if (!isset($options['prepare']) || $options['prepare'] == TRUE) {
            $configuration = $this->prepareConfiguration($field_type, $configuration);
        }
        $plugin_id = $configuration['type'];
        // Switch back to default formatter if either:
        // - the configuration does not specify a formatter class
        // - the field type is not allowed for the formatter
        // - the formatter 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_formatter'])) {
                return FALSE;
            }
            $plugin_id = $field_type_definition['default_formatter'];
        }
        $configuration += [
            'field_definition' => $field_definition,
            'view_mode' => $options['view_mode'],
        ];
        return $this->createInstance($plugin_id, $configuration) ?? FALSE;
    }
    
    /**
     * Merges default values for formatter configuration.
     *
     * @param string $field_type
     *   The field type.
     * @param array $configuration
     *   An array of formatter configuration.
     *
     * @return array
     *   The display properties with defaults added.
     */
    public function prepareConfiguration($field_type, array $configuration) {
        // Fill in defaults for missing properties.
        $configuration += [
            'label' => 'above',
            'settings' => [],
            'third_party_settings' => [],
        ];
        // If no formatter is specified, use the default formatter.
        if (!isset($configuration['type'])) {
            $field_type = $this->fieldTypeManager
                ->getDefinition($field_type);
            $configuration['type'] = $field_type['default_formatter'];
        }
        // 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 formatter options for a field type.
     *
     * @param string|null $field_type
     *   (optional) The name of a field type, or NULL to retrieve all formatters.
     *
     * @return array
     *   If no field type is provided, returns a nested array of all formatters,
     *   keyed by field type.
     */
    public function getOptions($field_type = NULL) {
        if (!isset($this->formatterOptions)) {
            $options = [];
            $field_types = $this->fieldTypeManager
                ->getDefinitions();
            $formatter_types = $this->getDefinitions();
            uasort($formatter_types, [
                'Drupal\\Component\\Utility\\SortArray',
                'sortByWeightElement',
            ]);
            foreach ($formatter_types as $name => $formatter_type) {
                foreach ($formatter_type['field_types'] as $formatter_field_type) {
                    // Check that the field type exists.
                    if (isset($field_types[$formatter_field_type])) {
                        $options[$formatter_field_type][$name] = $formatter_type['label'];
                    }
                }
            }
            $this->formatterOptions = $options;
        }
        if ($field_type) {
            return !empty($this->formatterOptions[$field_type]) ? $this->formatterOptions[$field_type] : [];
        }
        return $this->formatterOptions;
    }
    
    /**
     * Returns the default settings of a field formatter.
     *
     * @param string $type
     *   A field formatter type name.
     *
     * @return array
     *   The formatter 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

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::$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::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
FormatterPluginManager::$fieldTypeManager protected property The field type manager to define field.
FormatterPluginManager::$formatterOptions protected property An array of formatter options for each field type.
FormatterPluginManager::createInstance public function Overrides PluginManagerBase::createInstance
FormatterPluginManager::getDefaultSettings public function Returns the default settings of a field formatter.
FormatterPluginManager::getInstance public function Overrides PluginManagerBase::getInstance(). Overrides PluginManagerBase::getInstance
FormatterPluginManager::getOptions public function Returns an array of formatter options for a field type.
FormatterPluginManager::prepareConfiguration public function Merges default values for formatter configuration.
FormatterPluginManager::__construct public function Constructs a FormatterPluginManager 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::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.