[DependencyInjection] Improve ParameterNotFoundException when accessing a nested parameter #19584
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
|
travis failure unrelated |
| @@ -30,12 +31,13 @@ class ParameterNotFoundException extends InvalidArgumentException | |||
| * @param \Exception $previous The previous exception | |||
| * @param string[] $alternatives Some parameter name alternatives | |||
| */ | |||
| public function __construct($key, $sourceId = null, $sourceKey = null, \Exception $previous = null, array $alternatives = array()) | |||
| public function __construct($key, $sourceId = null, $sourceKey = null, \Exception $previous = null, array $alternatives = array(), $nonNestedAlternative = null) | |||
There was a problem hiding this comment.
$nonNestedAlternative should be added to docblock, no?
A common problem under beginners is to think that the dot notation is used to access nested arrays saved in parameters. Adding a little extra detail to the exception message and a working alternative should help pointing these people in the right direction before spending time debugging this.
1986299 to
f7a47d8
Compare
| throw new ParameterNotFoundException($name, null, null, null, $alternatives); | ||
| $nonNestedAlternative = null; | ||
| if (!count($alternatives) && false !== strpos($name, '.')) { | ||
| $namePartsLength = array_map('strlen', explode('.', $name)); |
There was a problem hiding this comment.
What about using implode ?
|
Thank you @wouterj. |
Merged
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.
A common problem under beginners is to think that the dot notation is used to access nested arrays saved in parameters (common here means someone asks help for this problem at least once a week on IRC). Adding a little extra detail to the exception message and a working alternative should help pointing these people in the right direction before spending time debugging this.
It's quite late in the night over here, so the wording of the exception message probably isn't great. I'm happy to accept better suggestions 😃