[EventDispatcher] Deprecate LegacyEventDispatcherProxy.

derrabus · derrabus · commit c7e612d4add4 · 2019-12-15T23:54:05.000+01:00
diff --git a/UPGRADE-5.1.md b/UPGRADE-5.1.md
@@ -1,6 +1,11 @@
 UPGRADE FROM 5.0 to 5.1
 =======================
 
+EventDispatcher
+---------------
+
+ * Deprecated `LegacyEventDispatcherProxy`. Use the event dispatcher without the proxy.
+
 FrameworkBundle
 ---------------
 
diff --git a/UPGRADE-6.0.md b/UPGRADE-6.0.md
@@ -1,6 +1,11 @@
 UPGRADE FROM 5.x to 6.0
 =======================
 
+EventDispatcher
+---------------
+
+ * Removed `LegacyEventDispatcherProxy`. Use the event dispatcher without the proxy.
+
 FrameworkBundle
 ---------------
 
diff --git a/src/Symfony/Component/EventDispatcher/CHANGELOG.md b/src/Symfony/Component/EventDispatcher/CHANGELOG.md
@@ -1,6 +1,11 @@
 CHANGELOG
 =========
 
+5.1.0
+-----
+
+ * The `LegacyEventDispatcherProxy` class has been deprecated.
+
 5.0.0
 -----
 
diff --git a/src/Symfony/Component/EventDispatcher/LegacyEventDispatcherProxy.php b/src/Symfony/Component/EventDispatcher/LegacyEventDispatcherProxy.php
@@ -13,12 +13,14 @@
 
 use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 
