Improve security factory signatures #49783
Merged
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
yguedidi
changed the title
fabpot
reviewed
Mar 23, 2023
| @@ -38,6 +38,8 @@ public function addConfiguration(NodeDefinition $builder); | |||
| /** | |||
| * Creates the authenticator service(s) for the provided configuration. | |||
| * | |||
| * @param array<string, mixed> $config | |||
There was a problem hiding this comment.
Is it valuable? It may not help our users. Or maybe it is for static analysis tools?
We try to only add phpdocs when they bring value.
There was a problem hiding this comment.
my bad, missed adding a precise context! thanks for asking!
Or maybe it is for static analysis tools?
Yes it's for static analysis (in my case PHPStan). We implement this interface, and with PHPStan at level 6 with strict-rules, especially the reportMaybesInMethodSignatures: true parameter, we get these errors:
------ -------------------------------------------------------------------------------------------------------------------------
Line src/App/DependencyInjection/Security/Factory/MyFactory.php
------ -------------------------------------------------------------------------------------------------------------------------
17 Parameter #3 $config (array<string, mixed>) of method
App\DependencyInjection\Security\Factory\MyFactory::createAuthenticator()
should be contravariant with parameter $config (array) of method
Symfony\Bundle\SecurityBundle\DependencyInjection\Security\Factory\AuthenticatorFactoryInterface::createAuthenticator()
25 Parameter #3 $config (array<string, mixed>) of method
App\DependencyInjection\Security\Factory\MyFactory::createListeners()
should be contravariant with parameter $config (array) of method
Symfony\Bundle\SecurityBundle\DependencyInjection\Security\Factory\FirewallListenerFactoryInterface::createListeners()
------ -------------------------------------------------------------------------------------------------------------------------
fabpot
approved these changes
Mar 25, 2023
carsonbot
changed the title
|
Thank you @yguedidi. |
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.
Adds key type to the config parameter of security factories