class ReferenceBase
Same name in other branches
- 10 core/modules/migrate_drupal/src/Plugin/migrate/field/ReferenceBase.php \Drupal\migrate_drupal\Plugin\migrate\field\ReferenceBase
- 11.x core/modules/migrate_drupal/src/Plugin/migrate/field/ReferenceBase.php \Drupal\migrate_drupal\Plugin\migrate\field\ReferenceBase
Base class for Drupal reference fields.
Hierarchy
- class \Drupal\Component\Plugin\PluginBase implements \Drupal\Component\Plugin\PluginInspectionInterface, \Drupal\Component\Plugin\DerivativeInspectionInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
- class \Drupal\migrate_drupal\Plugin\migrate\field\FieldPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\migrate_drupal\Plugin\MigrateFieldInterface
- class \Drupal\migrate_drupal\Plugin\migrate\field\ReferenceBase extends \Drupal\migrate_drupal\Plugin\migrate\field\FieldPluginBase
- class \Drupal\migrate_drupal\Plugin\migrate\field\FieldPluginBase extends \Drupal\Core\Plugin\PluginBase implements \Drupal\migrate_drupal\Plugin\MigrateFieldInterface
- class \Drupal\Core\Plugin\PluginBase extends \Drupal\Component\Plugin\PluginBase uses \Drupal\Core\StringTranslation\StringTranslationTrait, \Drupal\Core\DependencyInjection\DependencySerializationTrait, \Drupal\Core\Messenger\MessengerTrait
Expanded class hierarchy of ReferenceBase
4 files declare their use of ReferenceBase
- NodeReference.php in core/
modules/ migrate_drupal/ src/ Plugin/ migrate/ field/ d6/ NodeReference.php - NodeReference.php in core/
modules/ migrate_drupal/ src/ Plugin/ migrate/ field/ d7/ NodeReference.php - UserReference.php in core/
modules/ migrate_drupal/ src/ Plugin/ migrate/ field/ d6/ UserReference.php - UserReference.php in core/
modules/ migrate_drupal/ src/ Plugin/ migrate/ field/ d7/ UserReference.php
File
-
core/
modules/ migrate_drupal/ src/ Plugin/ migrate/ field/ ReferenceBase.php, line 10
Namespace
Drupal\migrate_drupal\Plugin\migrate\fieldView source
abstract class ReferenceBase extends FieldPluginBase {
/**
* Gets the plugin ID for the reference type migration.
*
* The reference type migration will be added as a required dependency.
*
* @return string
* The plugin id.
*/
protected abstract function getEntityTypeMigrationId();
/**
* Gets the name of the field property which holds the entity ID.
*
* @return string
* The entity id.
*/
protected abstract function entityId();
/**
* {@inheritdoc}
*/
public function alterFieldInstanceMigration(MigrationInterface $migration) {
parent::alterFieldInstanceMigration($migration);
// Add the reference migration as a required dependency to this migration.
$migration_dependencies = $migration->getMigrationDependencies();
array_push($migration_dependencies['required'], $this->getEntityTypeMigrationId());
$migration_dependencies['required'] = array_unique($migration_dependencies['required']);
$migration->set('migration_dependencies', $migration_dependencies);
}
/**
* {@inheritdoc}
*/
public function defineValueProcessPipeline(MigrationInterface $migration, $field_name, $data) {
$process = [
'plugin' => 'sub_process',
'source' => $field_name,
'process' => [
'target_id' => $this->entityId(),
],
];
$migration->setProcessOfProperty($field_name, $process);
}
/**
* {@inheritdoc}
*/
public function getFieldWidgetMap() {
return [
$this->pluginId . '_select' => 'options_select',
$this->pluginId . '_buttons' => 'options_buttons',
$this->pluginId . '_autocomplete' => 'entity_reference_autocomplete_tags',
];
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title | Overrides |
---|---|---|---|---|---|
FieldPluginBase::alterFieldFormatterMigration | public | function | Apply any custom processing to the field formatter migration. | Overrides MigrateFieldInterface::alterFieldFormatterMigration | |
FieldPluginBase::alterFieldMigration | public | function | Apply any custom processing to the field migration. | Overrides MigrateFieldInterface::alterFieldMigration | |
FieldPluginBase::alterFieldWidgetMigration | public | function | Apply any custom processing to the field widget migration. | Overrides MigrateFieldInterface::alterFieldWidgetMigration | |
FieldPluginBase::getFieldFormatterMap | public | function | Get a map between D6 formatters and D8 formatters for this field type. | Overrides MigrateFieldInterface::getFieldFormatterMap | 11 |
FieldPluginBase::getFieldFormatterType | public | function | Get the field formatter type from the source. | Overrides MigrateFieldInterface::getFieldFormatterType | 1 |
FieldPluginBase::getFieldType | public | function | Computes the destination type of a migrated field. | Overrides MigrateFieldInterface::getFieldType | 4 |
FieldPluginBase::getFieldWidgetType | public | function | Get the field widget type from the source. | Overrides MigrateFieldInterface::getFieldWidgetType | 1 |
PluginInspectionInterface::getPluginDefinition | public | function | Gets the definition of the plugin implementation. | 6 | |
PluginInspectionInterface::getPluginId | public | function | Gets the plugin_id of the plugin instance. | 2 | |
ReferenceBase::alterFieldInstanceMigration | public | function | Apply any custom processing to the field instance migration. | Overrides FieldPluginBase::alterFieldInstanceMigration | |
ReferenceBase::defineValueProcessPipeline | public | function | Apply any custom processing to the field bundle migrations. | Overrides FieldPluginBase::defineValueProcessPipeline | 2 |
ReferenceBase::entityId | abstract protected | function | Gets the name of the field property which holds the entity ID. | 4 | |
ReferenceBase::getEntityTypeMigrationId | abstract protected | function | Gets the plugin ID for the reference type migration. | 4 | |
ReferenceBase::getFieldWidgetMap | public | function | Get a map between D6 and D8 widgets for this field type. | Overrides FieldPluginBase::getFieldWidgetMap |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.