Throw if a variadic parameter contains unexpected named arguments #11260
Conversation
This file contains 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
greg0ire
approved these changes
Feb 13, 2024
derrabus
added a commit
to derrabus/orm
that referenced
this pull request
Feb 21, 2024
* 3.1.x: Fix Static Analysis folder reference (doctrine#11281) Remove broken assertion from DateAddFunction and DateSubFunction (doctrine#11243) Account for inversedBy being a non-falsy-string or null Improve static analysis on AttachEntityListenersListener docs: recommend safer way to disable logging (doctrine#11269) Remove unused baseline entries Treat '0' as a legitimate trim char Add type field mapper documentation to the sidebar Mark document as orphan Use correction sectionauthor syntax Remove unused trait [Documentation] Adding link to Postgres upgrade article (doctrine#11257) Validate more variadic parameters (doctrine#11261) Throw if a variadic parameter contains unexpected named arguments (doctrine#11260) Make docs valid according to guides 0.3.3 (doctrine#11252) fix: support array-type arg in QB variadic calls (doctrine#11242)
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.
Fixes #11253.
If a method signature has a variadic parameter, you can call that method with any arbitrary named argument that you want. Hooray. However, our codebase rarely expects that and doing so sometimes raises error messages about invalid array access and similar issues.
This practice could also hide typos in named argument calls.
In order to improve the DX on those methods, I'd like to guard the calls to those methods by introducing a trait that validates if a variadic parameter contains any named arguments. If it finds any, an exception is raised that reports those arguments.
I've started with the
QueryBuilderclass, but I could extend this change to other classes if we agree that this is what we want.