class OrderItemDeriver in Commerce Migrate 8.2

Deriver for Commerce 1 line items based on line item types.

Hierarchy

• class \Drupal\Component\Plugin\Derivative\DeriverBase implements DeriverInterface
  • class \Drupal\commerce_migrate_commerce\Plugin\migrate\OrderItemDeriver implements ContainerDeriverInterface uses MigrationDeriverTrait

1 string reference to 'OrderItemDeriver'

commerce1_order_item.yml in modules/commerce/migrations/commerce1_order_item.yml

modules/commerce/migrations/commerce1_order_item.yml

File

modules/commerce/src/Plugin/migrate/OrderItemDeriver.php, line 16

Namespace

Drupal\commerce_migrate_commerce\Plugin\migrate

class OrderItemDeriver 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;

  /**
   * D7NodeDeriver 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) {

    // @todo: Convert to new trait. See https://www.drupal.org/node/2951550.
    $order_item_types = static::getSourcePlugin('commerce1_order_item_type');
    try {
      $order_item_types
        ->checkRequirements();
    } catch (RequirementsException $e) {

      // If the d7_order_item_type requirements failed, that means we do not
      // have a  Drupal source database configured - there is nothing to
      // generate.
      return parent::getDerivativeDefinitions($base_plugin_definition);
    }
    $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_line_item') {
          $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 line item properties.
    }
    try {
      foreach ($order_item_types as $row) {
        $line_item_type = $row
          ->getSourceProperty('type');

        // Ignore shipping line items because they become order adjustments.
        if ($line_item_type !== 'shipping' && $line_item_type !== 'commerce_discount') {
          $values = $base_plugin_definition;
          $values['label'] = t('@label (@type)', [
            '@label' => $values['label'],
            '@type' => $row
              ->getSourceProperty('name'),
          ]);
          $values['source']['line_item_type'] = $line_item_type;
          $values['destination']['default_bundle'] = $line_item_type;

          /** @var \Drupal\migrate\Plugin\MigrationInterface $migration */
          $migration = \Drupal::service('plugin.manager.migration')
            ->createStubMigration($values);
          $this->fieldDiscovery
            ->addBundleFieldProcesses($migration, 'commerce_line_item', $line_item_type);
          $this->derivatives[$line_item_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::$derivatives	protected	property	List of derivative definitions.	1
DeriverBase::getDerivativeDefinition	public	function	Gets the definition of a derivative plugin. Overrides DeriverInterface::getDerivativeDefinition
MigrationDeriverTrait::getSourcePlugin	public static	function	Returns a fully initialized instance of a source plugin.
OrderItemDeriver::$basePluginId	protected	property	The base plugin ID this derivative is for.
OrderItemDeriver::$fieldDiscovery	protected	property	The migration field discovery service.
OrderItemDeriver::$includeTranslations	protected	property	Whether or not to include translations.
OrderItemDeriver::create	public static	function	Creates a new class instance. Overrides ContainerDeriverInterface::create
OrderItemDeriver::getDerivativeDefinitions	public	function	Gets the definition of all derivatives of a base plugin. Overrides DeriverBase::getDerivativeDefinitions
OrderItemDeriver::__construct	public	function	D7NodeDeriver constructor.