You are here

Home » API reference » Commerce Migrate 3.1.x » CommercePayment.php

class CommercePayment in Commerce Migrate 3.1.x

Same name and namespace in other branches
  1. 8.2 modules/ubercart/src/Plugin/migrate/destination/CommercePayment.php \Drupal\commerce_migrate_ubercart\Plugin\migrate\destination\CommercePayment
  2. 3.0.x modules/ubercart/src/Plugin/migrate/destination/CommercePayment.php \Drupal\commerce_migrate_ubercart\Plugin\migrate\destination\CommercePayment

Commerce payment destination for Ubercart.

Plugin annotation


@MigrateDestination(
  id = "entity:commerce_payment"
)

Hierarchy

Expanded class hierarchy of CommercePayment

File

modules/ubercart/src/Plugin/migrate/destination/CommercePayment.php, line 22

Namespace

Drupal\commerce_migrate_ubercart\Plugin\migrate\destination
View source 
class CommercePayment extends EntityContentBase {

  /**
   * The entity type manager, used to fetch entity link templates.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Builds a payment entity destination.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\migrate\Plugin\MigrationInterface $migration
   *   The migration.
   * @param \Drupal\Core\Entity\EntityStorageInterface $storage
   *   The storage for this entity type.
   * @param array $bundles
   *   The list of bundles this entity type has.
   * @param \Drupal\Core\Entity\EntityFieldManagerInterface $entity_field_manager
   *   The entity field manager.
   * @param \Drupal\Core\Field\FieldTypePluginManagerInterface $field_type_manager
   *   The field type plugin manager service.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager, used to fetch entity link templates.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration, EntityStorageInterface $storage, array $bundles, EntityFieldManagerInterface $entity_field_manager, FieldTypePluginManagerInterface $field_type_manager, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $migration, $storage, $bundles, $entity_field_manager, $field_type_manager);
    $this->entityTypeManager = $entity_type_manager;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition, MigrationInterface $migration = NULL) {
    $entity_type = static::getEntityTypeId($plugin_id);
    return new static($configuration, $plugin_id, $plugin_definition, $migration, $container
      ->get('entity_type.manager')
      ->getStorage($entity_type), array_keys($container
      ->get('entity_type.bundle.info')
      ->getBundleInfo($entity_type)), $container
      ->get('entity_field.manager'), $container
      ->get('plugin.manager.field.field_type'), $container
      ->get('entity_type.manager'));
  }

  /**
   * {@inheritdoc}
   */
  public function import(Row $row, array $old_destination_id_values = []) {
    $amount = $row
      ->getDestinationProperty('amount/number');
    if ($amount >= 0) {

      // Not a refund, nothing to do here.
      return parent::import($row, $old_destination_id_values);
    }
    else {
      $saved_ids = 0;

      // This is a refund and it needs to be attached to a commerce payment.
      // Search all existing payments for this order to find a suitable payment
      // or payments to add the refund to. The refund may be spread across more
      // than one payment.
      // Get all the existing payments for this order from the destination.
      $order_id = $row
        ->getSourceProperty('order_id');
      $query = $this->entityTypeManager
        ->getStorage('commerce_payment')
        ->getQuery();
      $ids = $query
        ->condition('order_id', $order_id)
        ->sort('payment_id')
        ->execute();
      $payments = $this->entityTypeManager
        ->getStorage('commerce_payment')
        ->loadMultiple($ids);
      $current_refund = strval(abs($amount));

      /** @var \Drupal\commerce_payment\Entity\Payment $payment */
      foreach ($payments as $payment) {

        // Loop through all payments adding the current refund amount, or a
        // portion thereof, to the current payment. The refund amount is not to
        // be more than the payment amount.
        $paid_amount = $payment
          ->getAmount()
          ->getNumber();
        if ($paid_amount > 0) {

          // Only add refunds to payments with a positive payment amount.
          $refund_number = $payment
            ->getRefundedAmount()
            ->getNumber();
          $total_refund_amount = Calculator::add($refund_number, $current_refund);
          $diff = Calculator::subtract($paid_amount, $total_refund_amount);
          if ($diff < 0) {

            // The paid amount does not cover any existing refund plus the
            // current refund. Set the refund amount to the paid amount of the
            // current payment.
            $new_refund_amount = $paid_amount;
            $state = 'refunded';
          }
          else {

            // The total current refund amount can be attached to this payment.

            /** @var \Drupal\commerce_price\Price $new_refund_amount */
            $new_refund_amount = strval(abs($total_refund_amount));
            $state = Calculator::subtract($paid_amount, $total_refund_amount) == 0 ? 'refunded' : 'partially_refunded';
          }

          // Set the calculated values in the destination row.
          $row
            ->setDestinationProperty('payment_id', $payment
            ->id());
          $row
            ->setDestinationProperty('amount/number', $paid_amount);
          $row
            ->setDestinationProperty('amount/currency_code', $payment
            ->getAmount()
            ->getCurrencyCode());
          $row
            ->setDestinationProperty('refunded_amount/number', $new_refund_amount);
          $row
            ->setDestinationProperty('refunded_amount/currency_code', $payment
            ->getRefundedAmount()
            ->getCurrencyCode());
          $row
            ->setDestinationProperty('state', $state);

          // Update the entity and save.
          parent::updateEntity($payment, $row);
          $payment
            ->setState($state);
          $saved_ids = $payment
            ->save();

          // Update the current refund amount.
          $current_refund = Calculator::subtract($current_refund, Calculator::subtract($new_refund_amount, $refund_number));
          if ($current_refund == 0) {
            break;
          }
        }
      }
      if ($current_refund != 0) {
        $payment_id = $row
          ->getDestinationProperty('payment_id');
        $message = 'Refund exceeds payments for payment ' . $payment_id;
        $source_ids = [
          'receipt_id' => $payment_id,
        ];
        $this->migration
          ->getIdMap()
          ->saveMessage($source_ids, $message, MigrationInterface::MESSAGE_INFORMATIONAL);
      }
      return [
        $saved_ids,
      ];
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CommercePayment::$entityTypeManager protected property The entity type manager, used to fetch entity link templates.
CommercePayment::create public static function Creates an instance of the plugin. Overrides EntityContentBase::create
CommercePayment::import public function Import the row. Overrides EntityContentBase::import
CommercePayment::__construct public function Builds a payment entity destination. Overrides EntityContentBase::__construct
DependencySerializationTrait::$_entityStorages protected property
DependencySerializationTrait::$_serviceIds protected property
DependencySerializationTrait::__sleep public function 2
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency.
DestinationBase::$migration protected property The migration.
DestinationBase::$rollbackAction protected property The rollback action to be saved for the last imported item.
DestinationBase::$supportsRollback protected property Indicates whether the destination can be rolled back.
DestinationBase::checkRequirements public function Checks if requirements for this plugin are OK. Overrides RequirementsInterface::checkRequirements
DestinationBase::getDestinationModule public function Gets the destination module handling the destination data. Overrides MigrateDestinationInterface::getDestinationModule 1
DestinationBase::rollbackAction public function The rollback action for the last imported item. Overrides MigrateDestinationInterface::rollbackAction
DestinationBase::setRollbackAction protected function For a destination item being updated, set the appropriate rollback action.
DestinationBase::supportsRollback public function Whether the destination can be rolled back or not. Overrides MigrateDestinationInterface::supportsRollback
Entity::$bundles protected property The list of the bundles of this entity type.
Entity::$storage protected property The entity storage.
Entity::calculateDependencies public function Calculates dependencies for the configured plugin. Overrides DependentPluginInterface::calculateDependencies
Entity::fields public function Returns an array of destination fields. Overrides MigrateDestinationInterface::fields
Entity::getBundle public function Gets the bundle for the row taking into account the default.
Entity::getEntity protected function Creates or loads an entity. 5
Entity::getEntityId protected function Gets the entity ID of the row. 2
Entity::getKey protected function Returns a specific entity key.
EntityContentBase::$entityFieldManager protected property Entity field manager.
EntityContentBase::$fieldTypeManager protected property Field type plugin manager.
EntityContentBase::getHighestId public function Returns the highest ID tracked by the implementing plugin. Overrides HighestIdInterface::getHighestId 2
EntityContentBase::getIds public function Gets the destination IDs. Overrides MigrateDestinationInterface::getIds 2
EntityContentBase::isEntityValidationRequired public function Returns a state of whether an entity needs to be validated before saving. Overrides MigrateValidatableEntityInterface::isEntityValidationRequired
EntityContentBase::isTranslationDestination public function
EntityContentBase::processStubRow protected function Populates as much of the stub row as possible. 3
EntityContentBase::rollback public function Delete the specified destination object from the target Drupal. Overrides Entity::rollback 1
EntityContentBase::save protected function Saves the entity. 3
EntityContentBase::updateEntity protected function Updates an entity with the new values from row. 3
EntityContentBase::validateEntity public function Validates the entity. Overrides MigrateValidatableEntityInterface::validateEntity
EntityFieldDefinitionTrait::getDefinitionFromEntity protected function Gets the field definition from a specific entity base field.
EntityFieldDefinitionTrait::getEntityTypeId protected static function Finds the entity type from configuration or plugin ID. 3
MessengerTrait::$messenger protected property The messenger. 27
MessengerTrait::messenger public function Gets the messenger. 27
MessengerTrait::setMessenger public function Sets the messenger.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 2
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
StringTranslationTrait::$stringTranslation protected property The string translation service. 4
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.