Lists::getAssignments(): improve the return value #129
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.raw
andis_empty
keys for an empty list item.This meant that - aside from for the
raw
andis_empty
keys -, 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
false
as the default value for all keys.Additionally:
nested_list
index key has been renamed tois_nested_list
to make it clearer that this will be a boolean value and not the detailed information about the nested list.Includes updated unit tests.