8000 [FrameworkBundle][EventDispatcher] Add priorities to the debug:event-dispatcher command by Seldaek · Pull Request #14563 · symfony/symfony · GitHub
[go: up one dir, main page]
Skip to content

[FrameworkBundle][EventDispatcher] Add priorities to the debug:event-dispatcher command #14563

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 6, 2015
Merged

[FrameworkBundle][EventDispatcher] Add priorities to the debug:event-dispatcher command #14563

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 15 additions & 5 deletions src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/JsonDescriptor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -288,17 +288,27 @@ private function getEventDispatcherListenersData(EventDispatcherInterface $event
{
$data = array();

$registeredListeners = $eventDispatcher->getListeners($event);
$registeredListeners = $eventDispatcher->getListeners($event, true);
if (null !== $event) {
foreach ($registeredListeners as $listener) {
$data[] = $this->getCallableData($listener);
krsort($registeredListeners);
foreach ($registeredListeners as $priority => $listeners) {
foreach ($listeners as $listener) {
$listener = $this->getCallableData($listener);
$listener['priority'] = $priority;
$data[] = $listener;
}
}
} else {
ksort($registeredListeners);

foreach ($registeredListeners as $eventListened => $eventListeners) {
foreach ($eventListeners as $eventListener) {
$data[$eventListened][] = $this->getCallableData($eventListener);
krsort($eventListeners);
foreach ($eventListeners as $priority => $listeners) {
foreach ($listeners as $listener) {
$listener = $this->getCallableData($listener);
$listener['priority'] = $priority;
$data[$eventListened][] = $listener;
}
}
}
}
Expand Down
25 changes: 17 additions & 8 deletions src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/MarkdownDescriptor.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -269,21 +269,30 @@ protected function describeEventDispatcherListeners(EventDispatcherInterface $ev

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

$registeredListeners = $eventDispatcher->getListeners($event);
$registeredListeners = $eventDispatcher->getListeners($event, true);
if (null !== $event) {
foreach ($registeredListeners as $order => $listener) {
$this->write("\n".sprintf('## Listener %d', $order + 1)."\n");
$this->describeCallable($listener);
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");
}
}
} else {
ksort($registeredListeners);

foreach ($registeredListeners as $eventListened => $eventListeners) {
$this->write("\n".sprintf('## %s', $eventListened)."\n");

foreach ($eventListeners as $order => $eventListener) {
$this->write("\n".sprintf('### Listener %d', $order + 1)."\n");
$this->describeCallable($eventListener);
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");
}
}
}
}
Expand Down
43 changes: 23 additions & 20 deletions src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/TextDescriptor.php
View file
Open in desktop
EDBE
Original file line number Diff line number Diff line change
Expand Up @@ -336,33 +336,16 @@ protected function describeEventDispatcherListeners(EventDispatcherInterface $ev

$this->writeText($this->formatSection('event_dispatcher', $label)."\n", $options);

$registeredListeners = $eventDispatcher->getListeners($event);
$registeredListeners = $eventDispatcher->getListeners($event, true);

if (null !== $event) {
$this->writeText("\n");
$table = new Table($this->getOutput());
$table->getStyle()->setCellHeaderFormat('%s');
$table->setHeaders(array('Order', 'Callable'));

foreach ($registeredListeners as $order => $listener) {
$table->addRow(array(sprintf('#%d', $order + 1), $this->formatCallable($listener)));
}

$table->render();
$this->renderEventListenerTable($registeredListeners);
} else {
ksort($registeredListeners);
foreach ($registeredListeners as $eventListened => $eventListeners) {
$this->writeText(sprintf("\n<info>[Event]</info> %s\n", $eventListened), $options);

$table = new Table($this->getOutput());
$table->getStyle()->setCellHeaderFormat('%s');
$table->setHeaders(array('Order', 'Callable'));

foreach ($eventListeners as $order => $eventListener) {
$table->addRow(array(sprintf('#%d', $order + 1), $this->formatCallable($eventListener)));
}

$table->render();
$this->renderEventListenerTable($eventListeners);
}
}
}
Expand All @@ -375,6 +358,26 @@ protected function describeCallable($callable, array $options = array())
$this->writeText($this->formatCallable($callable), $options);
}

/**
* @param array $array
*/
private function renderEventListenerTable(array $eventListeners)
{
$table = new Table($this->getOutput());
$table->getStyle()->setCellHeaderFormat('%s');
$table->setHeaders(array('Order', 'Callable', 'Priority'));

krsort($eventListeners);
$order = 1;
foreach ($eventListeners as $priority => $listeners) {
foreach ($listeners as $listener) {
$table->addRow(array(sprintf('#%d', $order++), $this->formatCallable($listener), $priority));
}
}

$table->render();
}

/**
* @param array $array
*
Expand Down
31 changes: 20 additions & 11 deletions src/Symfony/Bundle/FrameworkBundle/Console/Descriptor/XmlDescriptor.php
View file
Open in desktop
F438
Original file line number Diff line number Diff line change
Expand Up @@ -446,31 +446,40 @@ private function getEventDispatcherListenersDocument(EventDispatcherInterface $e
$dom = new \DOMDocument('1.0', 'UTF-8');
$dom->appendChild($eventDispatcherXML = $dom->createElement('event-dispatcher'));

$registeredListeners = $eventDispatcher->getListeners($event);
$registeredListeners = $eventDispatcher->getListeners($event, true);
if (null !== $event) {
foreach ($registeredListeners as $listener) {
$callableXML = $this->getCallableDocument($listener);

$eventDispatcherXML->appendChild($eventDispatcherXML->ownerDocument->importNode($callableXML->childNodes->item(0), true));
}
$this->appendEventListenerDocument($eventDispatcherXML, $registeredListeners);
} else {
ksort($registeredListeners);

foreach ($registeredListeners as $eventListened => $eventListeners) {
$eventDispatcherXML->appendChild($eventXML = $dom->createElement('event'));
$eventXML->setAttribute('name', $eventListened);

foreach ($eventListeners as $eventListener) {
$callableXML = $this->getCallableDocument($eventListener);

$eventXML->appendChild($eventXML->ownerDocument->importNode($callableXML->childNodes->item(0), true));
}
$this->appendEventListenerDocument($eventXML, $eventListeners);
}
}

return $dom;
}

/**
* @param DOMElement $element
* @param array $eventListeners
*/
private function appendEventListenerDocument(\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);

$element->appendChild($element->ownerDocument->importNode($callableXML->childNodes->item(0), true));
}
}
}

