Convert properties to constructor promotion

bobvandevijver · bobvandevijver · commit 00d26dc81433 · 2022-01-14T08:47:38.000+01:00
diff --git a/src/Database/SoftDeletableSubscriber.php b/src/Database/SoftDeletableSubscriber.php
@@ -15,19 +15,13 @@ class SoftDeletableSubscriber implements EventSubscriber
    */
   const FIELD_NAME = 'deletedBy';
 
-  /**
-   * @var TokenStorageInterface
-   */
-  private $tokenStorage;
-
   /**
    * SoftDeletableSubscriber constructor.
    *
    * @param TokenStorageInterface $tokenStorage
    */
-  public function __construct(TokenStorageInterface $tokenStorage)
+  public function __construct(private TokenStorageInterface $tokenStorage)
   {
-    $this->tokenStorage = $tokenStorage;
   }
 
   /**
diff --git a/src/Database/SoftDeletableSymfonyCacheWarmer.php b/src/Database/SoftDeletableSymfonyCacheWarmer.php
@@ -8,14 +8,8 @@
 
 class SoftDeletableSymfonyCacheWarmer implements CacheWarmerInterface
 {
-  /**
-   * @var bool
-   */
-  private $useUtc;
-
-  public function __construct(bool $useUtc)
+  public function __construct(private bool $useUtc)
   {
-    $this->useUtc = $useUtc;
   }
 
   public static function registerGedmoType(): void
