vendor/symfonycasts/reset-password-bundle/src/Controller/ResetPasswordControllerTrait.php line 74

  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\Controller;
  12. use Symfony\Component\HttpFoundation\Request;
  13. use Symfony\Component\HttpFoundation\Session\SessionInterface;
  14. use SymfonyCasts\Bundle\ResetPassword\Model\ResetPasswordToken;
  16. /**
  17.  * Provides useful methods to a "reset password controller".
  18.  *
  19.  * Use of this trait requires a controller to extend
  20.  * Symfony\Bundle\FrameworkBundle\Controller\AbstractController
  21.  *
  22.  * @author Jesse Rushlow <jr@rushlow.dev>
  23.  * @author Ryan Weaver   <ryan@symfonycasts.com>
  24.  */
  25. trait ResetPasswordControllerTrait
  26. {
  27.     /**
  28.      * @deprecated since 1.3.0, use ResetPasswordControllerTrait::setTokenObjectInSession() instead.
  29.      */
  30.     private function setCanCheckEmailInSession(): void
  31.     {
  32.         trigger_deprecation(
  33.             'symfonycasts/reset-password-bundle',
  34.             '1.3.0',
  35.             'Storing the ResetPasswordToken object in the session is more desirable, use ResetPasswordControllerTrait::setTokenObjectInSession() instead.'
  36.         );
  38.         $this->getSessionService()->set('ResetPasswordCheckEmail', true);
  39.     }
  41.     /**
  42.      * @deprecated since 1.3.0, use ResetPasswordControllerTrait::getTokenObjectFromSession() instead.
  43.      */
  44.     private function canCheckEmail(): bool
  45.     {
  46.         trigger_deprecation(
  47.             'symfonycasts/reset-password-bundle',
  48.             '1.3.0',
  49.             'Storing the ResetPasswordToken object in the session is more desirable, use ResetPasswordControllerTrait::getTokenObjectFromSession() instead.'
  50.         );
  52.         return $this->getSessionService()->has('ResetPasswordCheckEmail');
  53.     }
  55.     private function storeTokenInSession(string $token): void
  56.     {
  57.         $this->getSessionService()->set('ResetPasswordPublicToken', $token);
  58.     }
  60.     private function getTokenFromSession(): ?string
  61.     {
  62.         return $this->getSessionService()->get('ResetPasswordPublicToken');
  63.     }
  65.     private function setTokenObjectInSession(ResetPasswordToken $token): void
  66.     {
  67.         $token->clearToken();
  69.         $this->getSessionService()->set('ResetPasswordToken', $token);
  70.     }
  72.     private function getTokenObjectFromSession(): ?ResetPasswordToken
  73.     {
  74.         return $this->getSessionService()->get('ResetPasswordToken');
  75.     }
  77.     private function cleanSessionAfterReset(): void
  78.     {
  79.         $session = $this->getSessionService();
  81.         $session->remove('ResetPasswordPublicToken');
  82.         $session->remove('ResetPasswordCheckEmail');
  83.         $session->remove('ResetPasswordToken');
  84.     }
  86.     private function getSessionService(): SessionInterface
  87.     {
  88.         /** @var Request $request */
  89.         $request = $this->container->get('request_stack')->getCurrentRequest();
  91.         return $request->getSession();
  92.     }
  93. }