Issue #2980696 by bojanz: Rename conditions to remove the "Limit by" prefix

bojanz · bojanz · commit 217eae021bf8 · 2018-06-21T14:42:48.000+02:00
diff --git a/modules/order/src/Plugin/Commerce/Condition/OrderBillingAddress.php b/modules/order/src/Plugin/Commerce/Condition/OrderBillingAddress.php
@@ -13,9 +13,9 @@
  * @CommerceCondition(
  *   id = "order_billing_address",
  *   label = @Translation("Billing address"),
- *   display_label = @Translation("Limit by billing address"),
  *   category = @Translation("Customer"),
  *   entity_type = "commerce_order",
+ *   weight = 10,
  * )
  */
 class OrderBillingAddress extends ConditionBase {
diff --git a/modules/order/src/Plugin/Commerce/Condition/OrderCurrency.php b/modules/order/src/Plugin/Commerce/Condition/OrderCurrency.php
@@ -11,8 +11,7 @@
  *
  * @CommerceCondition(
  *   id = "order_currency",
- *   label = @Translation("Currency"),
- *   display_label = @Translation("Limit by currency"),
+ *   label = @Translation("Order currency"),
  *   category = @Translation("Order"),
  *   entity_type = "commerce_order",
  * )
diff --git a/modules/order/src/Plugin/Commerce/Condition/OrderCustomerRole.php b/modules/order/src/Plugin/Commerce/Condition/OrderCustomerRole.php
@@ -11,10 +11,10 @@
  *
  * @CommerceCondition(
  *   id = "order_customer_role",
- *   label = @Translation("Role"),
- *   display_label = @Translation("Limit by role"),
+ *   label = @Translation("Customer role"),
  *   category = @Translation("Customer"),
  *   entity_type = "commerce_order",
+ *   weight = -1,
  * )
  */
 class OrderCustomerRole extends ConditionBase {
diff --git a/modules/order/src/Plugin/Commerce/Condition/OrderEmail.php b/modules/order/src/Plugin/Commerce/Condition/OrderEmail.php
@@ -11,8 +11,7 @@
  *
  * @CommerceCondition(
  *   id = "order_email",
- *   label = @Translation("Email"),
- *   display_label = @Translation("Limit by email"),
+ *   label = @Translation("Customer email"),
  *   category = @Translation("Customer"),
  *   entity_type = "commerce_order",
  * )
diff --git a/modules/order/src/Plugin/Commerce/Condition/OrderItemQuantity.php b/modules/order/src/Plugin/Commerce/Condition/OrderItemQuantity.php
@@ -12,8 +12,8 @@
  * @CommerceCondition(
  *   id = "order_item_quantity",
  *   label = @Translation("Quantity"),
- *   display_label = @Translation("Limit by quantity"),
- *   category = @Translation("Product"),
+ *   display_label = @Translation("Total product quantity"),
+ *   category = @Translation("Order"),
  *   entity_type = "commerce_order_item",
  * )
  */
diff --git a/modules/order/src/Plugin/Commerce/Condition/OrderStore.php b/modules/order/src/Plugin/Commerce/Condition/OrderStore.php
@@ -15,7 +15,7 @@
  * @CommerceCondition(
  *   id = "order_store",
  *   label = @Translation("Store"),
- *   display_label = @Translation("Limit by store"),
+ *   display_label = @Translation("Store"),
  *   category = @Translation("Order"),
  *   entity_type = "commerce_order",
  * )
diff --git a/modules/order/src/Plugin/Commerce/Condition/OrderTotalPrice.php b/modules/order/src/Plugin/Commerce/Condition/OrderTotalPrice.php
@@ -13,7 +13,7 @@
  * @CommerceCondition(
  *   id = "order_total_price",
  *   label = @Translation("Total price"),
- *   display_label = @Translation("Limit by total price"),
+ *   display_label = @Translation("Current order total"),
  *   category = @Translation("Order"),
  *   entity_type = "commerce_order",
  * )
diff --git a/modules/order/src/Plugin/Commerce/Condition/OrderType.php b/modules/order/src/Plugin/Commerce/Condition/OrderType.php
@@ -9,8 +9,7 @@
  *
  * @CommerceCondition(
  *   id = "order_type",
- *   label = @Translation("Type"),
- *   display_label = @Translation("Limit by type"),
+ *   label = @Translation("Order type"),
  *   category = @Translation("Order"),
  *   entity_type = "commerce_order",
  * )
diff --git a/modules/payment/src/Plugin/Commerce/Condition/OrderPaymentGateway.php b/modules/payment/src/Plugin/Commerce/Condition/OrderPaymentGateway.php
@@ -12,7 +12,7 @@
  * @CommerceCondition(
  *   id = "order_payment_gateway",
  *   label = @Translation("Payment gateway"),
- *   display_label = @Translation("Limit by payment gateway"),
+ *   display_label = @Translation("Selected payment gateway"),
  *   category = @Translation("Order"),
  *   entity_type = "commerce_order",
  * )
diff --git a/modules/product/src/Plugin/Commerce/Condition/OrderItemProduct.php b/modules/product/src/Plugin/Commerce/Condition/OrderItemProduct.php
@@ -15,9 +15,10 @@
  * @CommerceCondition(
  *   id = "order_item_product",
  *   label = @Translation("Product"),
- *   display_label = @Translation("Limit by product"),
- *   category = @Translation("Product"),
+ *   display_label = @Translation("Specific products"),
+ *   category = @Translation("Products"),
  *   entity_type = "commerce_order_item",
+ *   weight = -1,
  * )
  */
 class OrderItemProduct extends ConditionBase implements ContainerFactoryPluginInterface {
diff --git a/modules/product/src/Plugin/Commerce/Condition/OrderItemProductType.php b/modules/product/src/Plugin/Commerce/Condition/OrderItemProductType.php
@@ -12,8 +12,8 @@
  * @CommerceCondition(
  *   id = "order_item_product_type",
  *   label = @Translation("Product type"),
- *   display_label = @Translation("Limit by product type"),
- *   category = @Translation("Product"),
+ *   display_label = @Translation("Product types"),
+ *   category = @Translation("Products"),
  *   entity_type = "commerce_order_item",
  * )
  */
diff --git a/modules/product/src/Plugin/Commerce/Condition/OrderItemVariationType.php b/modules/product/src/Plugin/Commerce/Condition/OrderItemVariationType.php
@@ -12,8 +12,8 @@
  * @CommerceCondition(
  *   id = "order_item_variation_type",
  *   label = @Translation("Product variation type"),
- *   display_label = @Translation("Limit by product variation type"),
- *   category = @Translation("Product"),
+ *   display_label = @Translation("Product variation types"),
+ *   category = @Translation("Products"),
  *   entity_type = "commerce_order_item",
  * )
  */
diff --git a/modules/promotion/tests/src/FunctionalJavascript/PromotionTest.php b/modules/promotion/tests/src/FunctionalJavascript/PromotionTest.php
@@ -58,14 +58,14 @@ public function testCreatePromotion() {
     $this->getSession()->getPage()->fillField('offer[0][target_plugin_configuration][order_percentage_off][percentage]', '10.0');
 
     // Confirm the integrity of the conditions UI.
-    foreach (['order', 'product', 'customer'] as $condition_group) {
+    foreach (['order', 'products', 'customer'] as $condition_group) {
       $tab_matches = $this->xpath('//a[@href="#edit-conditions-form-' . $condition_group . '"]');
       $this->assertNotEmpty($tab_matches);
     }
     $vertical_tab_elements = $this->xpath('//a[@href="#edit-conditions-form-order"]');
     $vertical_tab_element = reset($vertical_tab_elements);
     $vertical_tab_element->click();
-    $this->getSession()->getPage()->checkField('Limit by total price');
+    $this->getSession()->getPage()->checkField('Current order total');
     $this->waitForAjaxToFinish();
     $this->getSession()->getPage()->fillField('conditions[form][order][order_total_price][configuration][form][amount][number]', '50.00');
 
@@ -163,7 +163,7 @@ public function testEditPromotion() {
 
     $this->drupalGet($promotion->toUrl('edit-form'));
     $this->assertSession()->pageTextContains('Restricted');
-    $this->assertSession()->checkboxChecked('Limit by total price');
+    $this->assertSession()->checkboxChecked('Current order total');
     $this->assertSession()->fieldValueEquals('conditions[form][order][order_total_price][configuration][form][amount][number]', '9.10');
 
     $new_promotion_name = $this->randomMachineName(8);
diff --git a/src/Annotation/CommerceCondition.php b/src/Annotation/CommerceCondition.php
@@ -59,13 +59,25 @@ class CommerceCondition extends Plugin {
    */
   public $entity_type;
 
+  /**
+   * The condition weight.
+   *
+   * Used when sorting the condition list in the UI.
+   *
+   * @var int
+   */
+  public $weight = 0;
+
   /**
    * Constructs a new CommerceCondition object.
    *
    * @param array $values
    *   The annotation values.
    */
   public function __construct(array $values) {
+    if (empty($values['display_label'])) {
+      $values['display_label'] = $values['label'];
+    }
     if (empty($values['category'])) {
       $values['category'] = t('Other');
     }
diff --git a/src/ConditionManager.php b/src/ConditionManager.php
@@ -89,6 +89,13 @@ public function getFilteredDefinitions($parent_entity_type_id, array $entity_typ
     $event = new FilterConditionsEvent($definitions, $parent_entity_type_id);
     $this->eventDispatcher->dispatch(CommerceEvents::FILTER_CONDITIONS, $event);
     $definitions = $event->getDefinitions();
+    // Sort by weigh and display label.
+    uasort($definitions, function ($a, $b) {
+      if ($a['weight'] == $b['weight']) {
+        return strnatcasecmp($a['display_label'], $b['display_label']);
+      }
+      return ($a['weight'] < $b['weight']) ? -1 : 1;
+    });
 
     return $definitions;
   }