diff --git a/src/Database/SoftDeletableSymfonySubscriber.php b/src/Database/SoftDeletableSymfonySubscriber.php
@@ -16,14 +16,8 @@
 class SoftDeletableSymfonySubscriber implements EventSubscriberInterface
 {
 
-  /**
-   * @var bool
-   */
-  private $useUtc;
-
-  public function __construct(bool $useUtc)
+  public function __construct(private bool $useUtc)
   {
-    $this->useUtc = $useUtc;
   }
 
   public static function getSubscribedEvents()
diff --git a/src/Email/EmailService.php b/src/Email/EmailService.php
@@ -17,27 +17,6 @@
  */
 class EmailService
 {
-  /**
-   * @var MailerInterface
-   */
-  private $mailer;
-  /**
-   * @var string
-   */
-  private $senderEmail;
-  /**
-   * @var string|null
-   */
-  private $senderName;
-  /**
-   * @var TranslatorInterface|null
-   */
-  private $translator;
-  /**
-   * @var TransportInterface
-   */
-  private $transport;
-
   /**
    * EmailService constructor.
    *
@@ -48,17 +27,12 @@ class EmailService
    * @param TransportInterface       $transport
    */
   public function __construct(
-      MailerInterface      $mailer,
-      string               $senderEmail,
-      ?string              $senderName,
-      ?TranslatorInterface $translator,
-      TransportInterface   $transport)
+      private MailerInterface      $mailer,
+      private string               $senderEmail,
+      private ?string              $senderName,
+      private ?TranslatorInterface $translator,
+      private TransportInterface   $transport)
   {
-    $this->mailer      = $mailer;
-    $this->senderEmail = $senderEmail;
-    $this->senderName  = $senderName;
-    $this->translator  = $translator;
-    $this->transport   = $transport;
   }
 
   /**
diff --git a/src/Exception/EntityValidationFailedException.php b/src/Exception/EntityValidationFailedException.php
@@ -8,15 +8,8 @@
 
 class EntityValidationFailedException extends Exception
 {
-  /**
-   * @var ConstraintViolationListInterface|null
-   */
-  private $violationList;
-
-  public function __construct(?ConstraintViolationListInterface $violationList = NULL, ?string $message = NULL)
+  public function __construct(private ?ConstraintViolationListInterface $violationList = NULL, ?string $message = NULL)
   {
-    $this->violationList = $violationList;
-
     if ($violationList !== NULL) {
       $messages = [];
       foreach ($violationList as $violation) {
diff --git a/src/Exception/Handler/EntityValidationFailedExceptionHandler.php b/src/Exception/Handler/EntityValidationFailedExceptionHandler.php
@@ -13,25 +13,11 @@
 
 class EntityValidationFailedExceptionHandler implements EventSubscriberInterface
 {
-  /**
-   * @var string
-   */
-  private $controllerPrefix;
-  /**
-   * @var string
-   */
-  private $dataField;
-
-  /**
-   * @var SerializerInterface
-   */
-  private $serializer;
-
-  public function __construct(SerializerInterface $serializer, string $controllerPrefix, string $dataField)
+  public function __construct(
+      private SerializerInterface $serializer,
+      private string              $controllerPrefix,
+      private string              $dataField)
   {
-    $this->serializer       = $serializer;
-    $this->controllerPrefix = $controllerPrefix;
-    $this->dataField        = $dataField;
   }
 
   public static function getSubscribedEvents()
diff --git a/src/Form/Extension/Select2Extension.php b/src/Form/Extension/Select2Extension.php
@@ -21,14 +21,8 @@
  */
 class Select2Extension extends AbstractTypeExtension
 {
-  /**
-   * @var TranslatorInterface|null
-   */
-  private $translator;
-
-  public function __construct(?TranslatorInterface $translator)
+  public function __construct(private ?TranslatorInterface $translator)
   {
-    $this->translator = $translator;
   }
 
   public function buildForm(FormBuilderInterface $builder, array $options)
diff --git a/src/Form/Type/Select2EntitySearchType.php b/src/Form/Type/Select2EntitySearchType.php
@@ -21,19 +21,8 @@
  */
 class Select2EntitySearchType extends AbstractType
 {
-  /**
-   * @var PropertyAccessorInterface
-   */
-  private $propertyAccessor;
-  /**
-   * @var ManagerRegistry
-   */
-  private $registry;
-
-  public function __construct(ManagerRegistry $registry, PropertyAccessorInterface $propertyAccessor)
+  public function __construct(private ManagerRegistry $registry, private PropertyAccessorInterface $propertyAccessor)
   {
-    $this->registry         = $registry;
-    $this->propertyAccessor = $propertyAccessor;
   }
 
   public function buildForm(FormBuilderInterface $builder, array $options)
diff --git a/src/Helper/DateTimeProvider.php b/src/Helper/DateTimeProvider.php
@@ -10,11 +10,8 @@
  */
 class DateTimeProvider
 {
-  private $now;
-
-  public function __construct(string $now = 'now')
+  public function __construct(private string $now = 'now')
   {
-    $this->now = $now;
   }
 
   /**
diff --git a/src/Helper/GravatarHelper.php b/src/Helper/GravatarHelper.php
@@ -9,16 +9,8 @@
  */
 class GravatarHelper
 {
-  /**
-   * The fallback style of gravatar to use in case there is not gravatar available
-   *
-   * @var string
-   */
-  private $fallbackStyle;
-
-  public function __construct(string $fallbackStyle)
+  public function __construct(private string $fallbackStyle)
   {
-    $this->fallbackStyle = $fallbackStyle;
   }
 
   /**
diff --git a/src/Helper/SpreadsheetHelper.php b/src/Helper/SpreadsheetHelper.php
@@ -20,17 +20,13 @@
 class SpreadsheetHelper
 {
 
-  /** @var TranslatorInterface */
-  private $translator;
-
   /**
    * SpreadsheetHelper constructor.
    *
    * @param TranslatorInterface $translator
    */
-  public function __construct(TranslatorInterface $translator)
+  public function __construct(private TranslatorInterface $translator)
   {
-    $this->translator = $translator;
   }
 
   /**
diff --git a/src/Helper/UtcHelper.php b/src/Helper/UtcHelper.php
@@ -11,15 +11,9 @@
 class UtcHelper
 {
 
-  /**
-   * @var DateTimeZone
-   */
-  private static $utc;
+  private static \DateTimeZone $utc;
 
-  /**
-   * @var DateTimeZone
-   */
-  private static $local;
+  private static \DateTimeZone $local;
 
   /**
    * @return DateTimeZone
diff --git a/src/Ical/IcalProvider.php b/src/Ical/IcalProvider.php
@@ -15,15 +15,11 @@
 class IcalProvider
 {
 
-  /** @var IcsProvider */
-  protected $provider;
-
   /**
    * IcalProvider constructor.
    */
-  public function __construct(IcsProvider $provider)
+  public function __construct(protected IcsProvider $provider)
   {
-    $this->provider = $provider;
   }
 
   /**
diff --git a/src/IdMap/IdMap.php b/src/IdMap/IdMap.php
@@ -16,7 +16,7 @@
 class IdMap implements Countable, IteratorAggregate
 {
   /** @var array<int, T> */
-  private $elements;
+  private array $elements;
 
   /** @param T[] $objects */
   public function __construct(array $objects = [])
diff --git a/src/Serializer/StaticSerializer.php b/src/Serializer/StaticSerializer.php
@@ -14,10 +14,8 @@
 class StaticSerializer implements EventSubscriberInterface
 {
 
-  /** @var SerializerInterface|null */
-  private static $serializer = NULL;
-  /** @var SerializationContextFactoryInterface|null */
-  private static $serializationContextFactory = NULL;
+  private static ?SerializerInterface $serializer = NULL;
+  private static ?SerializationContextFactoryInterface $serializationContextFactory = NULL;
 
   /**
    * EntitySnapshotter constructor.
diff --git a/src/Twig/GravatarExtension.php b/src/Twig/GravatarExtension.php
@@ -13,14 +13,8 @@
  */
 class GravatarExtension extends AbstractExtension
 {
-  /**
-   * @var GravatarHelper
-   */
-  private $gravatarHelper;
-
-  public function __construct(GravatarHelper $gravatarHelper)
+  public function __construct(private GravatarHelper $gravatarHelper)
   {
-    $this->gravatarHelper = $gravatarHelper;
   }
 
   /**
diff --git a/src/Twig/JmsSerializerExtension.php b/src/Twig/JmsSerializerExtension.php
@@ -9,19 +9,10 @@
 
 class JmsSerializerExtension extends AbstractExtension
 {
-  /**
-   * @var SerializationContextFactoryInterface
-   */
-  private $contextFactory;
-  /**
-   * @var SerializerInterface
-   */
-  private $serializer;
-
-  public function __construct(SerializerInterface $serializer, SerializationContextFactoryInterface $contextFactory)
+  public function __construct(
+      private SerializerInterface                  $serializer,
+      private SerializationContextFactoryInterface $contextFactory)
   {
-    $this->serializer     = $serializer;
-    $this->contextFactory = $contextFactory;
   }
 
   public function getFilters()

Original file line number	Diff line number	Diff line change
`@@ -15,19 +15,13 @@ class SoftDeletableSubscriber implements EventSubscriber`
`15`	`15`	`*/`
`16`	`16`	`const FIELD_NAME = 'deletedBy';`
`17`	`17`
`18`		`- /**`
`19`		`- * @var TokenStorageInterface`
`20`		`- */`
`21`		`- private $tokenStorage;`
`22`		`-`
`23`	`18`	`/**`
`24`	`19`	`* SoftDeletableSubscriber constructor.`
`25`	`20`	`*`
`26`	`21`	`* @param TokenStorageInterface $tokenStorage`
`27`	`22`	`*/`
`28`		`- public function __construct(TokenStorageInterface $tokenStorage)`
	`23`	`+ public function __construct(private TokenStorageInterface $tokenStorage)`
`29`	`24`	`{`
`30`		`- $this->tokenStorage = $tokenStorage;`
`31`	`25`	`}`
`32`	`26`
`33`	`27`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -8,14 +8,8 @@`
`8`	`8`
`9`	`9`	`class SoftDeletableSymfonyCacheWarmer implements CacheWarmerInterface`
`10`	`10`	`{`
`11`		`- /**`
`12`		`- * @var bool`
`13`		`- */`
`14`		`- private $useUtc;`
`15`		`-`
`16`		`- public function __construct(bool $useUtc)`
	`11`	`+ public function __construct(private bool $useUtc)`
`17`	`12`	`{`
`18`		`- $this->useUtc = $useUtc;`
`19`	`13`	`}`
`20`	`14`
`21`	`15`	`public static function registerGedmoType(): void`
Original file line number	Diff line number	Diff line change
`@@ -16,14 +16,8 @@`
`16`	`16`	`class SoftDeletableSymfonySubscriber implements EventSubscriberInterface`
`17`	`17`	`{`
`18`	`18`
`19`		`- /**`
`20`		`- * @var bool`
`21`		`- */`
`22`		`- private $useUtc;`
`23`		`-`
`24`		`- public function __construct(bool $useUtc)`
	`19`	`+ public function __construct(private bool $useUtc)`
`25`	`20`	`{`
`26`		`- $this->useUtc = $useUtc;`
`27`	`21`	`}`
`28`	`22`
`29`	`23`	`public static function getSubscribedEvents()`
Original file line number	Diff line number	Diff line change
`@@ -21,14 +21,8 @@`
`21`	`21`	`*/`
`22`	`22`	`class Select2Extension extends AbstractTypeExtension`
`23`	`23`	`{`
`24`		`- /**`
`25`		`- * @var TranslatorInterface\|null`
`26`		`- */`
`27`		`- private $translator;`
`28`		`-`
`29`		`- public function __construct(?TranslatorInterface $translator)`
	`24`	`+ public function __construct(private ?TranslatorInterface $translator)`
`30`	`25`	`{`
`31`		`- $this->translator = $translator;`
`32`	`26`	`}`
`33`	`27`
`34`	`28`	`public function buildForm(FormBuilderInterface $builder, array $options)`
Original file line number	Diff line number	Diff line change
`@@ -10,11 +10,8 @@`
`10`	`10`	`*/`
`11`	`11`	`class DateTimeProvider`
`12`	`12`	`{`
`13`		`- private $now;`
`14`		`-`
`15`		`- public function __construct(string $now = 'now')`
	`13`	`+ public function __construct(private string $now = 'now')`
`16`	`14`	`{`
`17`		`- $this->now = $now;`
`18`	`15`	`}`
`19`	`16`
`20`	`17`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -9,16 +9,8 @@`
`9`	`9`	`*/`
`10`	`10`	`class GravatarHelper`
`11`	`11`	`{`
`12`		`- /**`
`13`		`- * The fallback style of gravatar to use in case there is not gravatar available`
`14`		`- *`
`15`		`- * @var string`
`16`		`- */`
`17`		`- private $fallbackStyle;`
`18`		`-`
`19`		`- public function __construct(string $fallbackStyle)`
	`12`	`+ public function __construct(private string $fallbackStyle)`
`20`	`13`	`{`
`21`		`- $this->fallbackStyle = $fallbackStyle;`
`22`	`14`	`}`
`23`	`15`
`24`	`16`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -20,17 +20,13 @@`
`20`	`20`	`class SpreadsheetHelper`
`21`	`21`	`{`
`22`	`22`
`23`		`- /** @var TranslatorInterface */`
`24`		`- private $translator;`
`25`		`-`
`26`	`23`	`/**`
`27`	`24`	`* SpreadsheetHelper constructor.`
`28`	`25`	`*`
`29`	`26`	`* @param TranslatorInterface $translator`
`30`	`27`	`*/`
`31`		`- public function __construct(TranslatorInterface $translator)`
	`28`	`+ public function __construct(private TranslatorInterface $translator)`
`32`	`29`	`{`
`33`		`- $this->translator = $translator;`
`34`	`30`	`}`
`35`	`31`
`36`	`32`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -15,15 +15,11 @@`
`15`	`15`	`class IcalProvider`
`16`	`16`	`{`
`17`	`17`
`18`		`- /** @var IcsProvider */`
`19`		`- protected $provider;`
`20`		`-`
`21`	`18`	`/**`
`22`	`19`	`* IcalProvider constructor.`
`23`	`20`	`*/`
`24`		`- public function __construct(IcsProvider $provider)`
	`21`	`+ public function __construct(protected IcsProvider $provider)`
`25`	`22`	`{`
`26`		`- $this->provider = $provider;`
`27`	`23`	`}`
`28`	`24`
`29`	`25`	`/**`
Original file line number	Diff line number	Diff line change
`@@ -16,7 +16,7 @@`
`16`	`16`	`class IdMap implements Countable, IteratorAggregate`
`17`	`17`	`{`
`18`	`18`	`/** @var array<int, T> */`
`19`		`- private $elements;`
	`19`	`+ private array $elements;`
`20`	`20`
`21`	`21`	`/** @param T[] $objects */`
`22`	`22`	`public function __construct(array $objects = [])`
Original file line number	Diff line number	Diff line change
`@@ -13,14 +13,8 @@`
`13`	`13`	`*/`
`14`	`14`	`class GravatarExtension extends AbstractExtension`
`15`	`15`	`{`
`16`		`- /**`
`17`		`- * @var GravatarHelper`
`18`		`- */`
`19`		`- private $gravatarHelper;`
`20`		`-`
`21`		`- public function __construct(GravatarHelper $gravatarHelper)`
	`16`	`+ public function __construct(private GravatarHelper $gravatarHelper)`
`22`	`17`	`{`
`23`		`- $this->gravatarHelper = $gravatarHelper;`
`24`	`18`	`}`
`25`	`19`
`26`	`20`	`/**`