class Paragraphs in Paragraphs 8

Same name in this branch

8 src/Feeds/Target/Paragraphs.php \Drupal\paragraphs\Feeds\Target\Paragraphs
8 src/Plugin/migrate/field/Paragraphs.php \Drupal\paragraphs\Plugin\migrate\field\Paragraphs

Field Plugin for paragraphs migrations.

Plugin annotation


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

Hierarchy

class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
  - class \Drupal\migrate_drupal\Plugin\migrate\field\FieldPluginBase implements MigrateFieldInterface
    class \Drupal\paragraphs\Plugin\migrate\field\Paragraphs

Expanded class hierarchy of Paragraphs

28 string references to 'Paragraphs'

core.entity_form_display.node.paragraphed_content_demo.default.yml in modules/paragraphs_demo/config/install/core.entity_form_display.node.paragraphed_content_demo.default.yml: modules/paragraphs_demo/config/install/core.entity_form_display.node.paragraphed_content_demo.default.yml
core.entity_form_display.paragraph.nested_paragraph.default.yml in modules/paragraphs_demo/config/install/core.entity_form_display.paragraph.nested_paragraph.default.yml: modules/paragraphs_demo/config/install/core.entity_form_display.paragraph.nested_paragraph.default.yml
d7_paragraphs.yml in migrations/d7_paragraphs.yml: migrations/d7_paragraphs.yml
field.field.node.paragraphed_content_demo.field_paragraphs_demo.yml in modules/paragraphs_demo/config/install/field.field.node.paragraphed_content_demo.field_paragraphs_demo.yml: modules/paragraphs_demo/config/install/field.field.node.paragraphed_content_demo.field_paragraphs_demo.yml
InlineParagraphsWidget::defaultSettings in src/Plugin/Field/FieldWidget/InlineParagraphsWidget.php: Defines the default settings for this plugin.

... See full list

File

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

Namespace

Drupal\paragraphs\Plugin\migrate\field

View source

class Paragraphs extends FieldPluginBase {

