Improve is_granted documentation #10461
Conversation
|
Please check your code blocks in the PR header. Thank you |
|
Thanks @OskarStark, fixed. Did you review the PR itself? |
This PR was squashed before being merged into the 2.8 branch (closes #10461). Discussion ---------- Improve is_granted documentation This improves the doc for the 'is_granted` Twig function. Under the hood, it calls `AuthorizationChecker::isGranted()` which accepts multiple attributes to be checked, but that's not clear. I've referred to the only other part of the doc where this is clear. Commits ------- 8ba3229 Improve is_granted documentation
|
@Jean85 thanks for this contribution. Merged! |
| an object can be pasted to be used by the voter. More information can be | ||
| found in :ref:`security-template`. | ||
| Returns ``true`` if the current user has the required role, if only one | ||
| is passed; if more than one is passed, with an array, the behavior depends |
There was a problem hiding this comment.
I don't see how this behaviour could be configured.
There was a problem hiding this comment.
It depends on the strategy you're using:
affirmative(default) grants access as soon as there is one voter granting access;consensusgrants access if there are more voters granting access than there are denying;unanimousonly grants access if none of the voters has denied access;
See https://symfony.com/doc/current/components/security/authorization.html#access-decision-manager
There was a problem hiding this comment.
The access decision strategy defines how the result looks like when multiple voters voted on a certain attribute. It does not affect the internal behaviour of the RoleVoter.
There was a problem hiding this comment.
Umh you're right, I've mistakenly confused the two things. Thanks for spotting it.
This improves the doc for the
is_grantedTwig function. Under the hood, it callsAuthorizationChecker::isGranted()which accepts multiple attributes to be checked, but that's not clear. I've referred to the only other part of the doc where this is clear.