[11.x] Document returned array shape for sync methods #52070
Merged
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
calebdw
reviewed
Jul 10, 2024
| @@ -67,7 +67,7 @@ public function toggle($ids, $touch = true) | |||
| * Sync the intermediate tables with a list of IDs without detaching. | |||
| * | |||
| * @param \Illuminate\Support\Collection|\Illuminate\Database\Eloquent\Model|array $ids | |||
| * @return array | |||
| * @return array{attached: array, detached: array, updated: array} | |||
There was a problem hiding this comment.
All of the array inner types should really be defined (e.g., array<string, mixed> for instance)
There was a problem hiding this comment.
I agree, but I don't think we can be more specific than array<array-key, mixed>, which is the same as array.
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.
I've documented the returned array shape for
sync(),syncWithoutDetaching(), andsyncWithPivotValues(). This helps with autocompletion and static analysis.Here's an example from PhpStorm: