class PerComponentEntityFormDisplay in Drupal 9

This class imports one component of an entity form display.

Destination properties expected in the imported row:

• entity_type: The entity type ID.
• bundle: The entity bundle.
• form_mode: The machine name of the form mode.
• field_name: The machine name of the field to be imported into the display.
• options: (optional) An array of options for displaying the field in this form mode.

Examples:

source:
  constants:
    entity_type: node
    field_name: comment
    form_mode: default
    options:
      type: comment_default
      weight: 20
process:
  entity_type: 'constants/entity_type'
  field_name: 'constants/field_name'
  form_mode: 'constants/form_mode'
  options: 'constants/options'
  bundle: node_type
destination:
  plugin: component_entity_form_display

This will add a "comment" field on the "default" form mode of the "node" entity type with options defined by the "options" constant.

Plugin annotation

@MigrateDestination(
  id = "component_entity_form_display"
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\migrate\Plugin\migrate\destination\DestinationBase implements MigrateDestinationInterface, RequirementsInterface
      • class \Drupal\migrate\Plugin\migrate\destination\ComponentEntityDisplayBase implements ContainerFactoryPluginInterface
        • class \Drupal\migrate\Plugin\migrate\destination\PerComponentEntityFormDisplay

1 file declares its use of PerComponentEntityFormDisplay

PerComponentEntityFormDisplayTest.php in core/modules/migrate/tests/src/Unit/destination/PerComponentEntityFormDisplayTest.php

Contains \Drupal\Tests\migrate\Unit\destination\PerComponentEntityFormDisplayTest.

File

core/modules/migrate/src/Plugin/migrate/destination/PerComponentEntityFormDisplay.php, line 44

Namespace

Drupal\migrate\Plugin\migrate\destination

class PerComponentEntityFormDisplay extends ComponentEntityDisplayBase {
  const MODE_NAME = 'form_mode';

  /**
   * {@inheritdoc}
   */
  protected function getEntity($entity_type, $bundle, $form_mode) {
    return $this->entityDisplayRepository
      ->getFormDisplay($entity_type, $bundle, $form_mode);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
ComponentEntityDisplayBase::$entityDisplayRepository	protected	property	The entity display repository.
ComponentEntityDisplayBase::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
ComponentEntityDisplayBase::fields	public	function	Returns an array of destination fields. Overrides MigrateDestinationInterface::fields
ComponentEntityDisplayBase::getIds	public	function	Gets the destination IDs. Overrides MigrateDestinationInterface::getIds
ComponentEntityDisplayBase::import	public	function	Import the row. Overrides MigrateDestinationInterface::import
ComponentEntityDisplayBase::__construct	public	function	PerComponentEntityDisplay constructor. Overrides DestinationBase::__construct	2
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function		2
DependencySerializationTrait::__wakeup	public	function		2
DestinationBase::$migration	protected	property	The migration.
DestinationBase::$rollbackAction	protected	property	The rollback action to be saved for the last imported item.
DestinationBase::$supportsRollback	protected	property	Indicates whether the destination can be rolled back.
DestinationBase::checkRequirements	public	function	Checks if requirements for this plugin are OK. Overrides RequirementsInterface::checkRequirements
DestinationBase::getDestinationModule	public	function	Gets the destination module handling the destination data. Overrides MigrateDestinationInterface::getDestinationModule	1
DestinationBase::rollback	public	function	Delete the specified destination object from the target Drupal. Overrides MigrateDestinationInterface::rollback	2
DestinationBase::rollbackAction	public	function	The rollback action for the last imported item. Overrides MigrateDestinationInterface::rollbackAction
DestinationBase::setRollbackAction	protected	function	For a destination item being updated, set the appropriate rollback action.
DestinationBase::supportsRollback	public	function	Whether the destination can be rolled back or not. Overrides MigrateDestinationInterface::supportsRollback
MessengerTrait::$messenger	protected	property	The messenger.	27
MessengerTrait::messenger	public	function	Gets the messenger.	27
MessengerTrait::setMessenger	public	function	Sets the messenger.
PerComponentEntityFormDisplay::getEntity	protected	function	Gets the entity. Overrides ComponentEntityDisplayBase::getEntity	1
PerComponentEntityFormDisplay::MODE_NAME		constant	Overrides ComponentEntityDisplayBase::MODE_NAME	1
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	2
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.
StringTranslationTrait::$stringTranslation	protected	property	The string translation service.	4
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.