class PerComponentEntityDisplay in Drupal 9
Same name and namespace in other branches
- 8 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
- 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\PerComponentEntityDisplay
- class \Drupal\migrate\Plugin\migrate\destination\ComponentEntityDisplayBase implements ContainerFactoryPluginInterface
- class \Drupal\migrate\Plugin\migrate\destination\DestinationBase implements MigrateDestinationInterface, RequirementsInterface
- class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
Expanded class hierarchy of PerComponentEntityDisplay
File
- core/
modules/ migrate/ src/ Plugin/ migrate/ destination/ PerComponentEntityDisplay.php, line 51
Namespace
Drupal\migrate\Plugin\migrate\destinationView 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
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
ComponentEntityDisplayBase:: |
protected | property | The entity display repository. | |
ComponentEntityDisplayBase:: |
public static | function |
Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface:: |
|
ComponentEntityDisplayBase:: |
public | function |
Returns an array of destination fields. Overrides MigrateDestinationInterface:: |
|
ComponentEntityDisplayBase:: |
public | function |
Gets the destination IDs. Overrides MigrateDestinationInterface:: |
|
ComponentEntityDisplayBase:: |
public | function |
Import the row. Overrides MigrateDestinationInterface:: |
|
ComponentEntityDisplayBase:: |
public | function |
PerComponentEntityDisplay constructor. Overrides DestinationBase:: |
2 |
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
protected | property | ||
DependencySerializationTrait:: |
public | function | 2 | |
DependencySerializationTrait:: |
public | function | 2 | |
DestinationBase:: |
protected | property | The migration. | |
DestinationBase:: |
protected | property | The rollback action to be saved for the last imported item. | |
DestinationBase:: |
protected | property | Indicates whether the destination can be rolled back. | |
DestinationBase:: |
public | function |
Checks if requirements for this plugin are OK. Overrides RequirementsInterface:: |
|
DestinationBase:: |
public | function |
Gets the destination module handling the destination data. Overrides MigrateDestinationInterface:: |
1 |
DestinationBase:: |
public | function |
Delete the specified destination object from the target Drupal. Overrides MigrateDestinationInterface:: |
2 |
DestinationBase:: |
public | function |
The rollback action for the last imported item. Overrides MigrateDestinationInterface:: |
|
DestinationBase:: |
protected | function | For a destination item being updated, set the appropriate rollback action. | |
DestinationBase:: |
public | function |
Whether the destination can be rolled back or not. Overrides MigrateDestinationInterface:: |
|
MessengerTrait:: |
protected | property | The messenger. | 27 |
MessengerTrait:: |
public | function | Gets the messenger. | 27 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PerComponentEntityDisplay:: |
protected | function |
Gets the entity. Overrides ComponentEntityDisplayBase:: |
|
PerComponentEntityDisplay:: |
constant |
Overrides ComponentEntityDisplayBase:: |
||
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | 1 |
PluginBase:: |
protected | property | The plugin_id. | |
PluginBase:: |
constant | A string which is used to separate base plugin IDs from the derivative ID. | ||
PluginBase:: |
public | function |
Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface:: |
|
PluginBase:: |
public | function |
Gets the definition of the plugin implementation. Overrides PluginInspectionInterface:: |
2 |
PluginBase:: |
public | function |
Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface:: |
|
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 4 |
StringTranslationTrait:: |
protected | function | Formats a string containing a count of items. | |
StringTranslationTrait:: |
protected | function | Returns the number of plurals supported by a given language. | |
StringTranslationTrait:: |
protected | function | Gets the string translation service. | |
StringTranslationTrait:: |
public | function | Sets the string translation service to use. | 2 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |