Lists::getAssignments(): improve the return value - #129
Merged
Conversation
⚠️ **BREAKING CHANGE**⚠️ In the initial commit, the `Lists::getAssignments()` method would have three different arrays as potential output. 1. An array with just the `raw` and `is_empty` keys for an empty list item. 2. An array with the above + detailed information about the assignments for non-keyed list items. 3. An array with the above + detail information about the keys found for keyed list items. This meant that - aside from for the `raw` and `is_empty` keys -, a dev looping over the list items would always need to do an `isset()` check for each array index before the value could be compared or used. That made the method return value fiddly to work with. In this commit, the above three different arrays is now reduced to two different arrays (type 2 and 3) with either an empty string or `false` as the default value for all keys. Additionally: * The `nested_list` index key has been renamed to `is_nested_list` to make it clearer that this will be a boolean value and not the detailed information about the nested list. * And while this will rarely be relevant for sniffs implementing this method, the order of the array indexes in the return array has also been adjusted. Includes updated unit tests.
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
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.
In the initial commit, the
Lists::getAssignments()method would have three different arrays as potential output.rawandis_emptykeys for an empty list item.This meant that - aside from for the
rawandis_emptykeys -, a dev looping over the list items would always need to do anisset()check for each array index before the value could be compared or used.That made the method return value fiddly to work with.
In this commit, the above three different arrays is now reduced to two different arrays (type 2 and 3) with either an empty string or
falseas the default value for all keys.Additionally:
nested_listindex key has been renamed tois_nested_listto make it clearer that this will be a boolean value and not the detailed information about the nested list.Includes updated unit tests.