class PerComponentEntityFormDisplay in Drupal 10
Same name and namespace in other branches
- 8 core/modules/migrate/src/Plugin/migrate/destination/PerComponentEntityFormDisplay.php \Drupal\migrate\Plugin\migrate\destination\PerComponentEntityFormDisplay
- 9 core/modules/migrate/src/Plugin/migrate/destination/PerComponentEntityFormDisplay.php \Drupal\migrate\Plugin\migrate\destination\PerComponentEntityFormDisplay
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
- 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 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\destinationView source
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:: |
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. | 16 |
MessengerTrait:: |
public | function | Gets the messenger. | 16 |
MessengerTrait:: |
public | function | Sets the messenger. | |
PerComponentEntityFormDisplay:: |
protected | function |
Gets the entity. Overrides ComponentEntityDisplayBase:: |
1 |
PerComponentEntityFormDisplay:: |
constant |
Overrides ComponentEntityDisplayBase:: |
1 | |
PluginBase:: |
protected | property | Configuration information passed into the plugin. | 1 |
PluginBase:: |
protected | property | The plugin implementation definition. | |
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 | ||
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | 1 | |
PluginBase:: |
public | function | ||
PluginBase:: |
public | function | Determines if the plugin is configurable. | |
StringTranslationTrait:: |
protected | property | The string translation service. | 3 |
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. | 1 |
StringTranslationTrait:: |
protected | function | Translates a string to the current language or to a given language. |