Add descriptions

src/Plugin/ECA/Event/EcaEvent.php

@@ -633,7 +633,7 @@ class EcaEvent extends EventBase {
    */
   #[Token(
     name: 'cart',
-    description: '',
+    description: 'The cart entity.',
     classes: [
       CartEmptyEvent::class,
       CartEntityAddEvent::class,
@@ -644,28 +644,28 @@ class EcaEvent extends EventBase {
   )]
   #[Token(
     name: 'commerce_coupon',
-    description: '',
+    description: 'The coupon entity.',
     classes: [
       CouponEvent::class,
     ]
   )]
   #[Token(
     name: 'commerce_customer',
-    description: '',
+    description: 'The current customer, this is a Drupal User.',
     classes: [
       OrderAssignEvent::class,
     ]
   )]
   #[Token(
     name: 'commerce_definition',
-    description: '',
+    description: 'This is the number format definition.',
     classes: [
       NumberFormatDefinitionEvent::class,
     ]
   )]
   #[Token(
     name: 'commerce_order',
-    description: '',
+    description: 'The order entity.',
     classes: [
       CheckoutCompletionRegisterEvent::class,
       OrderAssignEvent::class,
@@ -678,7 +678,7 @@ class EcaEvent extends EventBase {
   )]
   #[Token(
     name: 'commerce_order_item',
-    description: '',
+    description: 'The order item entity.',
     classes: [
       CartEntityAddEvent::class,
       CartOrderItemAddEvent::class,
@@ -691,49 +691,49 @@ class EcaEvent extends EventBase {
   )]
   #[Token(
     name: 'commerce_order_items',
-    description: '',
+    description: 'An array of order item entities.',
     classes: [
       CartEmptyEvent::class,
     ]
   )]
   #[Token(
     name: 'commerce_order_item_comparison_fields',
-    description: '',
+    description: 'The fields to compare.',
     classes: [
       OrderItemComparisonFieldsEvent::class,
     ]
   )]
   #[Token(
     name: 'commerce_order_item_original',
-    description: '',
+    description: 'The original item data before the update.',
     classes: [
       CartOrderItemUpdateEvent::class,
     ]
   )]
   #[Token(
     name: 'commerce_order_label',
-    description: '',
+    description: 'The order label.',
     classes: [
       OrderLabelEvent::class,
     ]
   )]
   #[Token(
     name: 'commerce_order_payment_gateways',
-    description: '',
+    description: 'The payment gateway configuration.',
     classes: [
       FilterPaymentGatewaysEvent::class,
     ]
   )]
   #[Token(
     name: 'commerce_payment',
-    description: '',
+    description: 'The payment entity.',
     classes: [
       PaymentEvent::class,
     ]
   )]
   #[Token(
     name: 'commerce_product',
-    description: '',
+    description: 'The product entity. This is not the variation.',
     classes: [
       FilterVariationsEvent::class,
       ProductDefaultVariationEvent::class,
@@ -742,14 +742,14 @@ class EcaEvent extends EventBase {
   )]
   #[Token(
     name: 'commerce_product_attribute_value',
-    description: '',
+    description: 'The product attribute value entity.',
     classes: [
       ProductAttributeValueEvent::class,
     ]
   )]
   #[Token(
     name: 'commerce_product_variation',
-    description: '',
+    description: 'The product variation entity. This is not the product entity.',
     classes: [
       FilterVariationsEvent::class,
       ProductVariationAjaxChangeEvent::class,
@@ -758,78 +758,84 @@ class EcaEvent extends EventBase {
   )]
   #[Token(
     name: 'commerce_product_variation_default',
-    description: '',
+    description: 'This is the default product variation.',
     classes: [
       ProductDefaultVariationEvent::class,
     ]
   )]
   #[Token(
     name: 'commerce_product_variation_response',
-    description: '',
+    description: 'The response when changing product variations via ajax.',
     classes: [
       ProductVariationAjaxChangeEvent::class,
     ]
   )]
   #[Token(
     name: 'commerce_product_variation_view_mode',
-    description: '',
+    description: 'The view mode for the product variation.',
     classes: [
       ProductVariationAjaxChangeEvent::class,
     ]
   )]
   #[Token(
     name: 'commerce_promotion',
-    description: '',
+    description: 'The promotion entity.',
     classes: [
       PromotionEvent::class,
     ]
   )]
   #[Token(
     name: 'commerce_promotions',
-    description: '',
+    description: 'An array of promotion entities.',
     classes: [
       FilterPromotionsEvent::class,
     ]
   )]
   #[Token(
     name: 'commerce_store',
-    description: '',
+    description: 'The store entity.',
     classes: [
       StoreEvent::class,
     ]
   )]
   #[Token(
-    name: 'commerce_store_plugin',
-    description: '',
+    name: 'commerce_tax_plugin',
+    description: 'The local tax type plugin.',
     classes: [
       BuildZonesEvent::class,
     ]
   )]
   #[Token(
-    name: 'commerce_store_zones',
-    description: '',
+    name: 'commerce_tax_zones',
+    description: 'An array of tax zones.',
     classes: [
       BuildZonesEvent::class,
     ]
   )]
   #[Token(
     name: 'entity',
-    description: '',
+    description: 'This is a purchasable entity.',
     classes: [
       CartEntityAddEvent::class,
     ]
   )]
   #[Token(
-    name: 'profile',
-    description: '',
+    name: 'customer_profile',
+    description: 'A customer profile.',
     classes: [
-      OrderProfilesEvent::class,
       CustomerProfileEvent::class,
     ]
   )]
+  #[Token(
+    name: 'profiles',
+    description: 'An array of customer profiles.',
+    classes: [
+      OrderProfilesEvent::class,
+    ]
+  )]
   #[Token(
     name: 'quantity',
-    description: '',
+    description: 'A float of the quantity.',
     classes: [
       CartEntityAddEvent::class,
       CartOrderItemAddEvent::class,
@@ -989,13 +995,13 @@ class EcaEvent extends EventBase {
         }
         break;
 
-      case 'commerce_store_plugin':
+      case 'commerce_tax_plugin':
         if ($event instanceof BuildZonesEvent) {
           return $event->getPlugin();
         }
         break;
 
-      case 'commerce_store_zones':
+      case 'commerce_tax_zones':
         if ($event instanceof BuildZonesEvent) {
           return $event->getZones();
         }
@@ -1007,10 +1013,14 @@ class EcaEvent extends EventBase {
         }
         break;
 
-      case 'profile':
-        if ($event instanceof OrderProfilesEvent
-          || $event instanceof CustomerProfileEvent
-        ) {
+      case 'customer_profile':
+        if ($event instanceof CustomerProfileEvent) {
+          return $event->getCustomerProfile();
+        }
+        break;
+
+      case 'profiles':
+        if ($event instanceof OrderProfilesEvent) {
           return $event->getProfiles();
         }
         break;