[Mailer] Add types to private properties

derrabus · derrabus · commit 5cd87c0f3d98 · 2021-09-08T17:33:42.000+02:00
Signed-off-by: Alexander M. Turek &lt;me@derrabus.de&gt;
diff --git a/DataCollector/MessageDataCollector.php b/DataCollector/MessageDataCollector.php
@@ -22,7 +22,7 @@
  */
 final class MessageDataCollector extends DataCollector
 {
-    private $events;
+    private MessageEvents $events;
 
     public function __construct(MessageLoggerListener $logger)
     {
diff --git a/DelayedEnvelope.php b/DelayedEnvelope.php
@@ -23,9 +23,9 @@
  */
 final class DelayedEnvelope extends Envelope
 {
-    private $senderSet = false;
-    private $recipientsSet = false;
-    private $message;
+    private bool $senderSet = false;
+    private bool $recipientsSet = false;
+    private Message $message;
 
     public function __construct(Message $message)
     {
@@ -52,7 +52,7 @@ public function setRecipients(array $recipients): void
     {
         parent::setRecipients($recipients);
 
-        $this->recipientsSet = parent::getRecipients();
+        $this->recipientsSet = (bool) parent::getRecipients();
     }
 
     /**
diff --git a/Envelope.php b/Envelope.php
@@ -21,8 +21,8 @@
  */
 class Envelope
 {
-    private $sender;
-    private $recipients = [];
+    private Address $sender;
+    private array $recipients = [];
 
     /**
      * @param Address[] $recipients
diff --git a/Event/MessageEvent.php b/Event/MessageEvent.php
@@ -22,10 +22,10 @@
  */
 final class MessageEvent extends Event
 {
-    private $message;
-    private $envelope;
-    private $transport;
-    private $queued;
+    private RawMessage $message;
+    private Envelope $envelope;
+    private string $transport;
+    private bool $queued;
 
     public function __construct(RawMessage $message, Envelope $envelope, string $transport, bool $queued = false)
     {
diff --git a/Event/MessageEvents.php b/Event/MessageEvents.php
@@ -18,8 +18,15 @@
  */
 class MessageEvents
 {
-    private $events = [];
-    private $transports = [];
+    /**
+     * @var MessageEvent[]
+     */
+    private array $events = [];
+
+    /**
+     * @var array<string, bool>
+     */
+    private array $transports = [];
 
     public function add(MessageEvent $event): void
     {
diff --git a/EventListener/EnvelopeListener.php b/EventListener/EnvelopeListener.php
@@ -23,8 +23,12 @@
  */
 class EnvelopeListener implements EventSubscriberInterface
 {
-    private $sender;
-    private $recipients;
+    private ?Address $sender = null;
+
+    /**
+     * @var Address[]|null
+     */
+    private ?array $recipients = null;
 
     /**
      * @param array<Address|string> $recipients
diff --git a/EventListener/MessageListener.php b/EventListener/MessageListener.php
@@ -39,9 +39,9 @@ class MessageListener implements EventSubscriberInterface
         'bcc' => self::HEADER_ADD,
     ];
 
-    private $headers;
-    private $headerRules = [];
-    private $renderer;
+    private ?Headers $headers;
+    private array $headerRules = [];
+    private ?BodyRendererInterface $renderer;
 
     public function __construct(Headers $headers = null, BodyRendererInterface $renderer = null, array $headerRules = self::DEFAULT_RULES)
     {
diff --git a/EventListener/MessageLoggerListener.php b/EventListener/MessageLoggerListener.php
@@ -23,7 +23,7 @@
  */
 class MessageLoggerListener implements EventSubscriberInterface, ResetInterface
 {
-    private $events;
+    private MessageEvents $events;
 
     public function __construct()
     {
diff --git a/Exception/HttpTransportException.php b/Exception/HttpTransportException.php
@@ -18,7 +18,7 @@
  */
 class HttpTransportException extends TransportException
 {
-    private $response;
+    private ResponseInterface $response;
 
     public function __construct(string $message, ResponseInterface $response, int $code = 0, \Throwable $previous = null)
     {
diff --git a/Exception/TransportException.php b/Exception/TransportException.php
@@ -16,7 +16,7 @@
  */
 class TransportException extends RuntimeException implements TransportExceptionInterface
 {
-    private $debug = '';
+    private string $debug = '';
 
     public function getDebug(): string
     {
diff --git a/Header/MetadataHeader.php b/Header/MetadataHeader.php
@@ -18,7 +18,7 @@
  */
 final class MetadataHeader extends UnstructuredHeader
 {
-    private $key;
+    private string $key;
 
     public function __construct(string $key, string $value)
     {
diff --git a/Mailer.php b/Mailer.php
@@ -23,9 +23,9 @@
  */
 final class Mailer implements MailerInterface
 {
-    private $transport;
-    private $bus;
-    private $dispatcher;
+    private TransportInterface $transport;
+    private ?MessageBusInterface $bus;
+    private ?EventDispatcherInterface $dispatcher;
 
     public function __construct(TransportInterface $transport, MessageBusInterface $bus = null, EventDispatcherInterface $dispatcher = null)
     {
diff --git a/Messenger/MessageHandler.php b/Messenger/MessageHandler.php
@@ -19,7 +19,7 @@
  */
 class MessageHandler
 {
-    private $transport;
+    private TransportInterface $transport;
 
     public function __construct(TransportInterface $transport)
     {
diff --git a/Messenger/SendEmailMessage.php b/Messenger/SendEmailMessage.php
@@ -19,8 +19,8 @@
  */
 class SendEmailMessage
 {
-    private $message;
-    private $envelope;
+    private RawMessage $message;
+    private ?Envelope $envelope;
 
     public function __construct(RawMessage $message, Envelope $envelope = null)
     {
diff --git a/SentMessage.php b/SentMessage.php
@@ -19,11 +19,11 @@
  */
 class SentMessage
 {
-    private $original;
-    private $raw;
-    private $envelope;
-    private $messageId;
-    private $debug = '';
+    private RawMessage $original;
+    private RawMessage $raw;
+    private Envelope $envelope;
+    private string $messageId;
+    private string $debug = '';
 
     /**
      * @internal
diff --git a/Test/Constraint/EmailCount.php b/Test/Constraint/EmailCount.php
@@ -16,9 +16,9 @@
 
 final class EmailCount extends Constraint
 {
-    private $expectedValue;
-    private $transport;
-    private $queued;
+    private int $expectedValue;
+    private ?string $transport;
+    private bool $queued;
 
     public function __construct(int $expectedValue, string $transport = null, bool $queued = false)
     {
diff --git a/Transport.php b/Transport.php
@@ -54,7 +54,7 @@ final class Transport
         SesTransportFactory::class,
     ];
 
-    private $factories;
+    private iterable $factories;
 
     public static function fromDsn(string $dsn, EventDispatcherInterface $dispatcher = null, HttpClientInterface $client = null, LoggerInterface $logger = null): TransportInterface
     {
diff --git a/Transport/AbstractTransport.php b/Transport/AbstractTransport.php
@@ -25,10 +25,10 @@
  */
 abstract class AbstractTransport implements TransportInterface
 {
-    private $dispatcher;
-    private $logger;
-    private $rate = 0;
-    private $lastSent = 0;
+    private ?EventDispatcherInterface $dispatcher;
+    private LoggerInterface $logger;
+    private float $rate = 0;
+    private int $lastSent = 0;
 
     public function __construct(EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
     {
diff --git a/Transport/Dsn.php b/Transport/Dsn.php
@@ -18,12 +18,12 @@
  */
 final class Dsn
 {
-    private $scheme;
-    private $host;
-    private $user;
-    private $password;
-    private $port;
-    private $options;
+    private string $scheme;
+    private string $host;
+    private ?string $user;
+    private ?string $password;
+    private ?int $port;
+    private array $options;
 
     public function __construct(string $scheme, string $host, string $user = null, string $password = null, int $port = null, array $options = [])
     {
diff --git a/Transport/FailoverTransport.php b/Transport/FailoverTransport.php
@@ -18,7 +18,7 @@
  */
 class FailoverTransport extends RoundRobinTransport
 {
-    private $currentTransport;
+    private ?TransportInterface $currentTransport = null;
 
     protected function getNextTransport(): ?TransportInterface
     {
diff --git a/Transport/RoundRobinTransport.php b/Transport/RoundRobinTransport.php
@@ -24,10 +24,10 @@
  */
 class RoundRobinTransport implements TransportInterface
 {
-    private $deadTransports;
-    private $transports = [];
-    private $retryPeriod;
-    private $cursor = -1;
+    private \SplObjectStorage $deadTransports;
+    private array $transports = [];
+    private int $retryPeriod;
+    private int $cursor = -1;
 
     /**
      * @param TransportInterface[] $transports
diff --git a/Transport/SendmailTransport.php b/Transport/SendmailTransport.php
@@ -37,9 +37,9 @@
  */
 class SendmailTransport extends AbstractTransport
 {
-    private $command = '/usr/sbin/sendmail -bs';
-    private $stream;
-    private $transport;
+    private string $command = '/usr/sbin/sendmail -bs';
+    private ProcessStream $stream;
+    private ?SmtpTransport $transport = null;
 
     /**
      * Constructor.
diff --git a/Transport/Smtp/EsmtpTransport.php b/Transport/Smtp/EsmtpTransport.php
@@ -26,9 +26,9 @@
  */
 class EsmtpTransport extends SmtpTransport
 {
-    private $authenticators = [];
-    private $username = '';
-    private $password = '';
+    private array $authenticators = [];
+    private string $username = '';
+    private string $password = '';
 
     public function __construct(string $host = 'localhost', int $port = 0, bool $tls = null, EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
     {
diff --git a/Transport/Smtp/SmtpTransport.php b/Transport/Smtp/SmtpTransport.php
@@ -31,14 +31,14 @@
  */
 class SmtpTransport extends AbstractTransport
 {
-    private $started = false;
-    private $restartThreshold = 100;
-    private $restartThresholdSleep = 0;
-    private $restartCounter;
-    private $pingThreshold = 100;
-    private $lastMessageTime = 0;
-    private $stream;
-    private $domain = '[127.0.0.1]';
+    private bool $started = false;
+    private int $restartThreshold = 100;
+    private int $restartThresholdSleep = 0;
+    private int $restartCounter = 0;
+    private int $pingThreshold = 100;
+    private int $lastMessageTime = 0;
+    private AbstractStream $stream;
+    private string $domain = '[127.0.0.1]';
 
     public function __construct(AbstractStream $stream = null, EventDispatcherInterface $dispatcher = null, LoggerInterface $logger = null)
     {
diff --git a/Transport/Smtp/Stream/AbstractStream.php b/Transport/Smtp/Stream/AbstractStream.php
@@ -28,7 +28,7 @@ abstract class AbstractStream
     protected $in;
     protected $out;
 
-    private $debug = '';
+    private string $debug = '';
 
     public function write(string $bytes, bool $debug = true): void
     {
diff --git a/Transport/Smtp/Stream/ProcessStream.php b/Transport/Smtp/Stream/ProcessStream.php
@@ -23,7 +23,7 @@
  */
 final class ProcessStream extends AbstractStream
 {
-    private $command;
+    private string $command;
 
     public function setCommand(string $command)
     {
diff --git a/Transport/Smtp/Stream/SocketStream.php b/Transport/Smtp/Stream/SocketStream.php
@@ -23,13 +23,13 @@
  */
 final class SocketStream extends AbstractStream
 {
-    private $url;
-    private $host = 'localhost';
-    private $port = 465;
-    private $timeout;
-    private $tls = true;
-    private $sourceIp;
-    private $streamContextOptions = [];
+    private string $url;
+    private string $host = 'localhost';
+    private int $port = 465;
+    private float $timeout;
+    private bool $tls = true;
+    private ?string $sourceIp = null;
+    private array $streamContextOptions = [];
 
     public function setTimeout(float $timeout): self
     {
diff --git a/Transport/Transports.php b/Transport/Transports.php
@@ -23,19 +23,19 @@
  */
 final class Transports implements TransportInterface
 {
-    private $transports;
-    private $default;
+    /**
+     * @var array<string, TransportInterface>
+     */
+    private array $transports = [];
+    private TransportInterface $default;
 
     /**
-     * @param TransportInterface[] $transports
+     * @param iterable<string, TransportInterface> $transports
      */
     public function __construct(iterable $transports)
     {
-        $this->transports = [];
         foreach ($transports as $name => $transport) {
-            if (null === $this->default) {
-                $this->default = $transport;
-            }
+            $this->default ??= $transport;
             $this->transports[$name] = $transport;
         }
 

Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`*/`
`23`	`23`	`final class MessageDataCollector extends DataCollector`
`24`	`24`	`{`
`25`		`- private $events;`
	`25`	`+ private MessageEvents $events;`
`26`	`26`
`27`	`27`	`public function __construct(MessageLoggerListener $logger)`
`28`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -23,9 +23,9 @@`
`23`	`23`	`*/`
`24`	`24`	`final class DelayedEnvelope extends Envelope`
`25`	`25`	`{`
`26`		`- private $senderSet = false;`
`27`		`- private $recipientsSet = false;`
`28`		`- private $message;`
	`26`	`+ private bool $senderSet = false;`
	`27`	`+ private bool $recipientsSet = false;`
	`28`	`+ private Message $message;`
`29`	`29`
`30`	`30`	`public function __construct(Message $message)`
`31`	`31`	`{`
`@@ -52,7 +52,7 @@ public function setRecipients(array $recipients): void`
`52`	`52`	`{`
`53`	`53`	`parent::setRecipients($recipients);`
`54`	`54`
`55`		`- $this->recipientsSet = parent::getRecipients();`
	`55`	`+ $this->recipientsSet = (bool) parent::getRecipients();`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -22,10 +22,10 @@`
`22`	`22`	`*/`
`23`	`23`	`final class MessageEvent extends Event`
`24`	`24`	`{`
`25`		`- private $message;`
`26`		`- private $envelope;`
`27`		`- private $transport;`
`28`		`- private $queued;`
	`25`	`+ private RawMessage $message;`
	`26`	`+ private Envelope $envelope;`
	`27`	`+ private string $transport;`
	`28`	`+ private bool $queued;`
`29`	`29`
`30`	`30`	`public function __construct(RawMessage $message, Envelope $envelope, string $transport, bool $queued = false)`
`31`	`31`	`{`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@`
`23`	`23`	`*/`
`24`	`24`	`class MessageLoggerListener implements EventSubscriberInterface, ResetInterface`
`25`	`25`	`{`
`26`		`- private $events;`
	`26`	`+ private MessageEvents $events;`
`27`	`27`
`28`	`28`	`public function __construct()`
`29`	`29`	`{`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`	`*/`
`19`	`19`	`class HttpTransportException extends TransportException`
`20`	`20`	`{`
`21`		`- private $response;`
	`21`	`+ private ResponseInterface $response;`
`22`	`22`
`23`	`23`	`public function __construct(string $message, ResponseInterface $response, int $code = 0, \Throwable $previous = null)`
`24`	`24`	`{`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`*/`
`17`	`17`	`class TransportException extends RuntimeException implements TransportExceptionInterface`
`18`	`18`	`{`
`19`		`- private $debug = '';`
	`19`	`+ private string $debug = '';`
`20`	`20`
`21`	`21`	`public function getDebug(): string`
`22`	`22`	`{`