[Security] Add missing docblock in PreAuthenticatedToken #15481
Closed
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
|
I think this PR should be submitted against 2.3. |
|
I don't see any bugfix :o ... And IMO the addition of the |
| @@ -33,7 +33,7 @@ | |||
| /** | |||
| * Constructor. | |||
| * | |||
| * @param RoleInterface[] $roles An array of roles | |||
| * @param RoleInterface[]|string[] $roles An array of roles | |||
There was a problem hiding this comment.
There are already some debates about this notation, being incomplete. See #13146 (comment) and other related issues.
As @dosten said in one of them:
getRolescan return an array of strings, Role instances or a mix of both, the phpdoc must reflect that.
|
I applied it on 2.3: #15484 The notation I used for |
|
I think it should be |
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.
I noticed the
PreAuthenticatedTokendoes not provide any dockblock about its constructor parameters so PHPStorm uses theAbstractTokenparameters and think I'm usingPreAuthenticatedTokenbadly.This fix it by adding the missing docblock and I also added the string[] possibility for roles in
AbstractTokenas it's present in the code and the exception message.