vendor/symfony/security-http/Util/TargetPathTrait.php line 28

  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\Security\Http\Util;
  14. use Symfony\Component\HttpFoundation\Session\SessionInterface;
  16. /**
  17.  * Trait to get (and set) the URL the user last visited before being forced to authenticate.
  18.  */
  19. trait TargetPathTrait
  20. {
  21.     /**
  22.      * Sets the target path the user should be redirected to after authentication.
  23.      *
  24.      * Usually, you do not need to set this directly.
  25.      */
  26.     private function saveTargetPath(SessionInterface $session, string $firewallName, string $uri)
  27.     {
  28.         $session->set('_security.'.$firewallName.'.target_path', $uri);
  29.     }
  31.     /**
  32.      * Returns the URL (if any) the user visited that forced them to login.
  33.      */
  34.     private function getTargetPath(SessionInterface $session, string $firewallName): ?string
  35.     {
  36.         return $session->get('_security.'.$firewallName.'.target_path');
  37.     }
  39.     /**
  40.      * Removes the target path from the session.
  41.      */
  42.     private function removeTargetPath(SessionInterface $session, string $firewallName)
  43.     {
  44.         $session->remove('_security.'.$firewallName.'.target_path');
  45.     }
  46. }