[EventDispatcher] Added possibility for subscribers to subscribe several times for same event

jalliot · jalliot · commit 5146a1f0d027 · 2011-09-16T18:13:00.000+01:00
closes #2146
diff --git a/src/Symfony/Component/EventDispatcher/EventDispatcher.php b/src/Symfony/Component/EventDispatcher/EventDispatcher.php
@@ -23,6 +23,7 @@
  * @author  Bernhard Schussek <bschussek@gmail.com>
  * @author  Fabien Potencier <fabien@symfony.com>
  * @author  Jordi Boggiano <j.boggiano@seld.be>
+ * @author  Jordan Alliot <jordan.alliot@gmail.com>
  *
  * @api
  */
@@ -116,8 +117,12 @@ public function addSubscriber(EventSubscriberInterface $subscriber)
         foreach ($subscriber->getSubscribedEvents() as $eventName => $params) {
             if (is_string($params)) {
                 $this->addListener($eventName, array($subscriber, $params));
-            } else {
+            } elseif (is_string($params[0])) {
                 $this->addListener($eventName, array($subscriber, $params[0]), $params[1]);
+            } else {
+                foreach ($params as $listener) {
+                    $this->addListener($eventName, array($subscriber, $listener[0]), isset($listener[1]) ? $listener[1] : 0);
+                }
             }
         }
     }
@@ -128,7 +133,13 @@ public function addSubscriber(EventSubscriberInterface $subscriber)
     public function removeSubscriber(EventSubscriberInterface $subscriber)
     {
         foreach ($subscriber->getSubscribedEvents() as $eventName => $params) {
-            $this->removeListener($eventName, array($subscriber, is_string($params) ? $params : $params[0]));
+            if (is_array($params) && is_array($params[0])) {
+                foreach ($params as $listener) {
+                    $this->removeListener($eventName, array($subscriber, $listener[0]));
+                }
+            } else {
+                $this->removeListener($eventName, array($subscriber, is_string($params) ? $params : $params[0]));
+            }
         }
     }
 
diff --git a/src/Symfony/Component/EventDispatcher/EventSubscriberInterface.php b/src/Symfony/Component/EventDispatcher/EventSubscriberInterface.php
@@ -35,11 +35,14 @@ interface EventSubscriberInterface
      *
      *  * The method name to call (priority defaults to 0)
      *  * An array composed of the method name to call and the priority
+     *  * An array of arrays composed of the method names to call and respective
+     *    priorities, or 0 if unset
      *
      * For instance:
      *
      *  * array('eventName' => 'methodName')
      *  * array('eventName' => array('methodName', $priority))
+     *  * array('eventName' => array(array('methodName1', $priority), array('methodName2'))
      *
      * @return array The event names to listen to
      *
diff --git a/tests/Symfony/Tests/Component/EventDispatcher/EventDispatcherTest.php b/tests/Symfony/Tests/Component/EventDispatcher/EventDispatcherTest.php
@@ -188,6 +188,17 @@ public function testAddSubscriberWithPriorities()
         $this->assertInstanceOf('Symfony\Tests\Component\EventDispatcher\TestEventSubscriberWithPriorities', $listeners[0][0]);
     }
 
+    public function testAddSubscriberWithMultipleListeners()
+    {
+        $eventSubscriber = new TestEventSubscriberWithMultipleListeners();
+        $this->dispatcher->addSubscriber($eventSubscriber);
+
+        $listeners = $this->dispatcher->getListeners('pre.foo');
+        $this->assertTrue($this->dispatcher->hasListeners(self::preFoo));
+        $this->assertEquals(2, count($listeners));
+        $this->assertEquals('preFoo2', $listeners[0][1]);
+    }
+
     public function testRemoveSubscriber()
     {
         $eventSubscriber = new TestEventSubscriber();
@@ -207,6 +218,16 @@ public function testRemoveSubscriberWithPriorities()
         $this->dispatcher->removeSubscriber($eventSubscriber);
         $this->assertFalse($this->dispatcher->hasListeners(self::preFoo));
     }
