dev/core#1460 - Small cleanups in CiviEventDispatcher{,Test}

Civi/Core/CiviEventDispatcher.php

@@ -29,12 +29,22 @@ class CiviEventDispatcher extends ContainerAwareEventDispatcher {
   private $autoListeners = [];
 
   /**
+   * A list of dispatch-policies (based on an exact-match to the event name).
+   *
+   * Note: $dispatchPolicyExact and $dispatchPolicyRegex should coexist; e.g.
+   * if one is NULL, then both are NULL. If one is an array, then both are arrays.
+   *
    * @var array|null
    *   Array(string $eventName => string $action)
    */
   private $dispatchPolicyExact = NULL;
 
   /**
+   * A list of dispatch-policies (based on an regex-match to the event name).
+   *
+   * Note: $dispatchPolicyExact and $dispatchPolicyRegex should coexist; e.g.
+   * if one is NULL, then both are NULL. If one is an array, then both are arrays.
+   *
    * @var array|null
    *   Array(string $eventRegex => string $action)
    */
@@ -155,6 +165,8 @@ public static function delegateToUF($event, $eventName) {
   }
 
   /**
+   * Attach any pattern-based listeners which may be interested in $eventName.
+   *
    * @param string $eventName
    *   Ex: 'civi.api.resolve' or 'hook_civicrm_dashboard'.
    */
@@ -174,7 +186,7 @@ protected function bindPatterns($eventName) {
   }
 
   /**
-   * The dispatch policy allows you to filter certain events.
+   * Set the dispatch policy. This allows you to filter certain events.
    * This can be useful during upgrades or debugging.
    *
    * Enforcement will add systemic overhead, so this should normally be NULL.
@@ -219,7 +231,10 @@ public function setDispatchPolicy($dispatchPolicy) {
   //  }
 
   /**
+   * Determine whether the dispatch policy applies to a given event.
+   *
    * @param string $eventName
+   *   Ex: 'civi.api.resolve' or 'hook_civicrm_dashboard'.
    * @return string
    *   Ex: 'run', 'drop', 'fail'
    */

tests/phpunit/Civi/Core/CiviEventDispatcherTest.php

@@ -20,7 +20,7 @@ public function testDispatchPolicy_run() {
     $d->addListener('hook_civicrm_fakeRunnable', function() use (&$calls) {
       $calls['hook_civicrm_fakeRunnable'] = 1;
     });
-    $d->dispatch('hook_civicrm_fakeRunnable', new GenericHookEvent());
+    $d->dispatch('hook_civicrm_fakeRunnable', GenericHookEvent::create([]));
     $this->assertEquals(1, $calls['hook_civicrm_fakeRunnable']);
   }
 
@@ -33,7 +33,7 @@ public function testDispatchPolicy_drop() {
     $d->addListener('hook_civicrm_fakeDroppable', function() use (&$calls) {
       $calls['hook_civicrm_fakeDroppable'] = 1;
     });
-    $d->dispatch('hook_civicrm_fakeDroppable', new GenericHookEvent());
+    $d->dispatch('hook_civicrm_fakeDroppable', GenericHookEvent::create([]));
     $this->assertTrue(!isset($calls['hook_civicrm_fakeDroppable']));
   }
 
@@ -43,7 +43,7 @@ public function testDispatchPolicy_fail() {
       '/^hook_civicrm_fakeFa/' => 'fail',
     ]);
     try {
-      $d->dispatch('hook_civicrm_fakeFailure', new GenericHookEvent());
+      $d->dispatch('hook_civicrm_fakeFailure', GenericHookEvent::create([]));
       $this->fail('Expected exception');
     }
     catch (\Exception $e) {