[2.3][EventDispatcher] Moved EventDispatcher awareness to separate baseclass

src/Symfony/Component/EventDispatcher/CHANGELOG.md

@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+2.3.0
+-----
+
+ * [BC BREAK] added EventDispatcherAwareEvent: moved methods from Event object
+
 2.1.0
 -----
 
@@ -14,3 +19,4 @@ CHANGELOG
  * added the possibility for subscribers to subscribe several times for the
    same event
  * added ImmutableEventDispatcher
+

src/Symfony/Component/EventDispatcher/Event.php

@@ -24,6 +24,8 @@
  * @author  Jonathan Wage <jonwage@gmail.com>
  * @author  Roman Borschel <roman@code-factory.org>
  * @author  Bernhard Schussek <bschussek@gmail.com>
+ * @author  Jordi Boggiano <j.boggiano@seld.be>
+ * @author  Drak <drak@zikula.org>
  *
  * @api
  */
@@ -34,11 +36,6 @@ class Event
      */
     private $propagationStopped = false;
 
-    /**
-     * @var EventDispatcher Dispatcher that dispatched this event
-     */
-    private $dispatcher;
-
     /**
      * @var string This event's name
      */
@@ -71,30 +68,6 @@ public function stopPropagation()
         $this->propagationStopped = true;
     }
 
-    /**
-     * Stores the EventDispatcher that dispatches this Event
-     *
-     * @param EventDispatcherInterface $dispatcher
-     *
-     * @api
-     */
-    public function setDispatcher(EventDispatcherInterface $dispatcher)
-    {
-        $this->dispatcher = $dispatcher;
-    }
-
-    /**
-     * Returns the EventDispatcher that dispatches this Event
-     *
-     * @return EventDispatcherInterface
-     *
-     * @api
-     */
-    public function getDispatcher()
-    {
-        return $this->dispatcher;
-    }
-
     /**
      * Gets the event's name.
      *

src/Symfony/Component/EventDispatcher/EventDispatcher.php

@@ -43,7 +43,9 @@ public function dispatch($eventName, Event $event = null)
             $event = new Event();
         }
 
-        $event->setDispatcher($this);
+        if ($event instanceof EventDispatcherAwareEvent) {
+            $event->setDispatcher($this);
+        }
         $event->setName($eventName);
 
         if (!isset($this->listeners[$eventName])) {

src/Symfony/Component/EventDispatcher/EventDispatcherAwareEvent.php

@@ -0,0 +1,57 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\EventDispatcher;
+
+/**
+ * Event is the base class for classes containing event data.
+ *
+ * This class contains no event data. It is used by events that do not pass
+ * state information to an event handler when an event is raised.
+ *
+ * You can call the method stopPropagation() to abort the execution of
+ * further listeners in your event listener.
+ *
+ * @author Jordi Boggiano <j.boggiano@seld.be>
+ *
+ * @api
+ */
+class EventDispatcherAwareEvent extends Event
+{
+    /**
+     * @var EventDispatcher Dispatcher that dispatched this event
+     */
+    private $dispatcher;
+
+    /**
+     * Stores the EventDispatcher that dispatches this Event
+     *
+     * @param EventDispatcherInterface $dispatcher
+     *
+     * @api
+     */
+    public function setDispatcher(EventDispatcherInterface $dispatcher)
+    {
+        $this->dispatcher = $dispatcher;
+    }
+
+    /**
+     * Returns the EventDispatcher that dispatches this Event
+     *
+     * @return EventDispatcherInterface
+     *
+     * @api
+     */
+    public function getDispatcher()
+    {
+        return $this->dispatcher;
+    }
+}

src/Symfony/Component/EventDispatcher/Tests/ContainerAwareEventDispatcherTest.php

@@ -164,7 +164,6 @@ public function testHasListenersOnLazyLoad()
         $dispatcher = new ContainerAwareEventDispatcher($container);
         $dispatcher->addListenerService('onEvent', array('service.listener', 'onEvent'));
 