+
+    public function testRemoveSubscriberWithMultipleListeners()
+    {
+        $eventSubscriber = new TestEventSubscriberWithMultipleListeners();
+        $this->dispatcher->addSubscriber($eventSubscriber);
+        $this->assertTrue($this->dispatcher->hasListeners(self::preFoo));
+        $this->assertEquals(2, count($this->dispatcher->getListeners(self::preFoo)));
+        $this->dispatcher->removeSubscriber($eventSubscriber);
+        $this->assertFalse($this->dispatcher->hasListeners(self::preFoo));
+    }
 }
 
 class TestEventListener
@@ -244,3 +265,14 @@ public static function getSubscribedEvents()
         return array('pre.foo' => array('preFoo', 10));
     }
 }
+
+class TestEventSubscriberWithMultipleListeners implements EventSubscriberInterface
+{
+    public static function getSubscribedEvents()
+    {
+        return array('pre.foo' => array(
+            array('preFoo1'),
+            array('preFoo2', 10)
+        ));
+    }
+}

Original file line number	Diff line number	Diff line change
`@@ -23,6 +23,7 @@`
`23`	`23`	`* @author Bernhard Schussek <[email protected]>`
`24`	`24`	`* @author Fabien Potencier <[email protected]>`
`25`	`25`	`* @author Jordi Boggiano <[email protected]>`
	`26`	`+ * @author Jordan Alliot <[email protected]>`
`26`	`27`	`*`
`27`	`28`	`* @api`
`28`	`29`	`*/`
`@@ -116,8 +117,12 @@ public function addSubscriber(EventSubscriberInterface $subscriber)`
`116`	`117`	`foreach ($subscriber->getSubscribedEvents() as $eventName => $params) {`
`117`	`118`	`if (is_string($params)) {`
`118`	`119`	`$this->addListener($eventName, array($subscriber, $params));`
`119`		`- } else {`
	`120`	`+ } elseif (is_string($params[0])) {`
`120`	`121`	`$this->addListener($eventName, array($subscriber, $params[0]), $params[1]);`
	`122`	`+ } else {`
	`123`	`+ foreach ($params as $listener) {`
	`124`	`+ $this->addListener($eventName, array($subscriber, $listener[0]), isset($listener[1]) ? $listener[1] : 0);`
	`125`	`+ }`
`121`	`126`	`}`
`122`	`127`	`}`
`123`	`128`	`}`
`@@ -128,7 +133,13 @@ public function addSubscriber(EventSubscriberInterface $subscriber)`
`128`	`133`	`public function removeSubscriber(EventSubscriberInterface $subscriber)`
`129`	`134`	`{`
`130`	`135`	`foreach ($subscriber->getSubscribedEvents() as $eventName => $params) {`
`131`		`- $this->removeListener($eventName, array($subscriber, is_string($params) ? $params : $params[0]));`
	`136`	`+ if (is_array($params) && is_array($params[0])) {`
	`137`	`+ foreach ($params as $listener) {`
	`138`	`+ $this->removeListener($eventName, array($subscriber, $listener[0]));`
	`139`	`+ }`
	`140`	`+ } else {`
	`141`	`+ $this->removeListener($eventName, array($subscriber, is_string($params) ? $params : $params[0]));`
	`142`	`+ }`
`132`	`143`	`}`
`133`	`144`	`}`
`134`	`145`
Original file line number	Diff line number	Diff line change
`@@ -35,11 +35,14 @@ interface EventSubscriberInterface`
`35`	`35`	`*`
`36`	`36`	`* * The method name to call (priority defaults to 0)`
`37`	`37`	`* * An array composed of the method name to call and the priority`
	`38`	`+ * * An array of arrays composed of the method names to call and respective`
	`39`	`+ * priorities, or 0 if unset`
`38`	`40`	`*`
`39`	`41`	`* For instance:`
`40`	`42`	`*`
`41`	`43`	`* * array('eventName' => 'methodName')`
`42`	`44`	`* * array('eventName' => array('methodName', $priority))`
	`45`	`+ * * array('eventName' => array(array('methodName1', $priority), array('methodName2'))`
`43`	`46`	`*`
`44`	`47`	`* @return array The event names to listen to`
`45`	`48`	`*`