Fix misleading TokenInterface docblock 2.3 #12597
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
| * @return mixed either returns an object which implements __toString(), or | ||
| * a primitive string is returned. | ||
| * @return mixed either returns an object which implements Symfony\Component\Security\Core\User\UserInterface, | ||
| * or a primitive string is returned. |
There was a problem hiding this comment.
"or a primitive string." would be enough as the verb is already earlier in the sentence.
There was a problem hiding this comment.
Right, I'll fix it.
066f9aa to
f2e0c53
Compare
f2e0c53 to
9783f1b
Compare
| @@ -47,8 +47,8 @@ public function getCredentials(); | |||
| /** | |||
| * Returns a user representation. | |||
| * | |||
| * @return mixed either returns an object which implements __toString(), or | |||
| * a primitive string is returned. | |||
| * @return mixed Either returns an object which implements Symfony\Component\Security\Core\User\UserInterface, | |||
There was a problem hiding this comment.
You should keep the "object which implements __toString()" as well.
This PR was merged into the 2.3 branch. Discussion ---------- [Security] fixed wrong phpdoc | Q | A | ------------- | --- | Bug fix? | no | New feature? | no | BC breaks? | no | Deprecations? | no | Tests pass? | yes | Fixed tickets | #12597 | License | MIT | Doc PR | n/a Commits ------- 064062d [Security] fixed wrong phpdoc
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
I've found the docblock for
TokenInterface::getUsermisleading. By reading it I've written something like:This actually doesn't work, since
UserInterfacedoesn't implements__toStringand I have some instance ofAdvancedUser(coming from InMemory provider).If the token always return a
UserInterfaceor string, then my fix is ok.[fix my PR #12596]