You are here

Home » API reference » Paragraphs 8 » FieldCollection.php

class FieldCollection in Paragraphs 8

Field Plugin for field collection migrations.

Plugin annotation


@MigrateField(
  id = "field_collection",
  core = {7},
  type_map = {
    "field_collection" = "entity_reference_revisions",
  },
  source_module = "field_collection",
  destination_module = "paragraphs",
)

Hierarchy

Expanded class hierarchy of FieldCollection

4 files declare their use of FieldCollection
FieldCollectionFieldInstanceSettings.php in src/Plugin/migrate/process/FieldCollectionFieldInstanceSettings.php
FieldCollectionItem.php in src/Plugin/migrate/source/d7/FieldCollectionItem.php
FieldCollectionType.php in src/Plugin/migrate/source/d7/FieldCollectionType.php
MigrationPluginsAlterer.php in src/MigrationPluginsAlterer.php

File

src/Plugin/migrate/field/FieldCollection.php, line 21

Namespace

Drupal\paragraphs\Plugin\migrate\field
View source 
class FieldCollection extends FieldPluginBase {

  /*
   * Length of the 'field_' prefix that field collection prepends to bundles.
   */
  const FIELD_COLLECTION_PREFIX_LENGTH = 6;

  /**
   * {@inheritdoc}
   */
  public function defineValueProcessPipeline(MigrationInterface $migration, $field_name, $data) {
    $process = [
      'plugin' => 'sub_process',
      'source' => $field_name,
      'process' => [
        'target_id' => [
          [
            'plugin' => 'paragraphs_lookup',
            'tags' => 'Field Collection Content',
            'source' => 'value',
          ],
          [
            'plugin' => 'extract',
            'index' => [
              'id',
            ],
          ],
        ],
        'target_revision_id' => [
          [
            'plugin' => 'paragraphs_lookup',
            'tags' => [
              'Field Collection Revisions Content',
              'Field Collection Content',
            ],
            'tag_ids' => [
              'Field Collection Revisions Content' => [
                'revision_id',
              ],
              'Field Collection Content' => [
                'value',
              ],
            ],
          ],
          [
            'plugin' => 'extract',
            'index' => [
              'revision_id',
            ],
          ],
        ],
      ],
    ];
    $migration
      ->setProcessOfProperty($field_name, $process);

    // Add the respective field collection migration as a dependency.
    $migration_dependency = 'd7_field_collection:' . substr($field_name, static::FIELD_COLLECTION_PREFIX_LENGTH);
    $migration_rev_dependency = 'd7_field_collection_revisions:' . substr($field_name, static::FIELD_COLLECTION_PREFIX_LENGTH);
    $dependencies = $migration
      ->getMigrationDependencies() + [
      'required' => [],
    ];
    $dependencies['required'] = array_unique(array_merge(array_values($dependencies['required']), [
      $migration_dependency,
    ]));
    $migration
      ->set('migration_dependencies', $dependencies);
    if (strpos($migration
      ->getDestinationPlugin()
      ->getPluginId(), 'entity_revision:') === 0 || strpos($migration
      ->getDestinationPlugin()
      ->getPluginId(), 'entity_complete:') === 0) {
      $dependencies['required'] = array_unique(array_merge(array_values($dependencies['required']), [
        $migration_rev_dependency,
      ]));
      $migration
        ->set('migration_dependencies', $dependencies);
    }
  }

  /**
   * {@inheritdoc}
   */
  public function alterFieldFormatterMigration(MigrationInterface $migration) {
    $this
      ->addViewModeProcess($migration);
    parent::alterFieldFormatterMigration($migration);
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldFormatterMap() {
    return [
      'field_collection_view' => 'entity_reference_revisions_entity_view',
    ] + parent::getFieldFormatterMap();
  }

  /**
   * {@inheritdoc}
   */
  public function getFieldWidgetMap() {
    return [
      'field_collection_embed' => 'entity_reference_paragraphs',
    ] + parent::getFieldWidgetMap();
  }

  /**
   * {@inheritdoc}
   */
  public function alterFieldMigration(MigrationInterface $migration) {
    $settings = [
      'field_collection' => [
        'plugin' => 'field_collection_field_settings',
      ],
    ];
    $migration
      ->mergeProcessOfProperty('settings', $settings);
  }

  /**
   * {@inheritdoc}
   */
  public function alterFieldInstanceMigration(MigrationInterface $migration) {
    $settings = [
      'field_collection' => [
        'plugin' => 'field_collection_field_instance_settings',
      ],
    ];
    $migration
      ->mergeProcessOfProperty('settings', $settings);
  }

  /**
   * Adds process for view mode settings.
   *
   * @param \Drupal\migrate\Plugin\MigrationInterface $migration
   *   The migration.
   */
  protected function addViewModeProcess(MigrationInterface $migration) {
    $view_mode = [
      'field_collection' => [
        'plugin' => 'paragraphs_process_on_value',
        'source_value' => 'type',
        'expected_value' => 'field_collection',
        'process' => [
          'plugin' => 'get',
          'source' => 'formatter/settings/view_mode',
        ],
      ],
    ];
    $migration
      ->mergeProcessOfProperty('options/settings/view_mode', $view_mode);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
FieldCollection::addViewModeProcess protected function Adds process for view mode settings.
FieldCollection::alterFieldFormatterMigration public function Apply any custom processing to the field formatter migration. Overrides FieldPluginBase::alterFieldFormatterMigration
FieldCollection::alterFieldInstanceMigration public function Apply any custom processing to the field instance migration. Overrides FieldPluginBase::alterFieldInstanceMigration
FieldCollection::alterFieldMigration public function Apply any custom processing to the field migration. Overrides FieldPluginBase::alterFieldMigration
FieldCollection::defineValueProcessPipeline public function Apply any custom processing to the field bundle migrations. Overrides FieldPluginBase::defineValueProcessPipeline
FieldCollection::FIELD_COLLECTION_PREFIX_LENGTH constant
FieldCollection::getFieldFormatterMap public function Get a map between D6 formatters and D8 formatters for this field type. Overrides FieldPluginBase::getFieldFormatterMap
FieldCollection::getFieldWidgetMap public function Get a map between D6 and D8 widgets for this field type. Overrides FieldPluginBase::getFieldWidgetMap
FieldPluginBase::alterFieldWidgetMigration public function Apply any custom processing to the field widget migration. Overrides MigrateFieldInterface::alterFieldWidgetMigration
FieldPluginBase::getFieldFormatterType public function Get the field formatter type from the source. Overrides MigrateFieldInterface::getFieldFormatterType 1
FieldPluginBase::getFieldType public function Computes the destination type of a migrated field. Overrides MigrateFieldInterface::getFieldType 6
FieldPluginBase::getFieldWidgetType public function Get the field widget type from the source. Overrides MigrateFieldInterface::getFieldWidgetType 1
FieldPluginBase::processField Deprecated public function Alters the migration for field definitions.
FieldPluginBase::processFieldFormatter Deprecated public function Alter field formatter migration.
FieldPluginBase::processFieldInstance Deprecated public function Alert field instance migration.
FieldPluginBase::processFieldValues Deprecated public function Defines the process pipeline for field values.
FieldPluginBase::processFieldWidget Deprecated public function Alter field widget migration.
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
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. 1
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 Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
PluginBase::__construct public function Constructs a \Drupal\Component\Plugin\PluginBase object. 92
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
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. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.