Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. MigrateFieldPluginManager.php

class MigrateFieldPluginManager

Plugin manager for migrate field 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\migrate\Plugin\MigratePluginManager extends \Drupal\Core\Plugin\DefaultPluginManager implements \Drupal\migrate\Plugin\MigratePluginManagerInterface
        • class \Drupal\migrate_drupal\Plugin\MigrateFieldPluginManager extends \Drupal\migrate\Plugin\MigratePluginManager implements \Drupal\migrate_drupal\Plugin\MigrateFieldPluginManagerInterface

Expanded class hierarchy of MigrateFieldPluginManager

See also

\Drupal\migrate_drupal\Plugin\MigrateFieldInterface

\Drupal\migrate\Attribute\MigrateField

Plugin API

Related topics

Migrate API
Overview of the Migrate API, which migrates data into Drupal.
1 string reference to 'MigrateFieldPluginManager'
migrate_drupal.services.yml in core/modules/migrate_drupal/migrate_drupal.services.yml
core/modules/migrate_drupal/migrate_drupal.services.yml
1 service uses MigrateFieldPluginManager
plugin.manager.migrate.field in core/modules/migrate_drupal/migrate_drupal.services.yml
Drupal\migrate_drupal\Plugin\MigrateFieldPluginManager

File

core/modules/migrate_drupal/src/Plugin/MigrateFieldPluginManager.php, line 19

Namespace

Drupal\migrate_drupal\Plugin
View source
class MigrateFieldPluginManager extends MigratePluginManager implements MigrateFieldPluginManagerInterface {
    
    /**
     * The default version of core to use for field plugins.
     *
     * These plugins were initially only built and used for Drupal 6 fields.
     * Having been extended for Drupal 7 with a "core" annotation, we fall back to
     * Drupal 6 where none exists.
     */
    const DEFAULT_CORE_VERSION = 6;
    
    /**
     * Get the plugin ID from the field type.
     *
     * This method determines which field plugin should be used for a given field
     * type and Drupal core version, returning the lowest weighted plugin
     * supporting the provided core version, and which matches the field type
     * either by plugin ID, or in the type_map annotation keys.
     *
     * @param string $field_type
     *   The field type being migrated.
     * @param array $configuration
     *   (optional) An array of configuration relevant to the plugin instance.
     * @param \Drupal\migrate\Plugin\MigrationInterface $migration
     *   (optional) The current migration instance.
     *
     * @return string
     *   The ID of the plugin for the field type if available.
     *
     * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
     *   If the plugin cannot be determined, such as if the field type is invalid.
     *
     * @see \Drupal\migrate_drupal\Attribute\MigrateField
     */
    public function getPluginIdFromFieldType($field_type, array $configuration = [], ?MigrationInterface $migration = NULL) {
        $core = static::DEFAULT_CORE_VERSION;
        if (!empty($configuration['core'])) {
            $core = $configuration['core'];
        }
        elseif (!empty($migration->getPluginDefinition()['migration_tags'])) {
            foreach ($migration->getPluginDefinition()['migration_tags'] as $tag) {
                if ($tag == 'Drupal 7') {
                    $core = 7;
                }
            }
        }
        $definitions = $this->getDefinitions();
        foreach ($definitions as $plugin_id => $definition) {
            if (in_array($core, $definition['core'])) {
                if (array_key_exists($field_type, $definition['type_map']) || $field_type === $plugin_id) {
                    return $plugin_id;
                }
            }
        }
        throw new PluginNotFoundException($field_type);
    }
    
    /**
     * {@inheritdoc}
     */
    public function processDefinition(&$definition, $plugin_id) {
        parent::processDefinition($definition, $plugin_id);
        foreach ([
            'core',
            'source_module',
            'destination_module',
        ] as $required_property) {
            if (empty($definition[$required_property])) {
                throw new BadPluginDefinitionException($plugin_id, $required_property);
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    protected function findDefinitions() {
        $definitions = parent::findDefinitions();
        $this->sortDefinitions($definitions);
        return $definitions;
    }
    
    /**
     * Sorts a definitions array.
     *
     * This sorts the definitions array first by the weight column, and then by
     * the plugin ID, ensuring a stable, deterministic, and testable ordering of
     * plugins.
     *
     * @param array $definitions
     *   The definitions array to sort.
     */
    protected function sortDefinitions(array &$definitions) {
        array_multisort(array_column($definitions, 'weight'), SORT_ASC, SORT_NUMERIC, array_keys($definitions), SORT_ASC, SORT_NATURAL, $definitions);
    }

}

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(). 10
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. 4
DefaultPluginManager::alterInfo protected function Sets the alter hook name.
DefaultPluginManager::clearCachedDefinitions public function Clears static and persistent plugin definition caches. Overrides CachedDiscoveryInterface::clearCachedDefinitions 9
DefaultPluginManager::extractProviderFromDefinition protected function Extracts the provider from a plugin definition.
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 1
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
MigrateFieldPluginManager::DEFAULT_CORE_VERSION constant The default version of core to use for field plugins.
MigrateFieldPluginManager::findDefinitions protected function Finds plugin definitions. Overrides DefaultPluginManager::findDefinitions
MigrateFieldPluginManager::getPluginIdFromFieldType public function Get the plugin ID from the field type.
MigrateFieldPluginManager::processDefinition public function Performs extra processing on plugin definitions. Overrides DefaultPluginManager::processDefinition
MigrateFieldPluginManager::sortDefinitions protected function Sorts a definitions array.
MigratePluginManager::createInstance public function Creates a pre-configured instance of a migration plugin. Overrides PluginManagerBase::createInstance 1
MigratePluginManager::__construct public function Constructs a MigratePluginManager object. Overrides DefaultPluginManager::__construct 2
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. 5
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.
RSS feed
Powered by Drupal