-        $event->setDispatcher($dispatcher);
         $event->setName('onEvent');
 
         $service

src/Symfony/Component/EventDispatcher/Tests/EventDispatcherAwareEventTest.php

@@ -0,0 +1,62 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Component\EventDispatcher\Tests;
+
+use Symfony\Component\EventDispatcher\EventDispatcherAwareEvent;
+use Symfony\Component\EventDispatcher\EventDispatcher;
+
+/**
+ * Test class for EventDispatcherAwareEvent.
+ */
+class EventDispatcherAwareEventTest extends \PHPUnit_Framework_TestCase
+{
+    /**
+     * @var \Symfony\Component\EventDispatcher\EventDispatcherAwareEvent
+     */
+    protected $event;
+
+    /**
+     * @var \Symfony\Component\EventDispatcher\EventDispatcher
+     */
+    protected $dispatcher;
+
+    /**
+     * Sets up the fixture, for example, opens a network connection.
+     * This method is called before a test is executed.
+     */
+    protected function setUp()
+    {
+        $this->event = new EventDispatcherAwareEvent;
+        $this->dispatcher = new EventDispatcher();
+    }
+
+    /**
+     * Tears down the fixture, for example, closes a network connection.
+     * This method is called after a test is executed.
+     */
+    protected function tearDown()
+    {
+        $this->event = null;
+        $this->dispatcher = null;
+    }
+
+    public function testSetDispatcher()
+    {
+        $this->event->setDispatcher($this->dispatcher);
+        $this->assertSame($this->dispatcher, $this->event->getDispatcher());
+    }
+
+    public function testGetDispatcher()
+    {
+        $this->assertNull($this->event->getDispatcher());
+    }
+}

src/Symfony/Component/EventDispatcher/Tests/EventDispatcherTest.php

@@ -12,6 +12,7 @@
 namespace Symfony\Component\EventDispatcher\Tests;
 
 use Symfony\Component\EventDispatcher\Event;
+use Symfony\Component\EventDispatcher\EventDispatcherAwareEvent;
 use Symfony\Component\EventDispatcher\EventDispatcher;
 use Symfony\Component\EventDispatcher\EventSubscriberInterface;
 
@@ -237,14 +238,23 @@ public function testRemoveSubscriberWithMultipleListeners()
 
     public function testEventReceivesTheDispatcherInstance()
     {
-        $test = $this;
+        $event = new EventDispatcherAwareEvent();
         $this->dispatcher->addListener('test', function ($event) use (&$dispatcher) {
             $dispatcher = $event->getDispatcher();
         });
-        $this->dispatcher->dispatch('test');
+        $this->dispatcher->dispatch('test', $event);
         $this->assertSame($this->dispatcher, $dispatcher);
     }
 
+    public function testEventDoesNotReceiveTheDispatcherInstance()
+    {
+        $this->dispatcher->addListener('test', function ($event) use (&$dispatcher) {
+            $dispatcher = method_exists($event, 'getDispatcher') ? $event->getDispatcher() : null;
+        });
+        $this->dispatcher->dispatch('test');
+        $this->assertNull($dispatcher);
+    }
+
     /**
      * @see https://bugs.php.net/bug.php?id=62976
      *

src/Symfony/Component/EventDispatcher/Tests/EventTest.php

@@ -46,7 +46,7 @@ protected function setUp()
     protected function tearDown()
     {
         $this->event = null;
-        $this->eventDispatcher = null;
+        $this->dispatcher = null;
     }
 
     public function testIsPropagationStopped()
@@ -60,17 +60,6 @@ public function testStopPropagationAndIsPropagationStopped()
         $this->assertTrue($this->event->isPropagationStopped());
     }
 
-    public function testSetDispatcher()
-    {
-        $this->event->setDispatcher($this->dispatcher);
-        $this->assertSame($this->dispatcher, $this->event->getDispatcher());
-    }
-
-    public function testGetDispatcher()
-    {
-        $this->assertNull($this->event->getDispatcher());
-    }
-
     public function testGetName()
     {
         $this->assertNull($this->event->getName());