Classes List

Symfony\Component\Security\Http\Util\TargetPathTrait

 1 
 2 
 3 
 4 
 5 
 6 
 7 
 8 
 9 
 10 
 11 
 12 
 13 
 14 
 15 
 16 
 17 
 18 
 19 
 20 
 21 
 22 
 23 
 24 
 25 
 26 
 27 
 28 
 29 
 30 
 31 
 32 
 33 
 34 
 35 
 36 
 37 
 38 
 39 
 40 
 41 
 42 
 43 
 44 
 45 
 46 
 47 
 48 
 49 
 50 
 51 
 52 
 53 
 54 
 55 
 56 
 57 
 58 
 59 
<?php

/* * This file is part of the Symfony package. * * (c) Fabien Potencier <fabien@symfony.com> * * For the full copyright and license information, please view the LICENSE * file that was distributed with this source code. */


namespace Symfony\Component\Security\Http\Util;

use Symfony\Component\HttpFoundation\Session\SessionInterface;

/** * Trait to get (and set) the URL the user last visited before being forced to authenticate. */
trait TargetPathTrait
{
    /** * Sets the target path the user should be redirected to after authentication. * * Usually, you do not need to set this directly. * * @param SessionInterface $session * @param string $providerKey The name of your firewall * @param string $uri The URI to set as the target path */
    private function saveTargetPath(SessionInterface $session$providerKey$uri)
    {
        $session->set('_security.'.$providerKey.'.target_path'$uri);
    }

    /** * Returns the URL (if any) the user visited that forced them to login. * * @param SessionInterface $session * @param string $providerKey The name of your firewall * * @return string */
    private function getTargetPath(SessionInterface $session$providerKey)
    {
        return $session->get('_security.'.$providerKey.'.target_path');
    }

    /** * Removes the target path from the session. * * @param SessionInterface $session * @param string $providerKey The name of your firewall */
    private function removeTargetPath(SessionInterface $session$providerKey)
    {
        $session->remove('_security.'.$providerKey.'.target_path');
    }
}