minor #33419 [Mailer] Renamed getName() to toString() (fabpot)

fabpot · fabpot · commit ef2b65aaf161 · 2019-09-02T11:58:01.000+02:00
This PR was merged into the 4.4 branch. Discussion ---------- [Mailer] Renamed getName() to toString() | Q | A | ------------- | --- | Branch? | 4.4 | Bug fix? | no | New feature? | no  | BC breaks? | no  | Deprecations? | no  | Tests pass? | yes  | Fixed tickets | n/a | License | MIT | Doc PR | n/a The `getName()` method on a Transport was introduced in 4.4. We rename it here as this method is mainly used by the profiler to display useful information about which mailer is used. This is more a string representation than a name (which is going to be introduced in the PR about multiple mailer support). Commits ------- 5b7bba9 [Mailer] Renamed getName() to toString()
diff --git a/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/MailerTest.php b/src/Symfony/Bundle/FrameworkBundle/Tests/Functional/MailerTest.php
@@ -43,7 +43,7 @@ public function __construct(EventDispatcherInterface $eventDispatcher, LoggerInt
                 $this->onDoSend = $onDoSend;
             }
 
-            public function getName(): string
+            public function __toString(): string
             {
                 return 'dummy://local';
             }
diff --git a/src/Symfony/Component/Mailer/Bridge/Amazon/Transport/SesApiTransport.php b/src/Symfony/Component/Mailer/Bridge/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);
     }
diff --git a/src/Symfony/Component/Mailer/Bridge/Amazon/Transport/SesHttpTransport.php b/src/Symfony/Component/Mailer/Bridge/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);
     }
diff --git a/src/Symfony/Component/Mailer/Bridge/Mailchimp/Transport/MandrillApiTransport.php b/src/Symfony/Component/Mailer/Bridge/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');
     }
diff --git a/src/Symfony/Component/Mailer/Bridge/Mailchimp/Transport/MandrillHttpTransport.php b/src/Symfony/Component/Mailer/Bridge/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');
     }
diff --git a/src/Symfony/Component/Mailer/Bridge/Mailgun/Transport/MailgunApiTransport.php b/src/Symfony/Component/Mailer/Bridge/Mailgun/Transport/MailgunApiTransport.php
@@ -41,7 +41,7 @@ public function __construct(string $key, string $domain, string $region = null,
         parent::__construct($client, $dispatcher, $logger);
     }
 
-    public function getName(): string
+    public function __toString(): string
     {
         return sprintf('api://%s@mailgun?region=%s', $this->domain, $this->region);
     }
diff --git a/src/Symfony/Component/Mailer/Bridge/Mailgun/Transport/MailgunHttpTransport.php b/src/Symfony/Component/Mailer/Bridge/Mailgun/Transport/MailgunHttpTransport.php
@@ -40,7 +40,7 @@ public function __construct(string $key, string $domain, string $region = null,
         parent::__construct($client, $dispatcher, $logger);
     }
 
-    public function getName(): string
+    public function __toString(): string
     {
         return sprintf('http://%s@mailgun?region=%s', $this->domain, $this->region);
     }
diff --git a/src/Symfony/Component/Mailer/Bridge/Postmark/Transport/PostmarkApiTransport.php b/src/Symfony/Component/Mailer/Bridge/Postmark/Transport/PostmarkApiTransport.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://postmark');
     }
diff --git a/src/Symfony/Component/Mailer/Bridge/Sendgrid/Tests/Transport/SendgridTransportFactoryTest.php b/src/Symfony/Component/Mailer/Bridge/Sendgrid/Tests/Transport/SendgridTransportFactoryTest.php
@@ -76,4 +76,9 @@ public function unsupportedSchemeProvider(): iterable
             'The "foo" scheme is not supported for mailer "sendgrid". Supported schemes are: "api", "smtp", "smtps".',
         ];
     }
+
+    public function incompleteDsnProvider(): iterable
+    {
+        yield [new Dsn('api', 'sendgrid')];
+    }
 }
