You are here

class PerComponentEntityDisplay in Drupal 8

Same name and namespace in other branches
  1. 9 core/modules/migrate/src/Plugin/migrate/destination/PerComponentEntityDisplay.php \Drupal\migrate\Plugin\migrate\destination\PerComponentEntityDisplay

This class imports one component of an entity display.

Destination properties expected in the imported row:

  • entity_type: The entity type ID.
  • bundle: The entity bundle.
  • view_mode: The machine name of the view 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 view mode.

Examples:


source:
  constants:
    entity_type: user
    bundle: user
    view_mode: default
    field_name: user_picture
    type: image
    options:
      label: hidden
      settings:
        image_style: ''
        image_link: content
process:
  entity_type: 'constants/entity_type'
  bundle: 'constants/bundle'
  view_mode: 'constants/view_mode'
  field_name: 'constants/field_name'
  type: 'constants/type'
  options: 'constants/options'
  'options/type': '@type'
destination:
  plugin: component_entity_display

This will add the "user_picture" image field to the "default" view mode of the "user" bundle of the "user" entity type with options as defined by the "options" constant, for example the label will be hidden.

Plugin annotation


@MigrateDestination(
  id = "component_entity_display"
)

Hierarchy

Expanded class hierarchy of PerComponentEntityDisplay

File

core/modules/migrate/src/Plugin/migrate/destination/PerComponentEntityDisplay.php, line 51

Namespace

Drupal\migrate\Plugin\migrate\destination
View source
class PerComponentEntityDisplay extends ComponentEntityDisplayBase {
  const MODE_NAME = 'view_mode';

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

}

Members

Namesort descending 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 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
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. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
PerComponentEntityDisplay::getEntity protected function Gets the entity. Overrides ComponentEntityDisplayBase::getEntity
PerComponentEntityDisplay::MODE_NAME constant Overrides ComponentEntityDisplayBase::MODE_NAME
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.
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.