Skip to content

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

Closed
wants to merge 2 commits into from
Closed
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
63 changes: 63 additions & 0 deletions security/form_login_setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When the user tries to access a restricted page, they are being redirected to the
login page. At that point target path will be set. After a successful login,
the user will be redirected to this previously set target path.

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:
Copy link
Contributor

Choose a reason for hiding this comment

The 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 it refers to. Maybe we should repeat target path here.

Suggested change
To set it on certain public routes, you can create an Event Subscriber:
To set the target path on public routes, you can create an Event Subscriber:


.. code-block:: php
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()) {
Copy link
Contributor

@dbrumann dbrumann Apr 6, 2019

Choose a reason for hiding this comment

The 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?

if (!$event->isMasterRequest() || $request->isXmlHttpRequest()) {
    return;
}

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