[Form] Fix return type of FormErrorIterator::getChildren() #42301
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
xabbuh
reviewed
Jul 28, 2021
| @@ -205,7 +205,7 @@ public function hasChildren() | |||
| /** | |||
| * Alias of {@link current()}. | |||
| * | |||
| * @return self | |||
| * @return FormError|self | |||
There was a problem hiding this comment.
IMO self is correct as logically one should only call getChildren() when there are actual child nodes (which in the method above is a check for the current element being an instance of FormErrorIterator.
Maybe the method should throw if the current item is not iterable.
There was a problem hiding this comment.
Maybe the method should throw if the current item is not iterable.
Makes sense. Should this be considered a BC break or rather a bugfix?
There was a problem hiding this comment.
I would vote for triggering a deprecation in 5.4 and add the exception in 6.0.
There was a problem hiding this comment.
Okay, I will open MRs for 5.4 and 6.0 soon
fabpot
added a commit
that referenced
this pull request
Aug 15, 2021
… if the current element is not iterable (W0rma) This PR was merged into the 5.4 branch. Discussion ---------- [Form] Deprecate calling FormErrorIterator::children() if the current element is not iterable | Q | A | ------------- | --- | Branch? | 5.4 for features | Bug fix? | yes | New feature? | no | Deprecations? | yes | Tickets | #42301 (comment) | License | MIT | Doc PR | Commits ------- d8e74fc * Deprecated calling `FormErrorIterator::children()` if the current element is not iterable
symfony-splitter
pushed a commit
to symfony/form
that referenced
this pull request
Aug 15, 2021
… if the current element is not iterable (W0rma) This PR was merged into the 5.4 branch. Discussion ---------- [Form] Deprecate calling FormErrorIterator::children() if the current element is not iterable | Q | A | ------------- | --- | Branch? | 5.4 for features | Bug fix? | yes | New feature? | no | Deprecations? | yes | Tickets | symfony/symfony#42301 (comment) | License | MIT | Doc PR | Commits ------- d8e74fc8df * Deprecated calling `FormErrorIterator::children()` if the current element is not iterable
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.
3c578b1 added
selfreturn type toFormErrorIterator::getChildren().However, from the constructor I assume that this method can return either
selfor an instance ofFormError.