Issue #2976135 by Mile23: events_example does not have a handler for the 'cat in a tree' incident

Author: Mile23

events_example/src/EventSubscriber/EventsExampleSubscriber.php

@@ -61,6 +61,10 @@ public static function getSubscribedEvents() {
     // of priority. If no priority is set the default is 0.
     $events[IncidentEvents::NEW_REPORT][] = ['notifyBatman', -100];
 
+    // We'll set an event listener with a very low priority to catch incident
+    // types not yet defined. In practice, this will be the 'cat' incident.
+    $events[IncidentEvents::NEW_REPORT][] = ['notifyDefault', -255];
+
     return $events;
   }
 
@@ -88,7 +92,11 @@ public function notifyMario(IncidentReportEvent $event) {
     // You can use the event object to access information about the event passed
     // along by the event dispatcher.
     if ($event->getType() == 'stolen_princess') {
-      drupal_set_message($this->t('Mario has been alerted. Thank you. This message was set by an event subscriber. See \Drupal\events_example\EventSubscriber\EventsExampleSubscriber::notifyMario()'), 'status');
+      drupal_set_message($this->t('Mario has been alerted. Thank you. This message was set by an event subscriber. See @method()', ['@method' => __METHOD__]), 'status');
+      // Optionally use the event object to stop propagation.
+      // If there are other subscribers that have not been called yet this will
+      // cause them to be skipped.
+      $event->stopPropagation();
     }
   }
 
@@ -100,12 +108,20 @@ public function notifyMario(IncidentReportEvent $event) {
    */
   public function notifyBatman(IncidentReportEvent $event) {
     if ($event->getType() == 'joker') {
-      drupal_set_message($this->t('Batman has been alerted. Thank you. This message was set by an event subscriber. See \Drupal\events_example\EventSubscriber\EventsExampleSubscriber::notifyBatman()'), 'status');
-      // Optionally use the event object to stop propagation.
-      // If there are other subscribers that have not been called yet this will
-      // cause them to be skipped.
+      drupal_set_message($this->t('Batman has been alerted. Thank you. This message was set by an event subscriber. See @method()', ['@method' => __METHOD__]), 'status');
       $event->stopPropagation();
     }
   }
 
+  /**
+   * Handle incidents not handled by the other handlers.
+   *
+   * @param \Drupal\events_example\Event\IncidentReportEvent $event
+   *   The event object containing the incident report.
+   */
+  public function notifyDefault(IncidentReportEvent $event) {
+    drupal_set_message($this->t('Thank you for reporting this incident. This message was set by an event subscriber. See @method()', ['@method' => __METHOD__]), 'status');
+    $event->stopPropagation();
+  }
+
 }

events_example/tests/src/Functional/EventsExampleTest.php

@@ -2,6 +2,7 @@
 
 namespace Drupal\Tests\events_example\Functional;
 
+use Drupal\Core\Url;
 use Drupal\Tests\BrowserTestBase;
 
 /**
@@ -10,8 +11,10 @@
  * For another example of testing whether or not events are dispatched see
  * \Drupal\Tests\migrate\Kernel\MigrateEventsTest.
  *
- * @ingroup events_example
+ * @group events_example
  * @group examples
+ *
+ * @ingroup events_example
  */
 class EventsExampleTest extends BrowserTestBase {
 
@@ -30,7 +33,8 @@ class EventsExampleTest extends BrowserTestBase {
    */
   public function testEventsExample() {
     // Test that the main page for the example is accessible.
-    $this->drupalGet('examples/events-example');
+    $events_example_form = Url::fromRoute('events_example.description');
+    $this->drupalGet($events_example_form);
     $this->assertSession()->statusCodeEquals(200);
 
     // Verify the page contains the required form fields.
@@ -48,7 +52,7 @@ public function testEventsExample() {
       'incident_type' => 'stolen_princess',
       'incident' => $this->randomString(),
     ];
-    $this->drupalPostForm('examples/events-example', $values, 'Submit');
+    $this->drupalPostForm($events_example_form, $values, 'Submit');
     $this->assertSession()->pageTextContains('Mario has been alerted. Thank you.');
 
     // Fill out the form again, this time testing that the
@@ -57,8 +61,17 @@ public function testEventsExample() {
       'incident_type' => 'joker',
       'incident' => $this->randomString(),
     ];
-    $this->drupalPostForm('examples/events-example', $values, 'Submit');
+    $this->drupalPostForm($events_example_form, $values, 'Submit');
     $this->assertSession()->pageTextContains('Batman has been alerted. Thank you.');
+
+    // Fill out the form again, this time testing that our default handler
+    // catches all the remaining values.
+    $values = [
+      'incident_type' => 'cat',
+      'incident' => $this->randomString(),
+    ];
+    $this->drupalPostForm($events_example_form, $values, 'Submit');
+    $this->assertSession()->pageTextContains('notifyDefault()');
   }
 
 }

events_example/tests/src/Kernel/EventsExampleServiceTest.php

@@ -8,8 +8,10 @@
 /**
  * Test to ensure 'events_example_subscriber' service is reachable.
  *
- * @ingroup events_example
+ * @group events_example
  * @group examples
+ *
+ * @ingroup events_example
  */
 class EventsExampleServiceTest extends KernelTestBase {