minor symfony#9112 Mentioned the TargetPathTrait utility (javiereguiluz)

javiereguiluz · javiereguiluz · commit 351f6db284a2 · 2018-01-23T09:37:11.000+01:00
This PR was merged into the 3.3 branch. Discussion ---------- Mentioned the TargetPathTrait utility Commits ------- 9a5f7a6 Mentioned the TargetPathTrait utility
diff --git a/security/form_login.rst b/security/form_login.rst
@@ -430,3 +430,24 @@ are now fully customized:
             <input type="hidden" name="back_to" value="<?php echo $view['router']->path('forgot_password') ?>" />
             <input type="submit" name="login" />
         </form>
+
+Redirecting to the Last Accessed Page with ``TargetPathTrait``
+--------------------------------------------------------------
+
+The last request URI is stored in a session variable named
+``_security.<your providerKey>.target_path`` (e.g. ``_security.main.target_path``
+if the name of your firewall is ``main``). Most of the times you don't have to
+deal with this low level session variable. However, if you ever need to get or
+remove this variable, it's better to use the
+:class:`Symfony\\Component\\Security\\Http\\Util\\TargetPathTrait` utility::
+
+    // ...
+    use Symfony\Component\Security\Http\Util\TargetPathTrait;
+
+    $targetPath = $this->getTargetPath($request->getSession(), $providerKey);
+
+    // equivalent to:
+    // $targetPath = $request->getSession()->get('_security.'.$providerKey.'.target_path');
+
+.. versionadded:: 3.1
+    The ``TargetPathTrait`` was introduced in Symfony 3.1.
