You are here

class FieldBundle in Drupal 10

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

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'.

  • Plugin annotation


@MigrateProcessPlugin(
  id = "field_bundle"
)

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 58

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') {
      $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

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
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. Overrides PluginBase::__construct
MessengerTrait::$messenger protected property The messenger. 16
MessengerTrait::messenger public function Gets the messenger. 16
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition.
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function
PluginBase::getDerivativeId public function
PluginBase::getPluginDefinition public function 1
PluginBase::getPluginId public function
PluginBase::isConfigurable public function Determines if the plugin is configurable.
ProcessPluginBase::multiple public function Indicates whether the returned value requires multiple handling. Overrides MigrateProcessInterface::multiple 3
StringTranslationTrait::$stringTranslation protected property The string translation service. 3
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 1
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.