  /**
   * {@inheritdoc}
   */
  public function defineValueProcessPipeline(MigrationInterface $migration, $field_name, $data) {
    $process = [
      'plugin' => 'sub_process',
      'source' => $field_name,
      'process' => [
        'target_id' => [
          [
            'plugin' => 'paragraphs_lookup',
            'tags' => 'Paragraphs Content',
            'source' => 'value',
          ],
          [
            'plugin' => 'extract',
            'index' => [
              'id',
            ],
          ],
        ],
        'target_revision_id' => [
          [
            'plugin' => 'paragraphs_lookup',
            'tags' => [
              'Paragraphs Revisions Content',
              'Paragraphs Content',
            ],
            'tag_ids' => [
              'Paragraphs Revisions Content' => [
                'revision_id',
              ],
              'Paragraphs Content' => [
                'value',
              ],
            ],
            // D8.4 Does not like an empty source value, Even when using ids.
            'source' => 'value',
          ],
          [
            'plugin' => 'extract',
            'index' => [
              'revision_id',
            ],
          ],
        ],
      ],
    ];
    $migration
      ->setProcessOfProperty($field_name, $process);

    // Add paragraphs migration as a dependency (if this is not a paragraph
    // migration).
    // @todo: This is a great example why we should consider derive paragraph
    // migrations based on parent entity type (and bundle).
    if (!in_array('Paragraphs Content', $migration
      ->getMigrationTags(), TRUE)) {
      $dependencies = $migration
        ->getMigrationDependencies() + [
        'required' => [],
      ];
      $dependencies['required'] = array_unique(array_merge(array_values($dependencies['required']), [
        'd7_paragraphs',
      ]));
      $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']), [
          'd7_paragraphs_revisions',
        ]));
        $migration
          ->set('migration_dependencies', $dependencies);
      }
    }
  }

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

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

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

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

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

  /**
   * {@inheritdoc}
   */
  public function alterFieldInstanceMigration(MigrationInterface $migration) {
    $settings = [
      'paragraphs' => [
        'plugin' => 'paragraphs_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 = [
      'paragraphs' => [
        'plugin' => 'paragraphs_process_on_value',
        'source_value' => 'type',
        'expected_value' => 'paragraphs',
        'process' => [
          'plugin' => 'get',
          'source' => 'formatter/settings/view_mode',
        ],
      ],
    ];
    $migration
      ->mergeProcessOfProperty('options/settings/view_mode', $view_mode);
  }

  /**
   * Adds processes for paragraphs field widgets.
   *
   * @param \Drupal\migrate\Plugin\MigrationInterface $migration
   *   The migration.
   */
  protected function paragraphAlterFieldWidgetMigration(MigrationInterface $migration) {
    $title = [
      'paragraphs' => [
        'plugin' => 'paragraphs_process_on_value',
        'source_value' => 'type',
        'expected_value' => 'paragraphs',
        'process' => [
          'plugin' => 'get',
          'source' => 'settings/title',
        ],
      ],
    ];
    $title_plural = [
      'paragraphs' => [
        'plugin' => 'paragraphs_process_on_value',
        'source_value' => 'type',
        'expected_value' => 'paragraphs',
        'process' => [
          'plugin' => 'get',
          'source' => 'settings/title_multiple',
        ],
      ],
    ];
    $edit_mode = [
      'paragraphs' => [
        'plugin' => 'paragraphs_process_on_value',
        'source_value' => 'type',
        'expected_value' => 'paragraphs',
        'process' => [
          'plugin' => 'get',
          'source' => 'settings/default_edit_mode',
        ],
      ],
    ];
    $add_mode = [
      'paragraphs' => [
        'plugin' => 'paragraphs_process_on_value',
        'source_value' => 'type',
        'expected_value' => 'paragraphs',
        'process' => [
          'plugin' => 'get',
          'source' => 'settings/add_mode',
        ],
      ],
    ];
    $migration
      ->mergeProcessOfProperty('options/settings/title', $title);
    $migration
      ->mergeProcessOfProperty('options/settings/title_plural', $title_plural);
    $migration
      ->mergeProcessOfProperty('options/settings/edit_mode', $edit_mode);
    $migration
      ->mergeProcessOfProperty('options/settings/add_mode', $add_mode);
  }

}

Members

Name	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
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.
Paragraphs::addViewModeProcess	protected	function	Adds process for view mode settings.
Paragraphs::alterFieldFormatterMigration	public	function	Apply any custom processing to the field formatter migration. Overrides FieldPluginBase::alterFieldFormatterMigration
Paragraphs::alterFieldInstanceMigration	public	function	Apply any custom processing to the field instance migration. Overrides FieldPluginBase::alterFieldInstanceMigration
Paragraphs::alterFieldMigration	public	function	Apply any custom processing to the field migration. Overrides FieldPluginBase::alterFieldMigration
Paragraphs::alterFieldWidgetMigration	public	function	Apply any custom processing to the field widget migration. Overrides FieldPluginBase::alterFieldWidgetMigration
Paragraphs::defineValueProcessPipeline	public	function	Apply any custom processing to the field bundle migrations. Overrides FieldPluginBase::defineValueProcessPipeline
Paragraphs::getFieldFormatterMap	public	function	Get a map between D6 formatters and D8 formatters for this field type. Overrides FieldPluginBase::getFieldFormatterMap
Paragraphs::getFieldWidgetMap	public	function	Get a map between D6 and D8 widgets for this field type. Overrides FieldPluginBase::getFieldWidgetMap
Paragraphs::paragraphAlterFieldWidgetMigration	protected	function	Adds processes for paragraphs field widgets.
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.

You are here

class Paragraphs in Paragraphs 8

Plugin annotation

Hierarchy

File

Namespace

Members

API Navigation