[Documentation][Voter] updated documentation for CacheableVoterInterface #19531
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
MrYamous
reviewed
Mar 1, 2024
Comment on lines
+38
to
+39
| :class:`Symfony\\Component\\Security\\Core\\Authorization\\Voter\\VoterInterface`, | ||
| :class:`Symfony\\Component\\Security\\Core\\Authorization\\Voter\\CacheableVoterInterface` |
There was a problem hiding this comment.
Suggested change
| :class:`Symfony\\Component\\Security\\Core\\Authorization\\Voter\\VoterInterface`, | |
| :class:`Symfony\\Component\\Security\\Core\\Authorization\\Voter\\CacheableVoterInterface` | |
| :class:`Symfony\\Component\\Security\\Core\\Authorization\\Voter\\VoterInterface` or | |
| :class:`Symfony\\Component\\Security\\Core\\Authorization\\Voter\\CacheableVoterInterface` |
I'm not sure about why Voter implements both interfaces explicitly but since CacheableVoterInterface extends VoterInterface perhaps the documentation can mention that only one is needed ?
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 that the Voter documentation, in particular the code illustrating the point "The Voter Interface", was not update. To explain further, in the Voter.php file on GitHub, we've also been implementing "CacheableVoterInterface" since Symfony 5.4.
So I'd like to suggest this change to the documentation.