diff --git a/src/Symfony/Component/Mailer/Bridge/Sendgrid/Transport/SendgridApiTransport.php b/src/Symfony/Component/Mailer/Bridge/Sendgrid/Transport/SendgridApiTransport.php
@@ -37,7 +37,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://sendgrid');
     }
diff --git a/src/Symfony/Component/Mailer/CHANGELOG.md b/src/Symfony/Component/Mailer/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`.
diff --git a/src/Symfony/Component/Mailer/Event/MessageEvent.php b/src/Symfony/Component/Mailer/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
diff --git a/src/Symfony/Component/Mailer/Event/MessageEvents.php b/src/Symfony/Component/Mailer/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;
             }
         }
diff --git a/src/Symfony/Component/Mailer/Mailer.php b/src/Symfony/Component/Mailer/Mailer.php
@@ -54,7 +54,7 @@ public function send(RawMessage $message, SmtpEnvelope $envelope = null): void
                     throw new TransportException('Cannot send message without a valid envelope.', 0, $e);
                 }
             }
-            $event = new MessageEvent($message, $envelope, $this->transport->getName(), true);
+            $event = new MessageEvent($message, $envelope, (string) $this->transport, true);
             $this->dispatcher->dispatch($event);
         }
 
diff --git a/src/Symfony/Component/Mailer/Test/TransportFactoryTestCase.php b/src/Symfony/Component/Mailer/Test/TransportFactoryTestCase.php
@@ -70,7 +70,7 @@ public function testCreate(Dsn $dsn, TransportInterface $transport): void
 
         $this->assertEquals($transport, $factory->create($dsn));
         if ('smtp' !== $dsn->getScheme() && 'smtps' !== $dsn->getScheme()) {
-            $this->assertStringMatchesFormat($dsn->getScheme().'://%S'.$dsn->getHost().'%S', $transport->getName());
+            $this->assertStringMatchesFormat($dsn->getScheme().'://%S'.$dsn->getHost().'%S', (string) $transport);
         }
     }
 
diff --git a/src/Symfony/Component/Mailer/Tests/Transport/FailoverTransportTest.php b/src/Symfony/Component/Mailer/Tests/Transport/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()
diff --git a/src/Symfony/Component/Mailer/Tests/Transport/NullTransportTest.php b/src/Symfony/Component/Mailer/Tests/Transport/NullTransportTest.php
@@ -16,9 +16,9 @@
 
 class NullTransportTest extends TestCase
 {
-    public function testName()
+    public function testToString()
     {
         $t = new NullTransport();
-        $this->assertEquals('smtp://null', $t->getName());
+        $this->assertEquals('smtp://null', (string) $t);
     }
 }
diff --git a/src/Symfony/Component/Mailer/Tests/Transport/RoundRobinTransportTest.php b/src/Symfony/Component/Mailer/Tests/Transport/RoundRobinTransportTest.php
@@ -28,14 +28,14 @@ public function testSendNoTransports()
         new RoundRobinTransport([]);
     }
 
-    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 RoundRobinTransport([$t1, $t2]);
-        $this->assertEquals('t1://local && t2://local', $t->getName());
+        $this->assertEquals('t1://local && t2://local', (string) $t);
     }
 
     public function testSendAlternate()
diff --git a/src/Symfony/Component/Mailer/Tests/Transport/SendmailTransportTest.php b/src/Symfony/Component/Mailer/Tests/Transport/SendmailTransportTest.php
@@ -16,9 +16,9 @@
 
 class SendmailTransportTest extends TestCase
 {
-    public function testName()
+    public function testToString()
     {
         $t = new SendmailTransport();
-        $this->assertEquals('smtp://sendmail', $t->getName());
+        $this->assertEquals('smtp://sendmail', (string) $t);
     }
 }
diff --git a/src/Symfony/Component/Mailer/Tests/Transport/Smtp/EsmtpTransportTest.php b/src/Symfony/Component/Mailer/Tests/Transport/Smtp/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);
     }
 }
diff --git a/src/Symfony/Component/Mailer/Tests/Transport/Smtp/SmtpTransportTest.php b/src/Symfony/Component/Mailer/Tests/Transport/Smtp/SmtpTransportTest.php
@@ -17,12 +17,12 @@
 
 class SmtpTransportTest extends TestCase
 {
-    public function testName()
+    public function testToString()
     {
         $t = new SmtpTransport();
-        $this->assertEquals('smtps://localhost', $t->getName());
+        $this->assertEquals('smtps://localhost', (string) $t);
 
         $t = new SmtpTransport((new SocketStream())->setHost('127.0.0.1')->setPort(2525)->disableTls());
-        $this->assertEquals('smtp://127.0.0.1:2525', $t->getName());
+        $this->assertEquals('smtp://127.0.0.1:2525', (string) $t);
     }
 }
diff --git a/src/Symfony/Component/Mailer/Tests/TransportTest.php b/src/Symfony/Component/Mailer/Tests/TransportTest.php
@@ -69,7 +69,7 @@ public function send(RawMessage $message, SmtpEnvelope $envelope = null): ?SentM
         throw new \BadMethodCallException('This method newer should be called.');
     }
 
-    public function getName(): string
+    public function __toString(): string
     {
         return sprintf('dummy://local');
     }
diff --git a/src/Symfony/Component/Mailer/Transport/AbstractTransport.php b/src/Symfony/Component/Mailer/Transport/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()) {
diff --git a/src/Symfony/Component/Mailer/Transport/NullTransport.php b/src/Symfony/Component/Mailer/Transport/NullTransport.php
@@ -24,7 +24,7 @@ protected function doSend(SentMessage $message): void
     {
     }
 
-    public function getName(): string
+    public function __toString(): string
     {
         return 'smtp://null';
     }
diff --git a/src/Symfony/Component/Mailer/Transport/RoundRobinTransport.php b/src/Symfony/Component/Mailer/Transport/RoundRobinTransport.php
@@ -56,10 +56,10 @@ public function send(RawMessage $message, SmtpEnvelope $envelope = null): ?SentM
         throw new TransportException('All transports failed.');
     }
 
-    public function getName(): string
+    public function __toString(): string
     {
         return implode(' '.$this->getNameSymbol().' ', array_map(function (TransportInterface $transport) {
-            return $transport->getName();
+            return (string) $transport;
         }, $this->transports));
     }
 
diff --git a/src/Symfony/Component/Mailer/Transport/SendmailTransport.php b/src/Symfony/Component/Mailer/Transport/SendmailTransport.php
@@ -73,10 +73,10 @@ public function send(RawMessage $message, SmtpEnvelope $envelope = null): ?SentM
         return parent::send($message, $envelope);
     }
 
-    public function getName(): string
+    public function __toString(): string
     {
         if ($this->transport) {
-            return $this->transport->getName();
+            return (string) $this->transport;
         }
 
         return 'smtp://sendmail';
diff --git a/src/Symfony/Component/Mailer/Transport/Smtp/SmtpTransport.php b/src/Symfony/Component/Mailer/Transport/Smtp/SmtpTransport.php
@@ -126,7 +126,7 @@ public function send(RawMessage $message, SmtpEnvelope $envelope = null): ?SentM
         return $message;
     }
 
-    public function getName(): string
+    public function __toString(): string
     {
         if ($this->stream instanceof SocketStream) {
             $name = sprintf('smtp%s://%s', ($tls = $this->stream->isTLS()) ? 's' : '', $this->stream->getHost());
diff --git a/src/Symfony/Component/Mailer/Transport/TransportInterface.php b/src/Symfony/Component/Mailer/Transport/TransportInterface.php
@@ -31,5 +31,5 @@ interface TransportInterface
      */
     public function send(RawMessage $message, SmtpEnvelope $envelope = null): ?SentMessage;
 
-    public function getName(): string;
+    public function __toString(): string;
 }

Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ public function __construct(EventDispatcherInterface $eventDispatcher, LoggerInt`
`43`	`43`	`$this->onDoSend = $onDoSend;`
`44`	`44`	`}`
`45`	`45`
`46`		`- public function getName(): string`
	`46`	`+ public function __toString(): string`