/**
* @param callable $callable
*
Expand Down
4 changes: 2 additions & 2 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Console/Descriptor/ObjectsProvider.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -157,8 +157,8 @@ public static function getEventDispatchers()
{
$eventDispatcher = new EventDispatcher();

$eventDispatcher->addListener('event1', 'global_function');
$eventDispatcher->addListener('event1', function () { return 'Closure'; });
$eventDispatcher->addListener('event1', 'global_function', 255);
$eventDispatcher->addListener('event1', function () { return 'Closure'; }, -1);
$eventDispatcher->addListener('event2', new CallableClass());

return array('event_dispatcher_1' => $eventDispatcher);
Expand Down
6 changes: 4 additions & 2 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/event_dispatcher_1_event1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,11 @@
[
{
"type": "function",
"name": "global_function"
"name": "global_function",
"priority": 255
},
{
"type": "closure"
"type": "closure",
"priority": -1
}
]
2 changes: 2 additions & 0 deletions ...y/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/event_dispatcher_1_event1.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,9 @@

- Type: `function`
- Name: `global_function`
- Priority: `255`

## Listener 2

- Type: `closure`
- Priority: `-1`
12 changes: 6 additions & 6 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/event_dispatcher_1_event1.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<info>[event_dispatcher]</info> Registered listeners for event <info>event1</info>

+-------+-------------------+
| Order | Callable |
+-------+-------------------+
| #1 | global_function() |
| #2 | \Closure() |
+-------+-------------------+
+-------+-------------------+----------+
| Order | Callable | Priority |
+-------+-------------------+----------+
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We could just replace the "Order" column with priority don't you think ? The "Order" column was just there because it was impossible to get priorities in dispatcher !

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes I wasn't quite sure why the Order column was there, maybe for people who can't count :P If you'd like to send a PR to remove it from the TextDescriptor that sounds good to me.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer to keep both , the order is useful when events have the same priority.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The command already list the events by order so the information is still available. But finally I think it's more developer friendly to keep it, you don't have to know how Symfony manage order internally 👍

| #1 | global_function() | 255 |
| #2 | \Closure() | -1 |
+-------+-------------------+----------+
4 changes: 2 additions & 2 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/event_dispatcher_1_event1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
<?xml version="1.0" encoding="UTF-8"?>
<event-dispatcher>
<callable type="function" name="global_function"/>
<callable type="closure"/>
<callable type="function" name="global_function" priority="255"/>
<callable type="closure" priority="-1"/>
</event-dispatcher>
9 changes: 6 additions & 3 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/event_dispatcher_1_events.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,16 +2,19 @@
"event1": [
{
"type": "function",
"name": "global_function"
"name": "global_function",
"priority": 255
},
{
"type": "closure"
"type": "closure",
"priority": -1
}
],
"event2": [
{
"type": "object",
"name": "Symfony\\Bundle\\FrameworkBundle\\Tests\\Console\\Descriptor\\CallableClass"
"name": "Symfony\\Bundle\\FrameworkBundle\\Tests\\Console\\Descriptor\\CallableClass",
"priority": 0
}
]
}
3 changes: 3 additions & 0 deletions ...y/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/event_dispatcher_1_events.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,14 +6,17 @@

- Type: `function`
- Name: `global_function`
- Priority: `255`

### Listener 2

- Type: `closure`
- Priority: `-1`

## event2

### Listener 1

- Type: `object`
- Name: `Symfony\Bundle\FrameworkBundle\Tests\Console\Descriptor\CallableClass`
- Priority: `0`
22 changes: 11 additions & 11 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/event_dispatcher_1_events.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,16 @@
<info>[event_dispatcher]</info> Registered listeners by event

<info>[Event]</info> event1
+-------+-------------------+
| Order | Callable |
+-------+-------------------+
| #1 | global_function() |
| #2 | \Closure() |
+-------+-------------------+
+-------+-------------------+----------+
| Order | Callable | Priority |
+-------+-------------------+----------+
| #1 | global_function() | 255 |
| #2 | \Closure() | -1 |
+-------+-------------------+----------+

<info>[Event]</info> event2
+-------+-----------------------------------------------------------------------------------+
| Order | Callable |
+-------+-----------------------------------------------------------------------------------+
| #1 | Symfony\Bundle\FrameworkBundle\Tests\Console\Descriptor\CallableClass::__invoke() |
+-------+-----------------------------------------------------------------------------------+
+-------+-----------------------------------------------------------------------------------+----------+
| Order | Callable | Priority |
+-------+-----------------------------------------------------------------------------------+----------+
| #1 | Symfony\Bundle\FrameworkBundle\Tests\Console\Descriptor\CallableClass::__invoke() | 0 |
+-------+-----------------------------------------------------------------------------------+----------+
6 changes: 3 additions & 3 deletions src/Symfony/Bundle/FrameworkBundle/Tests/Fixtures/Descriptor/event_dispatcher_1_events.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
<?xml version="1.0" encoding="UTF-8"?>
<event-dispatcher>
<event name="event1">
<callable type="function" name="global_function"/>
<callable type="closure"/>
<callable type="function" name="global_function" priority="255"/>
<callable type="closure" priority="-1"/>
</event>
<event name="event2">
<callable type="object" name="Symfony\Bundle\FrameworkBundle\Tests\Console\Descriptor\CallableClass"/>
<callable type="object" name="Symfony\Bundle\FrameworkBundle\Tests\Console\Descriptor\CallableClass" priority="0"/>
</event>
</event-dispatcher>
4 changes: 2 additions & 2 deletions src/Symfony/Component/EventDispatcher/ContainerAwareEventDispatcher.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@ public function hasListeners($eventName = null)
/**
* @see EventDispatcherInterface::getListeners()
*/
public function getListeners($eventName = null)
public function getListeners($eventName = null, $withPriorities = false)
{
if (null === $eventName) {
foreach ($this->listenerIds as $serviceEventName => $args) {
Expand All @@ -128,7 +128,7 @@ public function getListeners($eventName = null)
$this->lazyLoad($eventName);
}

return parent::getListeners($eventName);
return parent::getListeners($eventName, $withPriorities);
}

/**
Expand Down
4 changes: 2 additions & 2 deletions src/Symfony/Component/EventDispatcher/Debug/TraceableEventDispatcher.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,9 +94,9 @@ public function removeSubscriber(EventSubscriberInterface $subscriber)
/**
* {@inheritdoc}
*/
public function getListeners($eventName = null)
public function getListeners($eventName = null, $withPriorities = false)
{
return $this->dispatcher->getListeners($eventName);
return $this->dispatcher->getListeners($eventName, $withPriorities);
}

/**
Expand Down
6 changes: 5 additions & 1 deletion src/Symfony/Component/EventDispatcher/EventDispatcher.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -58,8 +58,12 @@ public function dispatch($eventName, Event $event = null)
/**
* @see EventDispatcherInterface::getListeners()
*/
public function getListeners($eventName = null)
public function getListeners($eventName = null, $withPriorities = false)
{
if (true === $withPriorities) {
return $eventName ? $this->listeners[$eventName] : array_filter($this->listeners);
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this is broken when there is no listener for $eventName

}

if (null !== $eventName) {
if (!isset($this->sorted[$eventName])) {
$this->sortListeners($eventName);
Expand Down
4 changes: 2 additions & 2 deletions src/Symfony/Component/EventDispatcher/ImmutableEventDispatcher.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -78,9 +78,9 @@ public function removeSubscriber(EventSubscriberInterface $subscriber)
/**
* {@inheritdoc}
*/
public function getListeners($eventName = null)
public function getListeners($eventName = null, $withPriorities = false)
{
return $this->dispatcher->getListeners($eventName);
return $this->dispatcher->getListeners($eventName, $withPriorities);
}

/**
Expand Down
0