[Notifier] Add types to private properties

derrabus · derrabus · commit 299d6f2ca0e4 · 2021-09-08T18:40:24.000+02:00
Signed-off-by: Alexander M. Turek &lt;me@derrabus.de&gt;
diff --git a/Channel/BrowserChannel.php b/Channel/BrowserChannel.php
@@ -20,7 +20,7 @@
  */
 final class BrowserChannel implements ChannelInterface
 {
-    private $stack;
+    private RequestStack $stack;
 
     public function __construct(RequestStack $stack)
     {
diff --git a/Channel/ChannelPolicy.php b/Channel/ChannelPolicy.php
@@ -18,7 +18,7 @@
  */
 final class ChannelPolicy implements ChannelPolicyInterface
 {
-    private $policy;
+    private array $policy;
 
     public function __construct(array $policy)
     {
diff --git a/Channel/EmailChannel.php b/Channel/EmailChannel.php
@@ -15,6 +15,7 @@
 use Symfony\Component\Mailer\Messenger\SendEmailMessage;
 use Symfony\Component\Mailer\Transport\TransportInterface;
 use Symfony\Component\Messenger\MessageBusInterface;
+use Symfony\Component\Mime\Address;
 use Symfony\Component\Mime\Email;
 use Symfony\Component\Notifier\Exception\LogicException;
 use Symfony\Component\Notifier\Message\EmailMessage;
@@ -28,10 +29,10 @@
  */
 class EmailChannel implements ChannelInterface
 {
-    private $transport;
-    private $bus;
-    private $from;
-    private $envelope;
+    private ?TransportInterface $transport;
+    private ?MessageBusInterface $bus;
+    private string|Address|null $from;
+    private ?Envelope $envelope;
 
     public function __construct(TransportInterface $transport = null, MessageBusInterface $bus = null, string $from = null, Envelope $envelope = null)
     {
@@ -41,7 +42,7 @@ public function __construct(TransportInterface $transport = null, MessageBusInte
 
         $this->transport = $transport;
         $this->bus = $bus;
-        $this->from = $from ?: ($envelope ? $envelope->getSender() : null);
+        $this->from = $from ?: $envelope?->getSender();
         $this->envelope = $envelope;
     }
 
diff --git a/Chatter.php b/Chatter.php
@@ -23,9 +23,9 @@
  */
 final class Chatter implements ChatterInterface
 {
-    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/DataCollector/NotificationDataCollector.php b/DataCollector/NotificationDataCollector.php
@@ -22,7 +22,7 @@
  */
 final class NotificationDataCollector extends DataCollector
 {
-    private $logger;
+    private NotificationLoggerListener $logger;
 
     public function __construct(NotificationLoggerListener $logger)
     {
diff --git a/Event/FailedMessageEvent.php b/Event/FailedMessageEvent.php
@@ -19,8 +19,8 @@
  */
 final class FailedMessageEvent extends Event
 {
-    private $message;
-    private $error;
+    private MessageInterface $message;
+    private \Throwable $error;
 
     public function __construct(MessageInterface $message, \Throwable $error)
     {
diff --git a/Event/MessageEvent.php b/Event/MessageEvent.php
@@ -19,8 +19,8 @@
  */
 final class MessageEvent extends Event
 {
-    private $message;
-    private $queued;
+    private MessageInterface $message;
+    private bool $queued;
 
     public function __construct(MessageInterface $message, bool $queued = false)
     {
diff --git a/Event/NotificationEvents.php b/Event/NotificationEvents.php
@@ -18,8 +18,8 @@
  */
 class NotificationEvents
 {
-    private $events = [];
-    private $transports = [];
+    private array $events = [];
+    private array $transports = [];
 
     public function add(MessageEvent $event): void
     {
diff --git a/Event/SentMessageEvent.php b/Event/SentMessageEvent.php
@@ -19,7 +19,7 @@
  */
 final class SentMessageEvent extends Event
 {
-    private $message;
+    private SentMessage $message;
 
     public function __construct(SentMessage $message)
     {
diff --git a/EventListener/NotificationLoggerListener.php b/EventListener/NotificationLoggerListener.php
@@ -21,7 +21,7 @@
  */
 class NotificationLoggerListener implements EventSubscriberInterface, ResetInterface
 {
-    private $events;
+    private NotificationEvents $events;
 
     public function __construct()
     {
diff --git a/EventListener/SendFailedMessageToNotifierListener.php b/EventListener/SendFailedMessageToNotifierListener.php
@@ -23,7 +23,7 @@
  */
 class SendFailedMessageToNotifierListener implements EventSubscriberInterface
 {
-    private $notifier;
+    private Notifier $notifier;
 
     public function __construct(Notifier $notifier)
     {
diff --git a/Exception/IncompleteDsnException.php b/Exception/IncompleteDsnException.php
@@ -16,7 +16,7 @@
  */
 class IncompleteDsnException extends InvalidArgumentException
 {
-    private $dsn;
+    private ?string $dsn;
 
     public function __construct(string $message, string $dsn = null, \Throwable $previous = null)
     {
diff --git a/Exception/TransportException.php b/Exception/TransportException.php
@@ -18,8 +18,8 @@
  */
 class TransportException extends RuntimeException implements TransportExceptionInterface
 {
-    private $response;
-    private $debug = '';
+    private ResponseInterface $response;
+    private string $debug = '';
 
     public function __construct(string $message, ResponseInterface $response, int $code = 0, \Throwable $previous = null)
     {
diff --git a/Message/ChatMessage.php b/Message/ChatMessage.php
@@ -18,10 +18,10 @@
  */
 final class ChatMessage implements MessageInterface
 {
-    private $transport;
-    private $subject;
-    private $options;
-    private $notification;
+    private ?string $transport = null;
+    private string $subject;
+    private ?MessageOptionsInterface $options;
+    private ?Notification $notification = null;
 
     public function __construct(string $subject, MessageOptionsInterface $options = null)
     {
diff --git a/Message/EmailMessage.php b/Message/EmailMessage.php
@@ -25,8 +25,8 @@
  */
 final class EmailMessage implements MessageInterface
 {
-    private $message;
-    private $envelope;
+    private RawMessage $message;
+    private ?Envelope $envelope;
 
     public function __construct(RawMessage $message, Envelope $envelope = null)
     {
diff --git a/Message/NullMessage.php b/Message/NullMessage.php
@@ -16,7 +16,7 @@
  */
 final class NullMessage implements MessageInterface
 {
-    private $decoratedMessage;
+    private MessageInterface $decoratedMessage;
 
     public function __construct(MessageInterface $message)
     {
diff --git a/Message/SentMessage.php b/Message/SentMessage.php
@@ -16,9 +16,9 @@
  */
 final class SentMessage
 {
-    private $original;
-    private $transport;
-    private $messageId;
+    private MessageInterface $original;
+    private string $transport;
+    private ?string $messageId = null;
 
     public function __construct(MessageInterface $original, string $transport)
     {
diff --git a/Message/SmsMessage.php b/Message/SmsMessage.php
@@ -20,9 +20,9 @@
  */
 final class SmsMessage implements MessageInterface
 {
-    private $transport;
-    private $subject;
-    private $phone;
+    private ?string $transport = null;
+    private string $subject;
+    private string $phone;
 
     public function __construct(string $phone, string $subject)
     {
diff --git a/Messenger/MessageHandler.php b/Messenger/MessageHandler.php
@@ -20,7 +20,7 @@
  */
 final class MessageHandler
 {
-    private $transport;
+    private TransportInterface $transport;
 
     public function __construct(TransportInterface $transport)
     {
diff --git a/Notification/Notification.php b/Notification/Notification.php
@@ -36,13 +36,13 @@ class Notification
     public const IMPORTANCE_MEDIUM = 'medium';
     public const IMPORTANCE_LOW = 'low';
 
-    private $channels = [];
-    private $subject = '';
-    private $content = '';
-    private $emoji = '';
-    private $exception;
-    private $exceptionAsString = '';
-    private $importance = self::IMPORTANCE_HIGH;
+    private array $channels = [];
+    private string $subject = '';
+    private string $content = '';
+    private string $emoji = '';
+    private ?FlattenException $exception = null;
+    private string $exceptionAsString = '';
+    private string $importance = self::IMPORTANCE_HIGH;
 
     public function __construct(string $subject = '', array $channels = [])
     {
diff --git a/Notifier.php b/Notifier.php
@@ -26,9 +26,9 @@
  */
 final class Notifier implements NotifierInterface
 {
-    private $adminRecipients = [];
-    private $channels;
-    private $policy;
+    private array $adminRecipients = [];
+    private array|ContainerInterface $channels;
+    private ?ChannelPolicyInterface $policy;
 
     /**
      * @param ChannelInterface[]|ContainerInterface $channels
diff --git a/Recipient/EmailRecipientTrait.php b/Recipient/EmailRecipientTrait.php
@@ -16,7 +16,7 @@
  */
 trait EmailRecipientTrait
 {
-    private $email;
+    private string $email;
 
     public function getEmail(): string
     {
diff --git a/Recipient/SmsRecipientTrait.php b/Recipient/SmsRecipientTrait.php
@@ -16,7 +16,7 @@
  */
 trait SmsRecipientTrait
 {
-    private $phone;
+    private string $phone;
 
     public function getPhone(): string
     {
diff --git a/Texter.php b/Texter.php
@@ -23,9 +23,9 @@
  */
 final class Texter implements TexterInterface
 {
-    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/Transport.php b/Transport.php
@@ -98,7 +98,7 @@ final class Transport
         ZulipTransportFactory::class,
     ];
 
-    private $factories;
+    private iterable $factories;
 
     public static function fromDsn(string $dsn, EventDispatcherInterface $dispatcher = null, HttpClientInterface $client = null): TransportInterface
     {
@@ -115,7 +115,7 @@ public static function fromDsns(array $dsns, EventDispatcherInterface $dispatche
     }
 
     /**
-     * @param TransportFactoryInterface[] $factories
+     * @param iterable<mixed, TransportFactoryInterface> $factories
      */
     public function __construct(iterable $factories)
     {
diff --git a/Transport/AbstractTransport.php b/Transport/AbstractTransport.php
@@ -28,7 +28,7 @@ abstract class AbstractTransport implements TransportInterface
 {
     protected const HOST = 'localhost';
 
-    private $dispatcher;
+    private ?EventDispatcherInterface $dispatcher;
 
     protected $client;
     protected $host;
diff --git a/Transport/Dsn.php b/Transport/Dsn.php
@@ -20,14 +20,14 @@
  */
 final class Dsn
 {
-    private $scheme;
-    private $host;
-    private $user;
-    private $password;
-    private $port;
-    private $path;
-    private $options;
-    private $originalDsn;
+    private string $scheme;
+    private string $host;
+    private ?string $user;
+    private ?string $password;
+    private ?int $port;
+    private ?string $path;
+    private array $options = [];
+    private string $originalDsn;
 
     public function __construct(string $dsn)
     {
diff --git a/Transport/FailoverTransport.php b/Transport/FailoverTransport.php
@@ -20,7 +20,7 @@
  */
 class FailoverTransport extends RoundRobinTransport
 {
-    private $currentTransport;
+    private ?TransportInterface $currentTransport = null;
 
     protected function getNextTransport(MessageInterface $message): ?TransportInterface
     {
diff --git a/Transport/NullTransport.php b/Transport/NullTransport.php
@@ -23,7 +23,7 @@
  */
 class NullTransport implements TransportInterface
 {
-    private $dispatcher;
+    private ?EventDispatcherInterface $dispatcher;
 
     public function __construct(EventDispatcherInterface $dispatcher = null)
     {
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/Transports.php b/Transport/Transports.php
@@ -21,14 +21,16 @@
  */
 final class Transports implements TransportInterface
 {
-    private $transports;
+    /**
+     * @var array<string, TransportInterface>
+     */
+    private array $transports = [];
 
     /**
-     * @param TransportInterface[] $transports
+     * @param iterable<string, TransportInterface> $transports
      */
     public function __construct(iterable $transports)
     {
-        $this->transports = [];
         foreach ($transports as $name => $transport) {
             $this->transports[$name] = $transport;
         }
@@ -53,7 +55,7 @@ public function supports(MessageInterface $message): bool
     public function send(MessageInterface $message): SentMessage
     {
         if (!$transport = $message->getTransport()) {
-            foreach ($this->transports as $transportName => $transport) {
+            foreach ($this->transports as $transport) {
                 if ($transport->supports($message)) {
                     return $transport->send($message);
                 }

Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`*/`
`21`	`21`	`final class BrowserChannel implements ChannelInterface`
`22`	`22`	`{`
`23`		`- private $stack;`
	`23`	`+ private RequestStack $stack;`
`24`	`24`
`25`	`25`	`public function __construct(RequestStack $stack)`
`26`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@`
`18`	`18`	`*/`
`19`	`19`	`final class ChannelPolicy implements ChannelPolicyInterface`
`20`	`20`	`{`
`21`		`- private $policy;`
	`21`	`+ private array $policy;`
`22`	`22`
`23`	`23`	`public function __construct(array $policy)`
`24`	`24`	`{`
Original file line number	Diff line number	Diff line change
`@@ -23,9 +23,9 @@`
`23`	`23`	`*/`
`24`	`24`	`final class Chatter implements ChatterInterface`
`25`	`25`	`{`
`26`		`- private $transport;`
`27`		`- private $bus;`
`28`		`- private $dispatcher;`
	`26`	`+ private TransportInterface $transport;`
	`27`	`+ private ?MessageBusInterface $bus;`
	`28`	`+ private ?EventDispatcherInterface $dispatcher;`
`29`	`29`
`30`	`30`	`public function __construct(TransportInterface $transport, MessageBusInterface $bus = null, EventDispatcherInterface $dispatcher = null)`
`31`	`31`	`{`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`*/`
`23`	`23`	`final class NotificationDataCollector extends DataCollector`
`24`	`24`	`{`
`25`		`- private $logger;`
	`25`	`+ private NotificationLoggerListener $logger;`
`26`	`26`
`27`	`27`	`public function __construct(NotificationLoggerListener $logger)`
`28`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,8 +19,8 @@`
`19`	`19`	`*/`
`20`	`20`	`final class FailedMessageEvent extends Event`
`21`	`21`	`{`
`22`		`- private $message;`
`23`		`- private $error;`
	`22`	`+ private MessageInterface $message;`
	`23`	`+ private \Throwable $error;`
`24`	`24`
`25`	`25`	`public function __construct(MessageInterface $message, \Throwable $error)`
`26`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -18,8 +18,8 @@`
`18`	`18`	`*/`
`19`	`19`	`class NotificationEvents`
`20`	`20`	`{`
`21`		`- private $events = [];`
`22`		`- private $transports = [];`
	`21`	`+ private array $events = [];`
	`22`	`+ private array $transports = [];`
`23`	`23`
`24`	`24`	`public function add(MessageEvent $event): void`
`25`	`25`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`*/`
`20`	`20`	`final class SentMessageEvent extends Event`
`21`	`21`	`{`
`22`		`- private $message;`
	`22`	`+ private SentMessage $message;`
`23`	`23`
`24`	`24`	`public function __construct(SentMessage $message)`
`25`	`25`	`{`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`*/`
`22`	`22`	`class NotificationLoggerListener implements EventSubscriberInterface, ResetInterface`
`23`	`23`	`{`
`24`		`- private $events;`
	`24`	`+ private NotificationEvents $events;`
`25`	`25`
`26`	`26`	`public function __construct()`
`27`	`27`	`{`