`47`	`47`	`{`
`48`	`48`	`return 'dummy://local';`
`49`	`49`	`}`
Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,7 @@ public function __construct(string $accessKey, string $secretKey, string $region`
`42`	`42`	`parent::__construct($client, $dispatcher, $logger);`
`43`	`43`	`}`
`44`	`44`
`45`		`- public function getName(): string`
	`45`	`+ public function __toString(): string`
`46`	`46`	`{`
`47`	`47`	`return sprintf('http://%s@ses?region=%s', $this->accessKey, $this->region);`
`48`	`48`	`}`
Original file line number	Diff line number	Diff line change
`@@ -36,7 +36,7 @@ public function __construct(string $key, HttpClientInterface $client = null, Eve`
`36`	`36`	`parent::__construct($client, $dispatcher, $logger);`
`37`	`37`	`}`
`38`	`38`
`39`		`- public function getName(): string`
	`39`	`+ public function __toString(): string`
`40`	`40`	`{`
`41`	`41`	`return sprintf('api://mandrill');`
`42`	`42`	`}`
Original file line number	Diff line number	Diff line change
`@@ -34,7 +34,7 @@ public function __construct(string $key, HttpClientInterface $client = null, Eve`
`34`	`34`	`parent::__construct($client, $dispatcher, $logger);`
`35`	`35`	`}`
`36`	`36`
`37`		`- public function getName(): string`
	`37`	`+ public function __toString(): string`
`38`	`38`	`{`
`39`	`39`	`return sprintf('http://mandrill');`
`40`	`40`	`}`
Original file line number	Diff line number	Diff line change
`@@ -41,7 +41,7 @@ public function __construct(string $key, string $domain, string $region = null,`
`41`	`41`	`parent::__construct($client, $dispatcher, $logger);`
`42`	`42`	`}`
`43`	`43`
`44`		`- public function getName(): string`
	`44`	`+ public function __toString(): string`
`45`	`45`	`{`
`46`	`46`	`return sprintf('api://%s@mailgun?region=%s', $this->domain, $this->region);`
`47`	`47`	`}`
Original file line number	Diff line number	Diff line change
`@@ -40,7 +40,7 @@ public function __construct(string $key, string $domain, string $region = null,`
`40`	`40`	`parent::__construct($client, $dispatcher, $logger);`
`41`	`41`	`}`
`42`	`42`
`43`		`- public function getName(): string`
	`43`	`+ public function __toString(): string`
`44`	`44`	`{`
`45`	`45`	`return sprintf('http://%s@mailgun?region=%s', $this->domain, $this->region);`
`46`	`46`	`}`
Original file line number	Diff line number	Diff line change
`@@ -76,4 +76,9 @@ public function unsupportedSchemeProvider(): iterable`
`76`	`76`	`'The "foo" scheme is not supported for mailer "sendgrid". Supported schemes are: "api", "smtp", "smtps".',`
`77`	`77`	`];`
`78`	`78`	`}`
	`79`	`+`
	`80`	`+ public function incompleteDsnProvider(): iterable`
	`81`	`+ {`
	`82`	`+ yield [new Dsn('api', 'sendgrid')];`
	`83`	`+ }`
`79`	`84`	`}`
Original file line number	Diff line number	Diff line change
`@@ -37,7 +37,7 @@ public function __construct(string $key, HttpClientInterface $client = null, Eve`
`37`	`37`	`parent::__construct($client, $dispatcher, $logger);`
`38`	`38`	`}`
`39`	`39`
`40`		`- public function getName(): string`
	`40`	`+ public function __toString(): string`
`41`	`41`	`{`
`42`	`42`	`return sprintf('api://sendgrid');`
`43`	`43`	`}`