Don't mention the UserInterface type-hinting

[javiereguiluz]

This fixes #7506. Ping @iltar.

[linaori]

Could move this to the code block somewhere around: https://github.com/symfony/symfony-docs/pull/9060/files#diff-d1c69ceaea98cb0458d71feab0760245R1036

[javiereguiluz]

My changes are wrong because UserInterface is used in other parts of the article. We need to make a definitive decision about UserInterface:

a) Never use it or mention on Symfony Docs
b) Never use it, but mention it in a note/tip somewhere, but discourage to use it
c) Always use it, and explain the $this->getUser() shortcut in a note/tip somewhere, but discourage to use it

I thought we were going for (a).

Ping @weaverryan @chalasr @xabbuh

[xabbuh]

I am not sure I follow what you would like to fix or at which stage we are right now.

[javiereguiluz]

@xabbuh we introduced UserInterface as a replacement of $this->getUser() ... but apparently using UserInterface is bad and even Ryan asked to keep using $this->getUser().

So, we need to make a definitive decision about UserInterface. Is something we want to promote or not? Thanks!

[linaori]

UserInterface $user provides an alternative for people that do not (want to) extend the Controller or implement the trait. If there is supposed to 1 way "to rule them all", it should be one that works for both.

[javiereguiluz]

@iltar if we do that, it'd be better if we type-hint the new Security utility class instead of UserInterface. Then we can do $security->getUser()

[linaori]

That would be an extra action and an extra dependency, which would beat the purpose imo

[weaverryan]

UserInterface $user provides an alternative for people that do not (want to) extend the Controller or implement the trait.

This is definitely true! :) But we don't need to give this group very much help - it's a very small and very intelligent group.

The problem with type-hinting is that it's not "discoverable": I can't think about my code or dig around and realize that UserInterface is a valid thing to type-hint. We already allow type-hinting for services and we added debug:autowiring so that (at least) there's an easy place to go to find the list of things you can type-hint. I don't think we should recommend any other type-hints (yes, we also have Request and param converters... so plenty already).

I still think we should go with $this->getUser() everywhere: let's not complicate people's lives, this is a really easy way to get the user :). Also, I prefer to show the Security class a secondary option, instead of UserInterface, because you can inject Security elsewhere (so that code will work anywhere, not just in a controller).

I know we disagree on this @iltar :). But the DX looks bad for UserInterface vs $this->getUser(), and for smart users like you, you don't need the docs to help you (other than a mention of this way).

[linaori]

As long as the feature is documented somewhere, I'm 👍 Would be a bit troublesome to have undocumented features, might as well remove them in that case.

[weaverryan]

@javiereguiluz can you update you the PR - let's look for all UserInterface spots and make them getUser(), but leave a mention somewhere.

[chalasr]

For the record, I do love the security user value resolver and use it over the controller shortcut, but I can understand that the shortcut is preferred for the docs.