class PerComponentEntityFormDisplay
Same name in other branches
- 9 core/modules/migrate/src/Plugin/migrate/destination/PerComponentEntityFormDisplay.php \Drupal\migrate\Plugin\migrate\destination\PerComponentEntityFormDisplay
- 8.9.x core/modules/migrate/src/Plugin/migrate/destination/PerComponentEntityFormDisplay.php \Drupal\migrate\Plugin\migrate\destination\PerComponentEntityFormDisplay
- 11.x 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.
Hierarchy
- class \Drupal\migrate\Plugin\migrate\destination\PerComponentEntityFormDisplay extends \Drupal\migrate\Plugin\migrate\destination\ComponentEntityDisplayBase
Expanded class hierarchy of PerComponentEntityFormDisplay
1 file declares its use of PerComponentEntityFormDisplay
- PerComponentEntityFormDisplayTest.php in core/
modules/ migrate/ tests/ src/ Unit/ destination/ PerComponentEntityFormDisplayTest.php
File
-
core/
modules/ migrate/ src/ Plugin/ migrate/ destination/ PerComponentEntityFormDisplay.php, line 42
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
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.