feature #307 [token] add types and constructor property promotion

Author: jrushlow

UPGRADING.md

@@ -67,6 +67,30 @@ trait has been dropped - attribute mapping is required.
   no longer potentially throw a `LogicException`. They now throw a `ResetPasswordRuntimeException`
   if an invalid `$generatedAt` timestamp is provided to the class constructor.
 
+- Passing `null` for the `$generatedAt` argument when instantiating a new token object
+is no longer allowed. The argument is also now mandatory.
+
+```diff
+- public function __construct(string $token, \DateTimeInterface $expiresAt, ?int $generatedAt = null)
++ public function __construct(string $token, \DateTimeInterface $expiresAt, int $generatedAt)
+```
+
+- Property types were added to `token`, `expiresAt`, `generatedAt`.
+
+```diff
+- private $token;
++ private ?string $token;
+
+- private $expiresAt;
++ private \DateTimeInterface $expiresAt;
+
+- private $generatedAt;
++ private int $generatedAt;
+```
+
+_Note: When calling `ResetPasswordToken::clearToken()`, the value of `$token` is set to `null`. It is not possible to 
+instantiate a token object with a `null` `$token` value. This is intentional._
+
 ## ResetPasswordTokenGenerator
 
 - Type added for `createToken()`'s `$userId` argument

src/Model/ResetPasswordToken.php

@@ -17,35 +17,23 @@
  */
 final class ResetPasswordToken
 {
-    /**
-     * @var string|null selector + non-hashed verifier token
-     */
-    private $token;
-
-    /**
-     * @var \DateTimeInterface
-     */
-    private $expiresAt;
+    private ?string $token;
 
     /**
-     * @var int|null timestamp when the token was created
+     * @var int expiresAt translator interval
      */
-    private $generatedAt;
+    private int $transInterval = 0;
 
     /**
-     * @var int expiresAt translator interval
+     * @param string $token       selector + non-hashed verifier token
+     * @param int    $generatedAt timestamp when the token was created
      */
-    private $transInterval = 0;
-
-    public function __construct(string $token, \DateTimeInterface $expiresAt, ?int $generatedAt = null)
-    {
+    public function __construct(
+        string $token,
+        private \DateTimeInterface $expiresAt,
+        private int $generatedAt
+    ) {
         $this->token = $token;
-        $this->expiresAt = $expiresAt;
-        $this->generatedAt = $generatedAt;
-
-        if (null === $generatedAt) {
-            $this->triggerDeprecation();
-        }
     }
 
     /**
@@ -138,10 +126,6 @@ public function getExpirationMessageData(): array
      */
     public function getExpiresAtIntervalInstance(): \DateInterval
     {
-        if (null === $this->generatedAt) {
-            throw new \LogicException(sprintf('%s initialized without setting the $generatedAt timestamp.', self::class));
-        }
-
         $createdAtTime = \DateTimeImmutable::createFromFormat('U', (string) $this->generatedAt);
 
         if (false === $createdAtTime) {
@@ -150,17 +134,4 @@ public function getExpiresAtIntervalInstance(): \DateInterval
 
         return $this->expiresAt->diff($createdAtTime);
     }
-
-    /**
-     * @psalm-suppress UndefinedFunction
-     */
-    private function triggerDeprecation(): void
-    {
-        trigger_deprecation(
-            'symfonycasts/reset-password-bundle',
-            '1.2',
-            'Initializing the %s without setting the "$generatedAt" constructor argument is deprecated. The default "null" will be removed in the future.',
-            self::class
-        );
-    }
 }