vendor/symfonycasts/reset-password-bundle/src/Model/ResetPasswordToken.php line 16

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the SymfonyCasts ResetPasswordBundle package.
  5.  * Copyright (c) SymfonyCasts <https://symfonycasts.com/>
  6.  * For the full copyright and license information, please view the LICENSE
  7.  * file that was distributed with this source code.
  8.  */
  10. namespace SymfonyCasts\Bundle\ResetPassword\Model;
  12. /**
  13.  * @author Jesse Rushlow <jr@rushlow.dev>
  14.  * @author Ryan Weaver   <ryan@symfonycasts.com>
  15.  */
  16. final class ResetPasswordToken
  17. {
  18.     /**
  19.      * @var string|null selector + non-hashed verifier token
  20.      */
  21.     private $token;
  23.     /**
  24.      * @var \DateTimeInterface
  25.      */
  26.     private $expiresAt;
  28.     /**
  29.      * @var int|null timestamp when the token was created
  30.      */
  31.     private $generatedAt;
  33.     /**
  34.      * @var int expiresAt translator interval
  35.      */
  36.     private $transInterval = 0;
  38.     public function __construct(string $token, \DateTimeInterface $expiresAt, int $generatedAt = null)
  39.     {
  40.         $this->token = $token;
  41.         $this->expiresAt = $expiresAt;
  42.         $this->generatedAt = $generatedAt;
  44.         if (null === $generatedAt) {
  45.             $this->triggerDeprecation();
  46.         }
  47.     }
  49.     /**
  50.      * Returns the full token the user should use.
  51.      *
  52.      * Internally, this consists of two parts - the selector and
  53.      * the hashed token - but that's an implementation detail
  54.      * of how the token will later be parsed.
  55.      */
  56.     public function getToken(): string
  57.     {
  58.         if (null === $this->token) {
  59.             throw new \RuntimeException('The token property is not set. Calling getToken() after calling clearToken() is not allowed.');
  60.         }
  62.         return $this->token;
  63.     }
  65.     /**
  66.      * Allow the token object to be safely persisted in a session.
  67.      */
  68.     public function clearToken(): void
  69.     {
  70.         $this->token = null;
  71.     }
  73.     public function getExpiresAt(): \DateTimeInterface
  74.     {
  75.         return $this->expiresAt;
  76.     }
  78.     /**
  79.      * Get the translation message for when a token expires.
  80.      *
  81.      * This is used in conjunction with getExpirationMessageData() method.
  82.      * Example usage in a Twig template:
  83.      *
  84.      * <p>{{ components.expirationMessageKey|trans(components.expirationMessageData) }}</p>
  85.      *
  86.      * symfony/translation is required to translate into a non-English locale.
  87.      *
  88.      * @throws \LogicException
  89.      */
  90.     public function getExpirationMessageKey(): string
  91.     {
  92.         $interval = $this->getExpiresAtIntervalInstance();
  94.         switch ($interval) {
  95.             case $interval->y > 0:
  96.                 $this->transInterval = $interval->y;
  98.                 return '%count% year|%count% years';
  99.             case $interval->m > 0:
  100.                 $this->transInterval = $interval->m;
  102.                 return '%count% month|%count% months';
  103.             case $interval->d > 0:
  104.                 $this->transInterval = $interval->d;
  106.                 return '%count% day|%count% days';
  107.             case $interval->h > 0:
  108.                 $this->transInterval = $interval->h;
  110.                 return '%count% hour|%count% hours';
  111.             default:
  112.                 $this->transInterval = $interval->i;
  114.                 return '%count% minute|%count% minutes';
  115.         }
  116.     }
  118.     /**
  119.      * @throws \LogicException
  120.      */
  121.     public function getExpirationMessageData(): array
  122.     {
  123.         $this->getExpirationMessageKey();
  125.         return ['%count%' => $this->transInterval];
  126.     }
  128.     /**
  129.      * Get the interval that the token is valid for.
  130.      *
  131.      * @throws \LogicException
  132.      *
  133.      * @psalm-suppress PossiblyFalseArgument
  134.      */
  135.     public function getExpiresAtIntervalInstance(): \DateInterval
  136.     {
  137.         if (null === $this->generatedAt) {
  138.             throw new \LogicException(sprintf('%s initialized without setting the $generatedAt timestamp.', self::class));
  139.         }
  141.         $createdAtTime = \DateTimeImmutable::createFromFormat('U', (string) $this->generatedAt);
  143.         return $this->expiresAt->diff($createdAtTime);
  144.     }
  146.     private function triggerDeprecation(): void
  147.     {
  148.         trigger_deprecation(
  149.             'symfonycasts/reset-password-bundle',
  150.             '1.2',
  151.             'Initializing the %s without setting the "$generatedAt" constructor argument is deprecated. The default "null" will be removed in the future.',
  152.             self::class
  153.         );
  154.     }
  155. }