class ProfileDeriver in Commerce Migrate 8.2
Same name and namespace in other branches
- 3.1.x modules/commerce/src/Plugin/migrate/ProfileDeriver.php \Drupal\commerce_migrate_commerce\Plugin\migrate\ProfileDeriver
- 3.0.x modules/commerce/src/Plugin/migrate/ProfileDeriver.php \Drupal\commerce_migrate_commerce\Plugin\migrate\ProfileDeriver
Deriver for Commerce 1 profiles.
Hierarchy
- class \Drupal\Component\Plugin\Derivative\DeriverBase implements DeriverInterface
- class \Drupal\commerce_migrate_commerce\Plugin\migrate\ProfileDeriver implements ContainerDeriverInterface uses MigrationDeriverTrait
Expanded class hierarchy of ProfileDeriver
2 string references to 'ProfileDeriver'
- commerce1_profile.yml in modules/
commerce/ migrations/ commerce1_profile.yml - modules/commerce/migrations/commerce1_profile.yml
- commerce1_profile_revision.yml in modules/
commerce/ migrations/ commerce1_profile_revision.yml - modules/commerce/migrations/commerce1_profile_revision.yml
File
- modules/
commerce/ src/ Plugin/ migrate/ ProfileDeriver.php, line 16
Namespace
Drupal\commerce_migrate_commerce\Plugin\migrateView source
class ProfileDeriver extends DeriverBase implements ContainerDeriverInterface {
use MigrationDeriverTrait;
/**
* The base plugin ID this derivative is for.
*
* @var string
*/
protected $basePluginId;
/**
* Whether or not to include translations.
*
* @var bool
*/
protected $includeTranslations;
/**
* The migration field discovery service.
*
* @var \Drupal\migrate_drupal\FieldDiscoveryInterface
*/
protected $fieldDiscovery;
/**
* Commerce profile deriver constructor.
*
* @param string $base_plugin_id
* The base plugin ID for the plugin ID.
* @param bool $translations
* Whether or not to include translations.
* @param \Drupal\migrate_drupal\FieldDiscoveryInterface $field_discovery
* The migration field discovery service.
*/
public function __construct($base_plugin_id, $translations, FieldDiscoveryInterface $field_discovery) {
$this->basePluginId = $base_plugin_id;
$this->includeTranslations = $translations;
$this->fieldDiscovery = $field_discovery;
}
/**
* {@inheritdoc}
*/
public static function create(ContainerInterface $container, $base_plugin_id) {
// Translations don't make sense unless we have content_translation.
return new static($base_plugin_id, $container
->get('module_handler')
->moduleExists('content_translation'), $container
->get('migrate_drupal.field_discovery'));
}
/**
* {@inheritdoc}
*/
public function getDerivativeDefinitions($base_plugin_definition) {
$profile_types = static::getSourcePlugin('commerce1_profile_type');
try {
$profile_types
->checkRequirements();
} catch (RequirementsException $e) {
// If the commerce1_profile_type requirements failed, that means we do
// not have a Drupal source database configured - there is nothing to
// generate.
return $this->derivatives;
}
$fields = [];
try {
$source_plugin = static::getSourcePlugin('d7_field_instance');
$source_plugin
->checkRequirements();
// Read all field instance definitions in the source database.
foreach ($source_plugin as $row) {
if ($row
->getSourceProperty('entity_type') == 'commerce_customer_profile') {
$fields[$row
->getSourceProperty('bundle')][$row
->getSourceProperty('field_name')] = $row
->getSource();
}
}
} catch (RequirementsException $e) {
// If checkRequirements() failed then the field module did not exist and
// we do not have any fields. Therefore, $fields will be empty and below
// we'll create a migration just for the profile properties.
}
try {
foreach ($profile_types as $row) {
$profile_type = $row
->getSourceProperty('type');
$values = $base_plugin_definition;
$values['label'] = t('@label (@type)', [
'@label' => $values['label'],
'@type' => $row
->getSourceProperty('name'),
]);
$values['source']['profile_type'] = $profile_type;
$values['destination']['default_bundle'] = $profile_type;
// If this migration is based on the commerce1_profile_revision
// migration it should explicitly depend on the corresponding
// commerce1_profile variant.
if ($base_plugin_definition['id'] == [
'commerce1_profile_revision',
]) {
$values['migration_dependencies']['required'][] = 'commerce1_profile:' . $profile_type;
}
/** @var \Drupal\migrate\Plugin\MigrationInterface $migration */
$migration = \Drupal::service('plugin.manager.migration')
->createStubMigration($values);
$this->fieldDiscovery
->addBundleFieldProcesses($migration, 'commerce_customer_profile', $profile_type);
$this->derivatives[$profile_type] = $migration
->getPluginDefinition();
}
} catch (DatabaseExceptionWrapper $e) {
// Once we begin iterating the source plugin it is possible that the
// source tables will not exist. This can happen when the
// MigrationPluginManager gathers up the migration definitions but we do
// not actually have a Drupal 7 source database.
}
return parent::getDerivativeDefinitions($base_plugin_definition);
}
}
Members
Name | Modifiers | Type | Description | Overrides |
---|---|---|---|---|
DeriverBase:: |
protected | property | List of derivative definitions. | 1 |
DeriverBase:: |
public | function |
Gets the definition of a derivative plugin. Overrides DeriverInterface:: |
|
MigrationDeriverTrait:: |
public static | function | Returns a fully initialized instance of a source plugin. | |
ProfileDeriver:: |
protected | property | The base plugin ID this derivative is for. | |
ProfileDeriver:: |
protected | property | The migration field discovery service. | |
ProfileDeriver:: |
protected | property | Whether or not to include translations. | |
ProfileDeriver:: |
public static | function |
Creates a new class instance. Overrides ContainerDeriverInterface:: |
|
ProfileDeriver:: |
public | function |
Gets the definition of all derivatives of a base plugin. Overrides DeriverBase:: |
|
ProfileDeriver:: |
public | function | Commerce profile deriver constructor. |