Issue #2953940 by pslcbs, jsacksick, bojanz: Add an OrderPaymentGateway condition

Author: jsacksick

modules/payment/commerce_payment.services.yml

@@ -16,6 +16,11 @@ services:
     class: Drupal\commerce_payment\PaymentTypeManager
     parent: default_plugin_manager
 
+  commerce_payment.filter_conditions_subscriber:
+    class: Drupal\commerce_payment\EventSubscriber\FilterConditionsEventSubscriber
+    tags:
+      - { name: event_subscriber }
+
   commerce_payment.options_builder:
     class: Drupal\commerce_payment\PaymentOptionsBuilder
     arguments: ['@entity_type.manager']

modules/payment/config/schema/commerce_payment.schema.yml

@@ -1,3 +1,14 @@
+commerce.commerce_condition.plugin.order_payment_gateway:
+  type: commerce_condition_configuration
+  mapping:
+    payment_gateways:
+      type: sequence
+      label: 'Payment gateways'
+      orderby: value
+      sequence:
+        type: string
+        label: 'Payment gateway'
+
 commerce_payment.commerce_payment_gateway.*:
   type: config_entity
   label: 'Payment gateway'

modules/payment/src/EventSubscriber/FilterConditionsEventSubscriber.php

@@ -0,0 +1,34 @@
+<?php
+
+namespace Drupal\commerce_payment\EventSubscriber;
+
+use Drupal\commerce\Event\FilterConditionsEvent;
+use Symfony\Component\EventDispatcher\EventSubscriberInterface;
+
+class FilterConditionsEventSubscriber implements EventSubscriberInterface {
+
+  /**
+   * {@inheritdoc}
+   */
+  public static function getSubscribedEvents() {
+    $events = [
+      'commerce.filter_conditions' => 'onFilterConditions',
+    ];
+    return $events;
+  }
+
+  /**
+   * Removes the payment gateway condition on payment gateways.
+   *
+   * @param \Drupal\commerce\Event\FilterConditionsEvent $event
+   *   The event.
+   */
+  public function onFilterConditions(FilterConditionsEvent $event) {
+    if ($event->getParentEntityTypeId() == 'commerce_payment_gateway') {
+      $definitions = $event->getDefinitions();
+      unset($definitions['order_payment_gateway']);
+      $event->setDefinitions($definitions);
+    }
+  }
+
+}

modules/payment/src/Plugin/Commerce/Condition/OrderPaymentGateway.php

@@ -0,0 +1,76 @@
+<?php
+
+namespace Drupal\commerce_payment\Plugin\Commerce\Condition;
+
+use Drupal\commerce\Plugin\Commerce\Condition\ConditionBase;
+use Drupal\Core\Entity\EntityInterface;
+use Drupal\Core\Form\FormStateInterface;
+
+/**
+ * Provides the payment gateway condition for orders.
+ *
+ * @CommerceCondition(
+ *   id = "order_payment_gateway",
+ *   label = @Translation("Payment gateway"),
+ *   display_label = @Translation("Limit by payment gateway"),
+ *   category = @Translation("Order"),
+ *   entity_type = "commerce_order",
+ * )
+ */
+class OrderPaymentGateway extends ConditionBase {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function defaultConfiguration() {
+    return [
+      'payment_gateways' => [],
+    ] + parent::defaultConfiguration();
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function buildConfigurationForm(array $form, FormStateInterface $form_state) {
+    $form = parent::buildConfigurationForm($form, $form_state);
+
+    $form['payment_gateways'] = [
+      '#type' => 'commerce_entity_select',
+      '#title' => $this->t('Payment gateways'),
+      '#default_value' => $this->configuration['payment_gateways'],
+      '#target_type' => 'commerce_payment_gateway',
+      '#hide_single_entity' => FALSE,
+      '#multiple' => TRUE,
+      '#required' => TRUE,
+    ];
+
+    return $form;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function submitConfigurationForm(array &$form, FormStateInterface $form_state) {
+    parent::submitConfigurationForm($form, $form_state);
+
+    $values = $form_state->getValue($form['#parents']);
+    $this->configuration['payment_gateways'] = $values['payment_gateways'];
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function evaluate(EntityInterface $entity) {
+    $this->assertEntity($entity);
+    /** @var \Drupal\commerce_order\Entity\OrderInterface $order */
+    $order = $entity;
+    if ($order->get('payment_gateway')->isEmpty()) {
+      // The payment gateway is not known yet, the condition cannot pass.
+      return FALSE;
+    }
+    $payment_gateway_id = $order->get('payment_gateway')->get('target_id');
+
+    return in_array($payment_gateway_id, $this->configuration['payment_gateways']);
+  }
+
+}

modules/payment/tests/src/Unit/Plugin/Commerce/Condition/OrderPaymentGatewayTest.php

@@ -0,0 +1,62 @@
+<?php
+
+namespace Drupal\Tests\commerce_payment\Unit\Plugin\Commerce\Condition;
+
+use Drupal\commerce_order\Entity\OrderInterface;
+use Drupal\commerce_payment\Plugin\Commerce\Condition\OrderPaymentGateway;
+use Drupal\Core\Field\Plugin\Field\FieldType\EntityReferenceItem;
+use Drupal\Tests\UnitTestCase;
+
+/**
+ * @coversDefaultClass \Drupal\commerce_payment\Plugin\Commerce\Condition\OrderPaymentGateway
+ * @group commerce
+ */
+class OrderPaymentGatewayTest extends UnitTestCase {
+
+  /**
+   * ::covers evaluate.
+   */
+  public function testIncompleteOrder() {
+    $condition = new OrderPaymentGateway([
+      'payment_gateways' => ['test'],
+    ], 'order_payment_gateway', ['entity_type' => 'commerce_order']);
+    $order = $this->prophesize(OrderInterface::class);
+
+    $entity_reference_item = $this->prophesize(EntityReferenceItem::class);
+    $entity_reference_item->isEmpty()->willReturn(TRUE);
+    $entity_reference_item = $entity_reference_item->reveal();
+
+    $order = $this->prophesize(OrderInterface::class);
+    $order->getEntityTypeId()->willReturn('commerce_order');
+    $order->get('payment_gateway')->willReturn($entity_reference_item);
+    $order = $order->reveal();
+
+    $this->assertFalse($condition->evaluate($order));
+  }
+
+  /**
+   * Covers evaluate.
+   */
+  public function testOrderPaymentGateway() {
+    $entity_reference_item = $this->prophesize(EntityReferenceItem::class);
+    $entity_reference_item->isEmpty()->willReturn(FALSE);
+    $entity_reference_item->get('target_id')->willReturn('test');
+    $entity_reference_item = $entity_reference_item->reveal();
+
+    $order = $this->prophesize(OrderInterface::class);
+    $order->getEntityTypeId()->willReturn('commerce_order');
+    $order->get('payment_gateway')->willReturn($entity_reference_item);
+    $order = $order->reveal();
+
+    $condition = new OrderPaymentGateway([
+      'payment_gateways' => ['cash_on_delivery'],
+    ], 'order_payment_gateway', ['entity_type' => 'commerce_order']);
+    $this->assertFalse($condition->evaluate($order));
+
+    $condition = new OrderPaymentGateway([
+      'payment_gateways' => ['test', 'cash_on_delivery'],
+    ], 'order_payment_gateway', ['entity_type' => 'commerce_order']);
+    $this->assertTrue($condition->evaluate($order));
+  }
+
+}