class FieldBundle

Same name and namespace in other branches
  1. 9 core/modules/field/src/Plugin/migrate/process/d7/FieldBundle.php \Drupal\field\Plugin\migrate\process\d7\FieldBundle
  2. 10 core/modules/field/src/Plugin/migrate/process/d7/FieldBundle.php \Drupal\field\Plugin\migrate\process\d7\FieldBundle

Determines the bundle for a field.

The field bundle process plugin is used to get the destination bundle name for a field. This is necessary because the bundle names used for comments in legacy versions of Drupal are no longer used.

Available configuration keys:

  • source: The input value - must be an array.

Examples:


process:
  bundle:
    plugin: field_bundle
    source
      - entity_type
      - bundle

If 'bundle' is 'article' and 'entity_type' is node then 'article' is returned.


process:
  bundle:
    plugin: field_bundle
    source
      - entity_type
      - bundle

If 'bundle' is 'comment_node_a_thirty_two_character_name' and 'entity_type' is blog then a lookup is performed on the comment type migration so that the migrated bundle name for 'comment_node_a_thirty_two_character_name' is returned. That name will be truncated to 'comment_node_a_thirty_two_char'.

Hierarchy

Expanded class hierarchy of FieldBundle

See also

core/modules/comment/migrations/d7_comment_type.yml

core/modules/field/migrations/d7_field_instance.yml

File

core/modules/field/src/Plugin/migrate/process/d7/FieldBundle.php, line 55

Namespace

Drupal\field\Plugin\migrate\process\d7
View source 
class FieldBundle extends ProcessPluginBase implements ContainerFactoryPluginInterface {
    
    /**
     * The migrate lookup service.
     *
     * @var \Drupal\migrate\MigrateLookupInterface
     */
    protected $migrateLookup;
    
    /**
     * Constructs a ProcessField plugin.
     *
     * @param array $configuration
     *   The plugin configuration.
     * @param string $plugin_id
     *   The plugin ID.
     * @param mixed $plugin_definition
     *   The plugin definition.
     * @param \Drupal\migrate\MigrateLookupInterface $migrate_lookup
     *   The migrate lookup service.
     */
    public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrateLookupInterface $migrate_lookup) {
        parent::__construct($configuration, $plugin_id, $plugin_definition);
        $this->migrateLookup = $migrate_lookup;
    }
    
    /**
     * {@inheritdoc}
     */
    public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, ?MigrationInterface $migration = NULL) {
        return new static($configuration, $plugin_id, $plugin_definition, $container->get('migrate.lookup'));
    }
    
    /**
     * {@inheritdoc}
     */
    public function transform($value, MigrateExecutableInterface $migrate_executable, Row $row, $destination_property) {
        [
            $entity_type,
            $bundle,
        ] = $value;
        $lookup_result = NULL;
        // For comment entity types get the destination bundle from the
        // d7_comment_type migration, if it exists.
        if ($entity_type === 'comment' && $bundle != 'comment_forum') {
            $lookup_result = $row->get('@_comment_type');
            // Legacy generated migrations will not have the destination property
            // '_comment_type'.
            if (!$row->hasDestinationProperty('_comment_type')) {
                $value = str_replace('comment_node_', '', $bundle);
                $migration = 'd7_comment_type';
                $lookup_result = $this->migrateLookup
                    ->lookup($migration, [
                    $value,
                ]);
                $lookup_result = empty($lookup_result) ? NULL : reset($lookup_result[0]);
            }
        }
        return $lookup_result ? $lookup_result : $bundle;
    }

}

Members

Title Modifiers Object type Summary Overriden Title Overrides
FieldBundle::$migrateLookup protected property The migrate lookup service.
FieldBundle::create public static function Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
FieldBundle::transform public function Performs the associated process. Overrides ProcessPluginBase::transform
FieldBundle::__construct public function Constructs a ProcessField plugin.
PluginInspectionInterface::getPluginDefinition public function Gets the definition of the plugin implementation. 6
PluginInspectionInterface::getPluginId public function Gets the plugin_id of the plugin instance. 2
ProcessPluginBase::$stopPipeline protected property Determines if processing of the pipeline is stopped.
ProcessPluginBase::isPipelineStopped public function Determines if the pipeline should stop processing. Overrides MigrateProcessInterface::isPipelineStopped
ProcessPluginBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple 3
ProcessPluginBase::reset public function Resets the internal data of a plugin. Overrides MigrateProcessInterface::reset
ProcessPluginBase::stopPipeline protected function Stops pipeline processing after this plugin finishes.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.