Merge branch '4.4'

* 4.4:
  [Mailer] Renamed getName() to toString()
  Fix the profiler panel for Mailer

Author: fabpot

AbstractTransport.php

@@ -67,7 +67,7 @@ public function send(RawMessage $message, SmtpEnvelope $envelope = null): ?SentM
             }
         }
 
-        $event = new MessageEvent($message, $envelope, $this->getName());
+        $event = new MessageEvent($message, $envelope, (string) $this);
         $this->dispatcher->dispatch($event);
         $envelope = $event->getEnvelope();
         if (!$envelope->getRecipients()) {

Amazon/Transport/SesApiTransport.php

@@ -43,7 +43,7 @@ public function __construct(string $accessKey, string $secretKey, string $region
         parent::__construct($client, $dispatcher, $logger);
     }
 
-    public function getName(): string
+    public function __toString(): string
     {
         return sprintf('api://%s@ses?region=%s', $this->accessKey, $this->region);
     }

Amazon/Transport/SesHttpTransport.php

@@ -42,7 +42,7 @@ public function __construct(string $accessKey, string $secretKey, string $region
         parent::__construct($client, $dispatcher, $logger);
     }
 
-    public function getName(): string
+    public function __toString(): string
     {
         return sprintf('http://%s@ses?region=%s', $this->accessKey, $this->region);
     }

CHANGELOG.md

@@ -11,7 +11,7 @@ CHANGELOG
  * Added PHPUnit constraints
  * Added `MessageDataCollector`
  * Added `MessageEvents` and `MessageLoggerListener` to allow collecting sent emails
- * [BC BREAK] `TransportInterface` has a new `getName()` method
+ * [BC BREAK] `TransportInterface` has a new `__toString()` method
  * [BC BREAK] Classes `AbstractApiTransport` and `AbstractHttpTransport` moved under `Transport` sub-namespace.
  * [BC BREAK] Transports depend on `Symfony\Contracts\EventDispatcher\EventDispatcherInterface`
    instead of `Symfony\Component\EventDispatcher\EventDispatcherInterface`.

EsmtpTransportTest.php

@@ -16,28 +16,28 @@
 
 class EsmtpTransportTest extends TestCase
 {
-    public function testName()
+    public function testToString()
     {
         $t = new EsmtpTransport();
-        $this->assertEquals('smtp://localhost', $t->getName());
+        $this->assertEquals('smtp://localhost', (string) $t);
 
         $t = new EsmtpTransport('example.com');
         if (\defined('OPENSSL_VERSION_NUMBER')) {
-            $this->assertEquals('smtps://example.com', $t->getName());
+            $this->assertEquals('smtps://example.com', (string) $t);
         } else {
-            $this->assertEquals('smtp://example.com', $t->getName());
+            $this->assertEquals('smtp://example.com', (string) $t);
         }
 
         $t = new EsmtpTransport('example.com', 2525);
-        $this->assertEquals('smtp://example.com:2525', $t->getName());
+        $this->assertEquals('smtp://example.com:2525', (string) $t);
 
         $t = new EsmtpTransport('example.com', 0, true);
-        $this->assertEquals('smtps://example.com', $t->getName());
+        $this->assertEquals('smtps://example.com', (string) $t);
 
         $t = new EsmtpTransport('example.com', 0, false);
-        $this->assertEquals('smtp://example.com', $t->getName());
+        $this->assertEquals('smtp://example.com', (string) $t);
 
         $t = new EsmtpTransport('example.com', 466, true);
-        $this->assertEquals('smtps://example.com:466', $t->getName());
+        $this->assertEquals('smtps://example.com:466', (string) $t);
     }
 }

Event/MessageEvent.php

@@ -24,14 +24,14 @@ final class MessageEvent extends Event
 {
     private $message;
     private $envelope;
-    private $transportName;
+    private $transport;
     private $queued;
 
-    public function __construct(RawMessage $message, SmtpEnvelope $envelope, string $transportName, bool $queued = false)
+    public function __construct(RawMessage $message, SmtpEnvelope $envelope, string $transport, bool $queued = false)
     {
         $this->message = $message;
         $this->envelope = $envelope;
-        $this->transportName = $transportName;
+        $this->transport = $transport;
         $this->queued = $queued;
     }
 
@@ -55,9 +55,9 @@ public function setEnvelope(SmtpEnvelope $envelope): void
         $this->envelope = $envelope;
     }
 
-    public function getTransportName(): string
+    public function getTransport(): string
     {
-        return $this->transportName;
+        return $this->transport;
     }
 
     public function isQueued(): bool

Event/MessageEvents.php

@@ -24,7 +24,7 @@ class MessageEvents
     public function add(MessageEvent $event): void
     {
         $this->events[] = $event;
-        $this->transports[$event->getTransportName()] = true;
+        $this->transports[$event->getTransport()] = true;
     }
 
     public function getTransports(): array
@@ -43,7 +43,7 @@ public function getEvents(string $name = null): array
 
         $events = [];
         foreach ($this->events as $event) {
-            if ($name === $event->getTransportName()) {
+            if ($name === $event->getTransport()) {
                 $events[] = $event;
             }
         }

FailoverTransportTest.php

@@ -29,14 +29,14 @@ public function testSendNoTransports()
         new FailoverTransport([]);
     }
 
-    public function testGetName()
+    public function testToString()
     {
         $t1 = $this->createMock(TransportInterface::class);
-        $t1->expects($this->once())->method('getName')->willReturn('t1://local');
+        $t1->expects($this->once())->method('__toString')->willReturn('t1://local');
         $t2 = $this->createMock(TransportInterface::class);
-        $t2->expects($this->once())->method('getName')->willReturn('t2://local');
+        $t2->expects($this->once())->method('__toString')->willReturn('t2://local');
         $t = new FailoverTransport([$t1, $t2]);
-        $this->assertEquals('t1://local || t2://local', $t->getName());
+        $this->assertEquals('t1://local || t2://local', (string) $t);
     }
 
     public function testSendFirstWork()

Mailchimp/Transport/MandrillApiTransport.php

@@ -36,7 +36,7 @@ public function __construct(string $key, HttpClientInterface $client = null, Eve
         parent::__construct($client, $dispatcher, $logger);
     }
 
-    public function getName(): string
+    public function __toString(): string
     {
         return sprintf('api://mandrill');
     }

Mailchimp/Transport/MandrillHttpTransport.php

@@ -34,7 +34,7 @@ public function __construct(string $key, HttpClientInterface $client = null, Eve
         parent::__construct($client, $dispatcher, $logger);
     }
 
-    public function getName(): string
+    public function __toString(): string
     {
         return sprintf('http://mandrill');
     }