use constructor property promotion

xabbuh · xabbuh · commit cb08cb2db5ab · 2024-05-29T11:56:37.000+02:00
diff --git a/DelayedEnvelope.php b/DelayedEnvelope.php
@@ -25,11 +25,10 @@ final class DelayedEnvelope extends Envelope
 {
     private bool $senderSet = false;
     private bool $recipientsSet = false;
-    private Message $message;
 
-    public function __construct(Message $message)
-    {
-        $this->message = $message;
+    public function __construct(
+        private Message $message,
+    ) {
     }
 
     public function setSender(Address $sender): void
diff --git a/Event/MessageEvent.php b/Event/MessageEvent.php
@@ -24,21 +24,17 @@
  */
 final class MessageEvent extends Event
 {
-    private RawMessage $message;
-    private Envelope $envelope;
-    private string $transport;
-    private bool $queued;
     private bool $rejected = false;
 
     /** @var StampInterface[] */
     private array $stamps = [];
 
-    public function __construct(RawMessage $message, Envelope $envelope, string $transport, bool $queued = false)
-    {
-        $this->message = $message;
-        $this->envelope = $envelope;
-        $this->transport = $transport;
-        $this->queued = $queued;
+    public function __construct(
+        private RawMessage $message,
+        private Envelope $envelope,
+        private string $transport,
+        private bool $queued = false,
+    ) {
     }
 
     public function getMessage(): RawMessage
diff --git a/EventListener/MessageListener.php b/EventListener/MessageListener.php
@@ -39,14 +39,13 @@ class MessageListener implements EventSubscriberInterface
         'bcc' => self::HEADER_ADD,
     ];
 
-    private ?Headers $headers;
     private array $headerRules = [];
-    private ?BodyRendererInterface $renderer;
 
-    public function __construct(?Headers $headers = null, ?BodyRendererInterface $renderer = null, array $headerRules = self::DEFAULT_RULES)
-    {
-        $this->headers = $headers;
-        $this->renderer = $renderer;
+    public function __construct(
+        private ?Headers $headers = null,
+        private ?BodyRendererInterface $renderer = null,
+        array $headerRules = self::DEFAULT_RULES,
+    ) {
         foreach ($headerRules as $headerName => $rule) {
             $this->addHeaderRule($headerName, $rule);
         }
diff --git a/Exception/HttpTransportException.php b/Exception/HttpTransportException.php
@@ -18,13 +18,13 @@
  */
 class HttpTransportException extends TransportException
 {
-    private ResponseInterface $response;
-
-    public function __construct(string $message, ResponseInterface $response, int $code = 0, ?\Throwable $previous = null)
-    {
+    public function __construct(
+        string $message,
+        private ResponseInterface $response,
+        int $code = 0,
+        ?\Throwable $previous = null,
+    ) {
         parent::__construct($message, $code, $previous);
-
-        $this->response = $response;
     }
 
     public function getResponse(): ResponseInterface
diff --git a/Header/MetadataHeader.php b/Header/MetadataHeader.php
@@ -18,12 +18,10 @@
  */
 final class MetadataHeader extends UnstructuredHeader
 {
-    private string $key;
-
-    public function __construct(string $key, string $value)
-    {
-        $this->key = $key;
-
+    public function __construct(
+        private string $key,
+        string $value,
+    ) {
         parent::__construct('X-Metadata-'.$key, $value);
     }
 
diff --git a/Mailer.php b/Mailer.php
@@ -25,15 +25,11 @@
  */
 final class Mailer implements MailerInterface
 {
-    private TransportInterface $transport;
-    private ?MessageBusInterface $bus;
-    private ?EventDispatcherInterface $dispatcher;
-
-    public function __construct(TransportInterface $transport, ?MessageBusInterface $bus = null, ?EventDispatcherInterface $dispatcher = null)
-    {
-        $this->transport = $transport;
-        $this->bus = $bus;
-        $this->dispatcher = $dispatcher;
+    public function __construct(
+        private TransportInterface $transport,
+        private ?MessageBusInterface $bus = null,
+        private ?EventDispatcherInterface $dispatcher = null,
+    ) {
     }
 
     public function send(RawMessage $message, ?Envelope $envelope = null): void
diff --git a/Messenger/MessageHandler.php b/Messenger/MessageHandler.php
@@ -19,11 +19,9 @@
  */
 class MessageHandler
 {
-    private TransportInterface $transport;
-
-    public function __construct(TransportInterface $transport)
-    {
-        $this->transport = $transport;
+    public function __construct(
+        private TransportInterface $transport,
+    ) {
     }
 
     public function __invoke(SendEmailMessage $message): ?SentMessage
diff --git a/Messenger/SendEmailMessage.php b/Messenger/SendEmailMessage.php
@@ -19,13 +19,10 @@
  */
 class SendEmailMessage
 {
-    private RawMessage $message;
-    private ?Envelope $envelope;
-
-    public function __construct(RawMessage $message, ?Envelope $envelope = null)
-    {
-        $this->message = $message;
-        $this->envelope = $envelope;
+    public function __construct(
+        private RawMessage $message,
+        private ?Envelope $envelope = null,
+    ) {
     }
 
     public function getMessage(): RawMessage
diff --git a/SentMessage.php b/SentMessage.php
@@ -21,19 +21,19 @@ class SentMessage
 {
     private RawMessage $original;
     private RawMessage $raw;
-    private Envelope $envelope;
     private string $messageId;
     private string $debug = '';
 
     /**
      * @internal
      */
-    public function __construct(RawMessage $message, Envelope $envelope)
-    {
+    public function __construct(
+        RawMessage $message,
+        private Envelope $envelope,
+    ) {
         $message->ensureValidity();
 
         $this->original = $message;
-        $this->envelope = $envelope;
 
         if ($message instanceof Message) {
             $message = clone $message;
diff --git a/Test/Constraint/EmailCount.php b/Test/Constraint/EmailCount.php
@@ -16,15 +16,11 @@
 
 final class EmailCount extends Constraint
 {
-    private int $expectedValue;
-    private ?string $transport;
-    private bool $queued;
-
-    public function __construct(int $expectedValue, ?string $transport = null, bool $queued = false)
-    {
-        $this->expectedValue = $expectedValue;
-        $this->transport = $transport;
-        $this->queued = $queued;
+    public function __construct(
+        private int $expectedValue,
+        private ?string $transport = null,
+        private bool $queued = false,
+    ) {
     }
 
     public function toString(): string
diff --git a/Transport.php b/Transport.php
@@ -64,8 +64,6 @@ final class Transport
         SesTransportFactory::class,
     ];
 
-    private iterable $factories;
-
     public static function fromDsn(#[\SensitiveParameter] string $dsn, ?EventDispatcherInterface $dispatcher = null, ?HttpClientInterface $client = null, ?LoggerInterface $logger = null): TransportInterface
     {
         $factory = new self(iterator_to_array(self::getDefaultFactories($dispatcher, $client, $logger)));
@@ -83,9 +81,9 @@ public static function fromDsns(#[\SensitiveParameter] array $dsns, ?EventDispat
     /**
      * @param TransportFactoryInterface[] $factories
      */
-    public function __construct(iterable $factories)
-    {
-        $this->factories = $factories;
+    public function __construct(
+        private iterable $factories,
+    ) {
     }
 
     public function fromStrings(#[\SensitiveParameter] array $dsns): Transports
diff --git a/Transport/AbstractHttpTransport.php b/Transport/AbstractHttpTransport.php
@@ -26,11 +26,12 @@ abstract class AbstractHttpTransport extends AbstractTransport
 {
     protected ?string $host = null;
     protected ?int $port = null;
-    protected ?HttpClientInterface $client;
 
-    public function __construct(?HttpClientInterface $client = null, ?EventDispatcherInterface $dispatcher = null, ?LoggerInterface $logger = null)
-    {
-        $this->client = $client;
+    public function __construct(
+        protected ?HttpClientInterface $client = null,
+        ?EventDispatcherInterface $dispatcher = null,
+        ?LoggerInterface $logger = null,
+    ) {
         if (null === $client) {
             if (!class_exists(HttpClient::class)) {
                 throw new \LogicException(sprintf('You cannot use "%s" as the HttpClient component is not installed. Try running "composer require symfony/http-client".', __CLASS__));
diff --git a/Transport/AbstractTransport.php b/Transport/AbstractTransport.php
@@ -30,14 +30,14 @@
  */
 abstract class AbstractTransport implements TransportInterface
 {
-    private ?EventDispatcherInterface $dispatcher;
     private LoggerInterface $logger;
     private float $rate = 0;
     private float $lastSent = 0;
 
-    public function __construct(?EventDispatcherInterface $dispatcher = null, ?LoggerInterface $logger = null)
-    {
-        $this->dispatcher = $dispatcher;
+    public function __construct(
+        private ?EventDispatcherInterface $dispatcher = null,
+        ?LoggerInterface $logger = null,
+    ) {
         $this->logger = $logger ?? new NullLogger();
     }
 
diff --git a/Transport/AbstractTransportFactory.php b/Transport/AbstractTransportFactory.php
@@ -21,15 +21,11 @@
  */
 abstract class AbstractTransportFactory implements TransportFactoryInterface
 {
-    protected ?EventDispatcherInterface $dispatcher;
-    protected ?HttpClientInterface $client;
-    protected ?LoggerInterface $logger;
-
-    public function __construct(?EventDispatcherInterface $dispatcher = null, ?HttpClientInterface $client = null, ?LoggerInterface $logger = null)
-    {
-        $this->dispatcher = $dispatcher;
-        $this->client = $client;
-        $this->logger = $logger;
+    public function __construct(
+        protected ?EventDispatcherInterface $dispatcher = null,
+        protected ?HttpClientInterface $client = null,
+        protected ?LoggerInterface $logger = null,
+    ) {
     }
 
     public function supports(Dsn $dsn): bool
diff --git a/Transport/Dsn.php b/Transport/Dsn.php
@@ -18,21 +18,14 @@
  */
 final class Dsn
 {
-    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, #[\SensitiveParameter] ?string $password = null, ?int $port = null, array $options = [])
-    {
-        $this->scheme = $scheme;
-        $this->host = $host;
-        $this->user = $user;
-        $this->password = $password;
-        $this->port = $port;
-        $this->options = $options;
+    public function __construct(
+        private string $scheme,
+        private string $host,
+        private ?string $user = null,
+        #[\SensitiveParameter] private ?string $password = null,
+        private ?int $port = null,
+        private array $options = [],
+    ) {
     }
 
     public static function fromString(#[\SensitiveParameter] string $dsn): self
diff --git a/Transport/RoundRobinTransport.php b/Transport/RoundRobinTransport.php
@@ -28,22 +28,20 @@ class RoundRobinTransport implements TransportInterface
      * @var \SplObjectStorage<TransportInterface, float>
      */
     private \SplObjectStorage $deadTransports;
-    private array $transports = [];
-    private int $retryPeriod;
     private int $cursor = -1;
 
     /**
      * @param TransportInterface[] $transports
      */
-    public function __construct(array $transports, int $retryPeriod = 60)
-    {
+    public function __construct(
+        private array $transports,
+        private int $retryPeriod = 60,
+    ) {
         if (!$transports) {
             throw new TransportException(sprintf('"%s" must have at least one transport configured.', static::class));
         }
 
-        $this->transports = $transports;
         $this->deadTransports = new \SplObjectStorage();
-        $this->retryPeriod = $retryPeriod;
     }
 
     public function send(RawMessage $message, ?Envelope $envelope = null): ?SentMessage

Original file line number	Diff line number	Diff line change
`@@ -25,11 +25,10 @@ final class DelayedEnvelope extends Envelope`
`25`	`25`	`{`
`26`	`26`	`private bool $senderSet = false;`
`27`	`27`	`private bool $recipientsSet = false;`
`28`		`- private Message $message;`
`29`	`28`
`30`		`- public function __construct(Message $message)`
`31`		`- {`
`32`		`- $this->message = $message;`
	`29`	`+ public function __construct(`
	`30`	`+ private Message $message,`
	`31`	`+ ) {`
`33`	`32`	`}`
`34`	`33`
`35`	`34`	`public function setSender(Address $sender): void`
Original file line number	Diff line number	Diff line change
`@@ -19,11 +19,9 @@`
`19`	`19`	`*/`
`20`	`20`	`class MessageHandler`
`21`	`21`	`{`
`22`		`- private TransportInterface $transport;`
`23`		`-`
`24`		`- public function __construct(TransportInterface $transport)`
`25`		`- {`
`26`		`- $this->transport = $transport;`
	`22`	`+ public function __construct(`
	`23`	`+ private TransportInterface $transport,`
	`24`	`+ ) {`
`27`	`25`	`}`
`28`	`26`
`29`	`27`	`public function __invoke(SendEmailMessage $message): ?SentMessage`