Reword event docs to clarify priority vs weight
authorColeman Watts <coleman@civicrm.org>
Sat, 14 Sep 2019 14:22:03 +0000 (10:22 -0400)
committerColeman Watts <coleman@civicrm.org>
Sat, 14 Sep 2019 14:22:03 +0000 (10:22 -0400)
Civi/API/Events.php

index 9051f75d2b1dbb3778f77449f73610a6fc6e298c..25907b71c9f942dae1d76492a3219bed6db7e0c6 100644 (file)
@@ -33,8 +33,7 @@ namespace Civi\API;
  * event is dispatched.
  *
  * Event subscribers which are concerned about the order of execution should assign
- * a weight to their subscription (such as W_EARLY, W_MIDDLE, or W_LATE).
- * W_LATE).
+ * a priority to their subscription (such as W_EARLY, W_MIDDLE, or W_LATE).
  */
 class Events {
 
@@ -78,17 +77,17 @@ class Events {
   const EXCEPTION = 'civi.api.exception';
 
   /**
-   * Weight - Early
+   * Priority - Higher numbers execute earlier
    */
   const W_EARLY = 100;
 
   /**
-   * Weight - Middle
+   * Priority - Middle
    */
   const W_MIDDLE = 0;
 
   /**
-   * Weight - Late
+   * Priority - Lower numbers execute later
    */
   const W_LATE = -100;