[12.x] Fix PHPDoc for Arr::sole method #56096
Open
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
shaedrich
reviewed
Jun 21, 2025
There was a problem hiding this comment.
If you wanted, you could significantly shorten the method body as well
public static function sole($array, ?callable $callback = null)
{
if ($callback) {
$array = static::where($array, $callback);
}
- $count = count($array);
-
- if ($count === 0) {
- throw new ItemNotFoundException;
- }
-
- if ($count > 1) {
- throw new MultipleItemsFoundException($count);
- }
-
- return static::first($array);
+ return match ($count = count($array)) {
+ 0 => new ItemNotFoundException,
+ 1 => static::first($array),
+ default => new MultipleItemsFoundException($count),
+ };
}but that would probably be a bit out of scope
| * | ||
| * @param array $array | ||
| * @param callable $callback | ||
| * @param callable|null $callback |
There was a problem hiding this comment.
You could arrow this down even further:
Suggested change
| * @param callable|null $callback | |
| * @param callable(mixed, array-key): array|null $callback |
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.
Description
This PR corrects the PHPDoc comment for the
Illuminate\Support\Arr::solemethod.collectiontoarray, which better reflects the actual data type the method operates on.@paramtag for the$callbackargument tocallable|nullto match the method signature.These changes improve code clarity and align the documentation with the method's actual behavior.