symfony · fabpot · Dec 5, 2020 · Dec 5, 2020
diff --git a/src/Symfony/Bundle/FrameworkBundle/Command/EventDispatcherDebugCommand.php b/src/Symfony/Bundle/FrameworkBundle/Command/EventDispatcherDebugCommand.php
@@ -46,7 +46,7 @@ protected function configure()
    {
        $this
            ->setDefinition([
-                new InputArgument('event', InputArgument::OPTIONAL, 'An event name'),
+                new InputArgument('event', InputArgument::OPTIONAL, 'An event name or a part of the event name'),
                new InputOption('format', null, InputOption::VALUE_REQUIRED, 'The output format  (txt, xml, json, or md)', 'txt'),
                new InputOption('raw', null, InputOption::VALUE_NONE, 'To output raw description'),
            ])
@@ -75,13 +75,21 @@ protected function execute(InputInterface $input, OutputInterface $output): int

        $options = [];
        if ($event = $input->getArgument('event')) {
-            if (!$this->dispatcher->hasListeners($event)) {
-                $io->getErrorStyle()->warning(sprintf('The event "%s" does not have any registered listeners.', $event));
-
-                return 0;
+            if ($this->dispatcher->hasListeners($event)) {
+                $options = ['event' => $event];
+            } else {
+                // if there is no direct match, try find partial matches
+                $events = $this->searchForEvent($this->dispatcher, $event);
+                if (0 === \count($events)) {
+                    $io->getErrorStyle()->warning(sprintf('The event "%s" does not have any registered listeners.', $event));
+
+                    return 0;
+                } elseif (1 === \count($events)) {
+                    $options = ['event' => $events[array_key_first($events)]];
+                } else {
+                    $options = ['events' => $events];
+                }
            }
-
-            $options = ['event' => $event];
        }

        $helper = new DescriptorHelper();
@@ -92,4 +100,17 @@ protected function execute(InputInterface $input, OutputInterface $output): int

        return 0;
    }
+
+    private function searchForEvent(EventDispatcherInterface $dispatcher, $needle): array
+    {
+        $output = [];
+        $allEvents = array_keys($dispatcher->getListeners());
+        foreach ($allEvents as $event) {
+            if (str_contains($event, $needle)) {
+                $output[] = $event;
+            }
+        }
+
+        return $output;
+    }
 }
diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/JsonDescriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/JsonDescriptor.php
@@ -135,7 +135,7 @@ protected function describeContainerAlias(Alias $alias, array $options = [], Con

    protected function describeEventDispatcherListeners(EventDispatcherInterface $eventDispatcher, array $options = [])
    {
-        $this->writeData($this->getEventDispatcherListenersData($eventDispatcher, \array_key_exists('event', $options) ? $options['event'] : null), $options);
+        $this->writeData($this->getEventDispatcherListenersData($eventDispatcher, $options), $options);
    }

    protected function describeCallable($callable, array $options = [])
@@ -274,18 +274,19 @@ private function getContainerAliasData(Alias $alias): array
        ];
    }