+@trigger_error(sprintf('%s is deprecated since Symfony 5.1, use the event dispatcher without the proxy.', LegacyEventDispatcherProxy::class), E_USER_DEPRECATED);
+
 /**
  * A helper class to provide BC/FC with the legacy signature of EventDispatcherInterface::dispatch().
  *
- * This class should be deprecated in Symfony 5.1
- *
  * @author Nicolas Grekas <p@tchwork.com>
+ *
+ * @deprecated since Symfony 5.1.
  */
 final class LegacyEventDispatcherProxy
 {
diff --git a/src/Symfony/Component/Mailer/Mailer.php b/src/Symfony/Component/Mailer/Mailer.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Mailer;
 
+use Symfony\Component\EventDispatcher\Event;
 use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;
 use Symfony\Component\Mailer\Event\MessageEvent;
 use Symfony\Component\Mailer\Messenger\SendEmailMessage;
@@ -32,7 +33,7 @@ public function __construct(TransportInterface $transport, MessageBusInterface $
     {
         $this->transport = $transport;
         $this->bus = $bus;
-        $this->dispatcher = LegacyEventDispatcherProxy::decorate($dispatcher);
+        $this->dispatcher = class_exists(Event::class) ? LegacyEventDispatcherProxy::decorate($dispatcher) : $dispatcher;
     }
 
     public function send(RawMessage $message, Envelope $envelope = null): void
diff --git a/src/Symfony/Component/Mailer/Transport/AbstractTransport.php b/src/Symfony/Component/Mailer/Transport/AbstractTransport.php
@@ -13,6 +13,7 @@
 
 use Psr\Log\LoggerInterface;
 use Psr\Log\NullLogger;
+use Symfony\Component\EventDispatcher\Event;
 use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;
 use Symfony\Component\Mailer\Envelope;
 use Symfony\Component\Mailer\Event\MessageEvent;
@@ -33,7 +34,7 @@ abstract class AbstractTransport implements TransportInterface
 
     public function __construct(EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
     {
-        $this->dispatcher = LegacyEventDispatcherProxy::decorate($dispatcher);
+        $this->dispatcher = class_exists(Event::class) ? LegacyEventDispatcherProxy::decorate($dispatcher) : $dispatcher;
         $this->logger = $logger ?: new NullLogger();
     }
 
diff --git a/src/Symfony/Component/Messenger/Middleware/SendMessageMiddleware.php b/src/Symfony/Component/Messenger/Middleware/SendMessageMiddleware.php
@@ -13,6 +13,7 @@
 
 use Psr\Log\LoggerAwareTrait;
 use Psr\Log\NullLogger;
+use Symfony\Component\EventDispatcher\Event;
 use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;
 use Symfony\Component\Messenger\Envelope;
 use Symfony\Component\Messenger\Event\SendMessageToTransportsEvent;
@@ -35,13 +36,7 @@ class SendMessageMiddleware implements MiddlewareInterface
     public function __construct(SendersLocatorInterface $sendersLocator, EventDispatcherInterface $eventDispatcher = null)
     {
         $this->sendersLocator = $sendersLocator;
-
-        if (null !== $eventDispatcher && class_exists(LegacyEventDispatcherProxy::class)) {
-            $this->eventDispatcher = LegacyEventDispatcherProxy::decorate($eventDispatcher);
-        } else {
-            $this->eventDispatcher = $eventDispatcher;
-        }
-
+        $this->eventDispatcher = class_exists(Event::class) ? LegacyEventDispatcherProxy::decorate($eventDispatcher) : $eventDispatcher;
         $this->logger = new NullLogger();
     }
 
diff --git a/src/Symfony/Component/Messenger/Worker.php b/src/Symfony/Component/Messenger/Worker.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Messenger;
 
 use Psr\Log\LoggerInterface;
+use Symfony\Component\EventDispatcher\Event;
 use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;
 use Symfony\Component\Messenger\Event\WorkerMessageFailedEvent;
 use Symfony\Component\Messenger\Event\WorkerMessageHandledEvent;
@@ -48,12 +49,7 @@ public function __construct(array $receivers, MessageBusInterface $bus, EventDis
         $this->receivers = $receivers;
         $this->bus = $bus;
         $this->logger = $logger;
-
-        if (null !== $eventDispatcher && class_exists(LegacyEventDispatcherProxy::class)) {
-            $this->eventDispatcher = LegacyEventDispatcherProxy::decorate($eventDispatcher);
-        } else {
-            $this->eventDispatcher = $eventDispatcher;
-        }
+        $this->eventDispatcher = class_exists(Event::class) ? LegacyEventDispatcherProxy::decorate($eventDispatcher) : $eventDispatcher;
     }
 
     /**
diff --git a/src/Symfony/Component/Notifier/Chatter.php b/src/Symfony/Component/Notifier/Chatter.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Notifier;
 
+use Symfony\Component\EventDispatcher\Event;
 use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;
 use Symfony\Component\Messenger\MessageBusInterface;
 use Symfony\Component\Notifier\Event\MessageEvent;
@@ -33,7 +34,7 @@ public function __construct(TransportInterface $transport, MessageBusInterface $
     {
         $this->transport = $transport;
         $this->bus = $bus;
-        $this->dispatcher = LegacyEventDispatcherProxy::decorate($dispatcher);
+        $this->dispatcher = class_exists(Event::class) ? LegacyEventDispatcherProxy::decorate($dispatcher) : $dispatcher;
     }
 
     public function __toString(): string
diff --git a/src/Symfony/Component/Notifier/Texter.php b/src/Symfony/Component/Notifier/Texter.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Notifier;
 
+use Symfony\Component\EventDispatcher\Event;
 use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;
 use Symfony\Component\Messenger\MessageBusInterface;
 use Symfony\Component\Notifier\Event\MessageEvent;
@@ -33,7 +34,7 @@ public function __construct(TransportInterface $transport, MessageBusInterface $
     {
         $this->transport = $transport;
         $this->bus = $bus;
-        $this->dispatcher = LegacyEventDispatcherProxy::decorate($dispatcher);
+        $this->dispatcher = class_exists(Event::class) ? LegacyEventDispatcherProxy::decorate($dispatcher) : $dispatcher;
     }
 
     public function __toString(): string
diff --git a/src/Symfony/Component/Notifier/Transport/AbstractTransport.php b/src/Symfony/Component/Notifier/Transport/AbstractTransport.php
@@ -11,6 +11,7 @@
 
 namespace Symfony\Component\Notifier\Transport;
 
+use Symfony\Component\EventDispatcher\Event;
 use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;
 use Symfony\Component\HttpClient\HttpClient;
 use Symfony\Component\Notifier\Event\MessageEvent;
@@ -45,7 +46,7 @@ public function __construct(HttpClientInterface $client = null, EventDispatcherI
             $this->client = HttpClient::create();
         }
 
-        $this->dispatcher = LegacyEventDispatcherProxy::decorate($dispatcher);
+        $this->dispatcher = class_exists(Event::class) ? LegacyEventDispatcherProxy::decorate($dispatcher) : $dispatcher;
     }
 
     /**
diff --git a/src/Symfony/Component/Notifier/Transport/AbstractTransportFactory.php b/src/Symfony/Component/Notifier/Transport/AbstractTransportFactory.php
@@ -11,14 +11,14 @@
 
 namespace Symfony\Component\Notifier\Transport;
 
+use Symfony\Component\EventDispatcher\Event;
 use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;
 use Symfony\Component\Notifier\Exception\IncompleteDsnException;
 use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
 use Symfony\Contracts\HttpClient\HttpClientInterface;
 
 /**
  * @author Konstantin Myakshin <molodchick@gmail.com>
- *
  * @author Fabien Potencier <fabien@symfony.com>
  *
  * @experimental in 5.0
@@ -30,7 +30,7 @@ abstract class AbstractTransportFactory implements TransportFactoryInterface
 
     public function __construct(EventDispatcherInterface $dispatcher = null, HttpClientInterface $client = null)
     {
-        $this->dispatcher = LegacyEventDispatcherProxy::decorate($dispatcher);
+        $this->dispatcher = class_exists(Event::class) ? LegacyEventDispatcherProxy::decorate($dispatcher) : $dispatcher;
         $this->client = $client;
     }
 
diff --git a/src/Symfony/Component/Security/Http/Firewall/ContextListener.php b/src/Symfony/Component/Security/Http/Firewall/ContextListener.php
@@ -12,6 +12,7 @@
 namespace Symfony\Component\Security\Http\Firewall;
 
 use Psr\Log\LoggerInterface;
+use Symfony\Component\EventDispatcher\Event;
 use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;
 use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpFoundation\Session\Session;
@@ -66,12 +67,7 @@ public function __construct(TokenStorageInterface $tokenStorage, iterable $userP
         $this->userProviders = $userProviders;
         $this->sessionKey = '_security_'.$contextKey;
         $this->logger = $logger;
-
-        if (null !== $dispatcher && class_exists(LegacyEventDispatcherProxy::class)) {
-            $this->dispatcher = LegacyEventDispatcherProxy::decorate($dispatcher);
-        } else {
-            $this->dispatcher = $dispatcher;
-        }
+        $this->dispatcher = class_exists(Event::class) ? LegacyEventDispatcherProxy::decorate($dispatcher) : $dispatcher;
 
         $this->trustResolver = $trustResolver ?: new AuthenticationTrustResolver(AnonymousToken::class, RememberMeToken::class);
         $this->sessionTrackerEnabler = $sessionTrackerEnabler;
diff --git a/src/Symfony/Component/Security/Http/composer.json b/src/Symfony/Component/Security/Http/composer.json
@@ -28,6 +28,7 @@
         "psr/log": "~1.0"
     },
     "conflict": {
+        "symfony/event-dispatcher": "<4.3",
         "symfony/security-csrf": "<4.4"
     },
     "suggest": {

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,7 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Component\Mailer;`
`13`	`13`
	`14`	`+use Symfony\Component\EventDispatcher\Event;`
`14`	`15`	`use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;`
`15`	`16`	`use Symfony\Component\Mailer\Event\MessageEvent;`
`16`	`17`	`use Symfony\Component\Mailer\Messenger\SendEmailMessage;`
`@@ -32,7 +33,7 @@ public function __construct(TransportInterface $transport, MessageBusInterface $`
`32`	`33`	`{`
`33`	`34`	`$this->transport = $transport;`
`34`	`35`	`$this->bus = $bus;`
`35`		`- $this->dispatcher = LegacyEventDispatcherProxy::decorate($dispatcher);`
	`36`	`+ $this->dispatcher = class_exists(Event::class) ? LegacyEventDispatcherProxy::decorate($dispatcher) : $dispatcher;`
`36`	`37`	`}`
`37`	`38`
`38`	`39`	`public function send(RawMessage $message, Envelope $envelope = null): void`
Original file line number	Diff line number	Diff line change
`@@ -13,6 +13,7 @@`
`13`	`13`
`14`	`14`	`use Psr\Log\LoggerInterface;`
`15`	`15`	`use Psr\Log\NullLogger;`
	`16`	`+use Symfony\Component\EventDispatcher\Event;`
`16`	`17`	`use Symfony\Component\EventDispatcher\LegacyEventDispatcherProxy;`
`17`	`18`	`use Symfony\Component\Mailer\Envelope;`
`18`	`19`	`use Symfony\Component\Mailer\Event\MessageEvent;`
`@@ -33,7 +34,7 @@ abstract class AbstractTransport implements TransportInterface`
`33`	`34`
`34`	`35`	`public function __construct(EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)`
`35`	`36`	`{`
`36`		`- $this->dispatcher = LegacyEventDispatcherProxy::decorate($dispatcher);`
	`37`	`+ $this->dispatcher = class_exists(Event::class) ? LegacyEventDispatcherProxy::decorate($dispatcher) : $dispatcher;`
`37`	`38`	`$this->logger = $logger ?: new NullLogger();`
`38`	`39`	`}`
`39`	`40`