[EventDispatcher] Add fluid interface on dispatch()

Drak · Drak · commit 876cf9645264 · 2012-03-10T09:55:57.000+05:45
diff --git a/CHANGELOG-2.1.md b/CHANGELOG-2.1.md
@@ -182,6 +182,7 @@ To get the diff between two versions, go to https://github.com/symfony/symfony/c
 
  * added a reference to the EventDispatcher on the Event
  * added a reference to the Event name on the event
+ * added fluid interface to the dispatch() method which now returns the Event object
 
 ### Filesystem
 
diff --git a/src/Symfony/Component/EventDispatcher/EventDispatcher.php b/src/Symfony/Component/EventDispatcher/EventDispatcher.php
@@ -39,18 +39,20 @@ class EventDispatcher implements EventDispatcherInterface
      */
     public function dispatch($eventName, Event $event = null)
     {
-        if (!isset($this->listeners[$eventName])) {
-            return;
-        }
-
         if (null === $event) {
             $event = new Event();
         }
 
         $event->setDispatcher($this);
         $event->setName($eventName);
 
+        if (!isset($this->listeners[$eventName])) {
+            return $event;
+        }
+
         $this->doDispatch($this->getListeners($eventName), $eventName, $event);
+
+        return $event;
     }
 
     /**
diff --git a/src/Symfony/Component/EventDispatcher/EventDispatcherInterface.php b/src/Symfony/Component/EventDispatcher/EventDispatcherInterface.php
@@ -31,6 +31,8 @@ interface EventDispatcherInterface
      * @param Event  $event     The event to pass to the event handlers/listeners.
      *                          If not supplied, an empty Event instance is created.
      *
+     * @return Event
+     * 
      * @api
      */
     function dispatch($eventName, Event $event = null);
diff --git a/tests/Symfony/Tests/Component/EventDispatcher/EventDispatcherTest.php b/tests/Symfony/Tests/Component/EventDispatcher/EventDispatcherTest.php
@@ -110,9 +110,12 @@ public function testDispatch()
         $this->dispatcher->dispatch(self::preFoo);
         $this->assertTrue($this->listener->preFooInvoked);
         $this->assertFalse($this->listener->postFooInvoked);
+        $this->assertInstanceOf('Symfony\Component\EventDispatcher\Event', $this->dispatcher->dispatch('noevent'));
+        $this->assertInstanceOf('Symfony\Component\EventDispatcher\Event', $this->dispatcher->dispatch(self::preFoo));
         $event = new Event();
-        $this->dispatcher->dispatch(self::preFoo, $event);
+        $return = $this->dispatcher->dispatch(self::preFoo, $event);
         $this->assertEquals('pre.foo', $event->getName());
+        $this->assertSame($event, $return);
     }
 
     public function testDispatchForClosure()

Original file line number	Diff line number	Diff line change
`@@ -31,6 +31,8 @@ interface EventDispatcherInterface`
`31`	`31`	`* @param Event $event The event to pass to the event handlers/listeners.`
`32`	`32`	`* If not supplied, an empty Event instance is created.`
`33`	`33`	`*`
	`34`	`+ * @return Event`
	`35`	`+ *`
`34`	`36`	`* @api`
`35`	`37`	`*/`
`36`	`38`	`function dispatch($eventName, Event $event = null);`