[Security] Add documentation for the optional $options params accepted by createLoginLink (LoginLinkHandlerInterface) #16385
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Remove line 325 : use Symfony\Component\Security\Http\Authenticator\Passport\Passport; Same 324
This PR was merged into the 5.4 branch. Discussion ---------- Remove duplicate line Remove line 325 : use Symfony\Component\Security\Http\Authenticator\Passport\Passport; Same 324 <!-- If your pull request fixes a BUG, use the oldest maintained branch that contains the bug (see https://symfony.com/releases for the list of maintained branches). If your pull request documents a NEW FEATURE, use the same Symfony branch where the feature was introduced (and `6.x` for features of unreleased versions). --> Commits ------- 0c7a542 Remove duplicate line
javiereguiluz
added
the
Waiting Code Merge
carsonbot
changed the title
ndench
reviewed
Jun 11, 2023
| The ``createLoginLink()`` method accepts a third optional argument to pass an | ||
| ``options`` array. There are three keys to consider: route_name, lifetime and parameters. | ||
| $options['route_name'] will override the global route_name value and $options['lifetime'] will override the lifetime global value. | ||
| $options['parameters'] accepts and array of name/values to pass to the internal router and to |
There was a problem hiding this comment.
Suggested change
| $options['parameters'] accepts and array of name/values to pass to the internal router and to | |
| $options['parameters'] accepts an array of name/values to pass to the internal router and to |
|
|
||
| The ``createLoginLink()`` method accepts a third optional argument to pass an | ||
| ``options`` array. There are three keys to consider: route_name, lifetime and parameters. | ||
| $options['route_name'] will override the global route_name value and $options['lifetime'] will override the lifetime global value. |
There was a problem hiding this comment.
Should we mention what the global route_name and lifetime values are? Maybe give an example of why might want to override them?
|
Closing because the related code PR was closed without merging (symfony/symfony#44968). Thanks. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hi guys!
I just added documentation for the PR symfony/symfony#44968
Which pretends to admit an $options parameter, which pretends:
route_name
lifetime
I hope it helps. Thanks a lot!