[2.8][Security][Guard] GuardTokenInterface vs. TokenInterface in phpDoc #15884
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 would instead make GuardTokenInterface extend TokenInterface |
|
I agree with @fabpot here |
|
I agree as well - see #15927 - if we make GuardTokenInterface extend TokenInterface, it looks like no other changes are needed. |
|
Yes, #15927 is probably the better solution. |
fabpot
added a commit
that referenced
this pull request
Sep 27, 2015
This PR was merged into the 2.8 branch. Discussion ---------- Making GuardTokenInterface extend TokenInterface | Q | A | ------------- | --- | Bug fix? | yes | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #15884 | License | MIT | Doc PR | n/a See #15884 Commits ------- 7f04fbb Making GuardTokenInterface extend TokenInterface
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.
The new
GuardTokenInterfaceis used as a marker to annotate a security token that is compatible with the new Guard component. I noticed that wheneverGuardTokenInterfaceis annotated, the code expects the object to also implementTokenInterface. This asummption is correct, but we should make it explicit. Especially when looking atGuardAuthenticationProvider::authenticatemethod, I find it confusing that the doc block is incompatible with the type hint.With this tiny PR, I changed the annotations to
TokenInterface|GuardTokenInterfacewhere I found it helpful to do this. By doing this, I also found an unused import.An alternative approach could be declaring
GuardTokenInterfaceas an interface that extendsTokenInterface./ping @weaverryan