feature #16198 [EventDispatcher] added EventDispatcher::getListenerPriority() (fabpot)

This PR was merged into the 2.8 branch.

Discussion
----------

[EventDispatcher] added EventDispatcher::getListenerPriority()

| Q             | A
| ------------- | ---
| Bug fix?      | yes
| New feature?  | yes
| BC breaks?    | no
| Deprecations? | no
| Tests pass?   | yes
| Fixed tickets | #14563, #15825
| License       | MIT
| Doc PR        | n/a

In #14563, we added a way to get the priorities of listeners, but as noted by @Tobion in #15825, the implementation is sub-optimal because of two main reasons: the change is not part of the interface but more importantly, the added boolean changes the return value of `getListeners()`.

This PR reverts most of #14563 to add a `getListenerPriority()` method. This method is quite slow, but as it should only be used for debugging purposes (on the CLI or the WDT), I think it's not really a problem.

In 3.0, this method should probably be added to `EventDispatcherInterface`.

ping @Tobion

Commits
-------

068e955 [EventDispatcher] added EventDispatcher::getListenerPriority()

Author: fabpot

Console/Descriptor/JsonDescriptor.php

@@ -294,27 +294,21 @@ private function getEventDispatcherListenersData(EventDispatcherInterface $event
     {
         $data = array();
 
-        $registeredListeners = $eventDispatcher->getListeners($event, true);
+        $registeredListeners = $eventDispatcher->getListeners($event);
         if (null !== $event) {
-            krsort($registeredListeners);
-            foreach ($registeredListeners as $priority => $listeners) {
-                foreach ($listeners as $listener) {
-                    $listener = $this->getCallableData($listener);
-                    $listener['priority'] = $priority;
-                    $data[] = $listener;
-                }
+            foreach ($registeredListeners as $listener) {
+                $l = $this->getCallableData($listener);
+                $l['priority'] = $eventDispatcher->getListenerPriority($event, $listener);
+                $data[] = $l;
             }
         } else {
             ksort($registeredListeners);
 
             foreach ($registeredListeners as $eventListened => $eventListeners) {
-                krsort($eventListeners);
-                foreach ($eventListeners as $priority => $listeners) {
-                    foreach ($listeners as $listener) {
-                        $listener = $this->getCallableData($listener);
-                        $listener['priority'] = $priority;
-                        $data[$eventListened][] = $listener;
-                    }
+                foreach ($eventListeners as $eventListener) {
+                    $l = $this->getCallableData($eventListener);
+                    $l['priority'] = $eventDispatcher->getListenerPriority($eventListened, $eventListener);
+                    $data[$eventListened][] = $l;
                 }
             }
         }

Console/Descriptor/MarkdownDescriptor.php

@@ -273,30 +273,23 @@ protected function describeEventDispatcherListeners(EventDispatcherInterface $ev
 
         $this->write(sprintf('# %s', $title)."\n");
 
-        $registeredListeners = $eventDispatcher->getListeners($event, true);
+        $registeredListeners = $eventDispatcher->getListeners($event);
         if (null !== $event) {
-            krsort($registeredListeners);
-            $order = 1;
-            foreach ($registeredListeners as $priority => $listeners) {
-                foreach ($listeners as $listener) {
-                    $this->write("\n".sprintf('## Listener %d', $order++)."\n");
-                    $this->describeCallable($listener);
-                    $this->write(sprintf('- Priority: `%d`', $priority)."\n");
-                }
+            foreach ($registeredListeners as $order => $listener) {
+                $this->write("\n".sprintf('## Listener %d', $order + 1)."\n");
+                $this->describeCallable($listener);
+                $this->write(sprintf('- Priority: `%d`', $eventDispatcher->getListenerPriority($event, $listener))."\n");
             }
         } else {
             ksort($registeredListeners);
 
             foreach ($registeredListeners as $eventListened => $eventListeners) {
                 $this->write("\n".sprintf('## %s', $eventListened)."\n");
-                krsort($eventListeners);
-                $order = 1;
-                foreach ($eventListeners as $priority => $listeners) {
-                    foreach ($listeners as $listener) {
-                        $this->write("\n".sprintf('### Listener %d', $order++)."\n");
-                        $this->describeCallable($listener);
-                        $this->write(sprintf('- Priority: `%d`', $priority)."\n");
-                    }
+
+                foreach ($eventListeners as $order => $eventListener) {
+                    $this->write("\n".sprintf('### Listener %d', $order + 1)."\n");
+                    $this->describeCallable($eventListener);
+                    $this->write(sprintf('- Priority: `%d`', $eventDispatcher->getListenerPriority($eventListened, $eventListener))."\n");
                 }
             }
         }

Console/Descriptor/TextDescriptor.php

@@ -358,15 +358,14 @@ protected function describeEventDispatcherListeners(EventDispatcherInterface $ev
 
         $options['output']->title($title);
 
-        $registeredListeners = $eventDispatcher->getListeners($event, true);
-
+        $registeredListeners = $eventDispatcher->getListeners($event);
         if (null !== $event) {
-            $this->renderEventListenerTable($registeredListeners, $options['output']);
+            $this->renderEventListenerTable($eventDispatcher, $event, $registeredListeners, $options['output']);
         } else {
             ksort($registeredListeners);
             foreach ($registeredListeners as $eventListened => $eventListeners) {
                 $options['output']->section(sprintf('"%s" event', $eventListened));
-                $this->renderEventListenerTable($eventListeners, $options['output']);
+                $this->renderEventListenerTable($eventDispatcher, $eventListened, $eventListeners, $options['output']);
             }
         }
     }
@@ -382,17 +381,14 @@ protected function describeCallable($callable, array $options = array())
     /**
      * @param array $array
      */
-    private function renderEventListenerTable(array $eventListeners, SymfonyStyle $renderer)
+    private function renderEventListenerTable(EventDispatcherInterface $eventDispatcher, $event, array $eventListeners, SymfonyStyle $renderer)
     {
         $tableHeaders = array('Order', 'Callable', 'Priority');
         $tableRows = array();
 
-        krsort($eventListeners);
         $order = 1;
-        foreach ($eventListeners as $priority => $listeners) {
-            foreach ($listeners as $listener) {
-                $tableRows[] = array(sprintf('#%d', $order++), $this->formatCallable($listener), $priority);
-            }
+        foreach ($eventListeners as $order => $listener) {
+            $tableRows[] = array(sprintf('#%d', $order + 1), $this->formatCallable($listener), $eventDispatcher->getListenerPriority($event, $listener));
         }
 
         $renderer->table($tableHeaders, $tableRows);

Console/Descriptor/XmlDescriptor.php

@@ -449,17 +449,17 @@ private function getEventDispatcherListenersDocument(EventDispatcherInterface $e
         $dom = new \DOMDocument('1.0', 'UTF-8');
         $dom->appendChild($eventDispatcherXML = $dom->createElement('event-dispatcher'));
 
-        $registeredListeners = $eventDispatcher->getListeners($event, true);
+        $registeredListeners = $eventDispatcher->getListeners($event);
         if (null !== $event) {
-            $this->appendEventListenerDocument($eventDispatcherXML, $registeredListeners);
+            $this->appendEventListenerDocument($eventDispatcher, $event, $eventDispatcherXML, $registeredListeners);
         } else {
             ksort($registeredListeners);
 
             foreach ($registeredListeners as $eventListened => $eventListeners) {
                 $eventDispatcherXML->appendChild($eventXML = $dom->createElement('event'));
                 $eventXML->setAttribute('name', $eventListened);
 
-                $this->appendEventListenerDocument($eventXML, $eventListeners);
+                $this->appendEventListenerDocument($eventDispatcher, $eventListened, $eventXML, $eventListeners);
             }
         }
 
@@ -470,16 +470,13 @@ private function getEventDispatcherListenersDocument(EventDispatcherInterface $e
      * @param \DOMElement $element
      * @param array       $eventListeners
      */
-    private function appendEventListenerDocument(\DOMElement $element, array $eventListeners)
+    private function appendEventListenerDocument(EventDispatcherInterface $eventDispatcher, $event, \DOMElement $element, array $eventListeners)
     {
-        krsort($eventListeners);
-        foreach ($eventListeners as $priority => $listeners) {
-            foreach ($listeners as $listener) {
-                $callableXML = $this->getCallableDocument($listener);
-                $callableXML->childNodes->item(0)->setAttribute('priority', $priority);
+        foreach ($eventListeners as $listener) {
+            $callableXML = $this->getCallableDocument($listener);
+            $callableXML->childNodes->item(0)->setAttribute('priority', $eventDispatcher->getListenerPriority($event, $listener));
 
-                $element->appendChild($element->ownerDocument->importNode($callableXML->childNodes->item(0), true));
-            }
+            $element->appendChild($element->ownerDocument->importNode($callableXML->childNodes->item(0), true));
         }
     }