-    private function getEventDispatcherListenersData(EventDispatcherInterface $eventDispatcher, string $event = null): array
+    private function getEventDispatcherListenersData(EventDispatcherInterface $eventDispatcher, array $options): array
    {
        $data = [];
+        $event = \array_key_exists('event', $options) ? $options['event'] : null;

-        $registeredListeners = $eventDispatcher->getListeners($event);
        if (null !== $event) {
-            foreach ($registeredListeners as $listener) {
+            foreach ($eventDispatcher->getListeners($event) as $listener) {
                $l = $this->getCallableData($listener);
                $l['priority'] = $eventDispatcher->getListenerPriority($event, $listener);
                $data[] = $l;
            }
        } else {
+            $registeredListeners = \array_key_exists('events', $options) ? array_combine($options['events'], array_map(function ($event) use ($eventDispatcher) { return $eventDispatcher->getListeners($event); }, $options['events'])) : $eventDispatcher->getListeners();
            ksort($registeredListeners);

            foreach ($registeredListeners as $eventListened => $eventListeners) {

diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/MarkdownDescriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/MarkdownDescriptor.php
@@ -291,11 +291,14 @@ protected function describeEventDispatcherListeners(EventDispatcherInterface $ev
        $title = 'Registered listeners';
        if (null !== $event) {
            $title .= sprintf(' for event `%s` ordered by descending priority', $event);
+            $registeredListeners = $eventDispatcher->getListeners($event);
+        } else {
+            // Try to see if "events" exists
+            $registeredListeners = \array_key_exists('events', $options) ? array_combine($options['events'], array_map(function ($event) use ($eventDispatcher) { return $eventDispatcher->getListeners($event); }, $options['events'])) : $eventDispatcher->getListeners();
        }

        $this->write(sprintf('# %s', $title)."\n");

-        $registeredListeners = $eventDispatcher->getListeners($event);
        if (null !== $event) {
            foreach ($registeredListeners as $order => $listener) {
                $this->write("\n".sprintf('## Listener %d', $order + 1)."\n");

diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/TextDescriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/TextDescriptor.php
@@ -477,13 +477,14 @@ protected function describeEventDispatcherListeners(EventDispatcherInterface $ev

        if (null !== $event) {
            $title = sprintf('Registered Listeners for "%s" Event', $event);
+            $registeredListeners = $eventDispatcher->getListeners($event);
        } else {
            $title = 'Registered Listeners Grouped by Event';
+            // Try to see if "events" exists
+            $registeredListeners = \array_key_exists('events', $options) ? array_combine($options['events'], array_map(function ($event) use ($eventDispatcher) { return $eventDispatcher->getListeners($event); }, $options['events'])) : $eventDispatcher->getListeners();
        }

        $options['output']->title($title);
-
-        $registeredListeners = $eventDispatcher->getListeners($event);
        if (null !== $event) {
            $this->renderEventListenerTable($eventDispatcher, $event, $registeredListeners, $options['output']);
        } else {

diff --git a/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/XmlDescriptor.php b/src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/XmlDescriptor.php
@@ -89,7 +89,7 @@ protected function describeContainerAlias(Alias $alias, array $options = [], Con

    protected function describeEventDispatcherListeners(EventDispatcherInterface $eventDispatcher, array $options = [])
    {
-        $this->writeDocument($this->getEventDispatcherListenersDocument($eventDispatcher, \array_key_exists('event', $options) ? $options['event'] : null));
+        $this->writeDocument($this->getEventDispatcherListenersDocument($eventDispatcher, $options));
    }

    protected function describeCallable($callable, array $options = [])
@@ -454,15 +454,18 @@ private function getContainerParameterDocument($parameter, array $options = []):
        return $dom;
    }

-    private function getEventDispatcherListenersDocument(EventDispatcherInterface $eventDispatcher, string $event = null): \DOMDocument
+    private function getEventDispatcherListenersDocument(EventDispatcherInterface $eventDispatcher, array $options): \DOMDocument
    {
+        $event = \array_key_exists('event', $options) ? $options['event'] : null;
        $dom = new \DOMDocument('1.0', 'UTF-8');
        $dom->appendChild($eventDispatcherXML = $dom->createElement('event-dispatcher'));

-        $registeredListeners = $eventDispatcher->getListeners($event);
        if (null !== $event) {
+            $registeredListeners = $eventDispatcher->getListeners($event);
            $this->appendEventListenerDocument($eventDispatcher, $event, $eventDispatcherXML, $registeredListeners);
        } else {
+            // Try to see if "events" exists
+            $registeredListeners = \array_key_exists('events', $options) ? array_combine($options['events'], array_map(function ($event) use ($eventDispatcher) { return $eventDispatcher->getListeners($event); }, $options['events'])) : $eventDispatcher->getListeners();
            ksort($registeredListeners);

            foreach ($registeredListeners as $eventListened => $eventListeners) {