-
-
Notifications
You must be signed in to change notification settings - Fork 5.2k
Clarify target path functionality #11192
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
|
@@ -373,4 +373,67 @@ deal with this low level session variable. However, the | |||||
:class:`Symfony\\Component\\Security\\Http\\Util\\TargetPathTrait` utility | ||||||
can be used to read (like in the example above) or set this value manually. | ||||||
|
||||||
When the user tries to access a restricted page, it is redirected to the login page. | ||||||
At that point target path is set and after a successful login, the user will | ||||||
be redirected to the target path set before. | ||||||
|
||||||
To set it on certain public routes, you can create an Event Subscriber: | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. I think since this is a new paragraph it might be a bit difficult to track what
Suggested change
|
||||||
|
||||||
.. code-block:: php | ||||||
sergiu-popa marked this conversation as resolved.
Show resolved
Hide resolved
|
||||||
namespace App\EventSubscriber; | ||||||
|
||||||
use Symfony\Component\EventDispatcher\EventSubscriberInterface; | ||||||
use Symfony\Component\HttpFoundation\Session\SessionInterface; | ||||||
use Symfony\Component\HttpKernel\Event\GetResponseEvent; | ||||||
use Symfony\Component\HttpKernel\KernelEvents; | ||||||
use Symfony\Component\Security\Http\Util\TargetPathTrait; | ||||||
|
||||||
class RequestSubscriber implements EventSubscriberInterface | ||||||
{ | ||||||
use TargetPathTrait; | ||||||
|
||||||
/** @var SessionInterface */ | ||||||
private $session; | ||||||
|
||||||
public function __construct(SessionInterface $session) | ||||||
{ | ||||||
$this->session = $session; | ||||||
} | ||||||
|
||||||
/** | ||||||
* Save targetPath for public routes | ||||||
* | ||||||
* @param GetResponseEvent $event | ||||||
*/ | ||||||
public function onKernelRequest(GetResponseEvent $event): void | ||||||
{ | ||||||
$request = $event->getRequest(); | ||||||
|
||||||
if (!$event->isMasterRequest()) { | ||||||
return; | ||||||
} | ||||||
|
||||||
if ($request->isXmlHttpRequest()) { | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Would it make sense to combine both if conditions to simplify/shorten this example a bit?
|
||||||
return; | ||||||
} | ||||||
|
||||||
$includedRoutes = ['some-public-route', 'another-route']; | ||||||
|
||||||
if (!\in_array($request->attributes->get('_route'), $includedRoutes, true)) { | ||||||
return; | ||||||
} | ||||||
|
||||||
$this->saveTargetPath($this->session, 'main', $request->getUri()); | ||||||
} | ||||||
|
||||||
public static function getSubscribedEvents() | ||||||
{ | ||||||
return [ | ||||||
KernelEvents::REQUEST => ['onKernelRequest'] | ||||||
]; | ||||||
} | ||||||
} | ||||||
|
||||||
This subscriber will save the target path for the *main* firewall for the `$includedRoutes`. If a user visits `some-public-route`, after a successful login, it will be redirected to that route. | ||||||
|
||||||
.. _`MakerBundle`: https://symfony.com/doc/current/bundles/SymfonyMakerBundle/index.html |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.