Skip to content

[12.x] Fix PHPDoc for Arr::sole method#56096

Merged
taylorotwell merged 2 commits into
laravel:12.xfrom
AhmedAlaa4611:correct-collection-to-array
Jun 22, 2025
Merged

[12.x] Fix PHPDoc for Arr::sole method#56096
taylorotwell merged 2 commits into
laravel:12.xfrom
AhmedAlaa4611:correct-collection-to-array

Conversation

@AhmedAlaa4611

Copy link
Copy Markdown
Contributor

Description

This PR corrects the PHPDoc comment for the Illuminate\Support\Arr::sole method.

  • Updates the word collection to array, which better reflects the actual data type the method operates on.
  • Updates the @param tag for the $callback argument to callable|null to match the method signature.

These changes improve code clarity and align the documentation with the method's actual behavior.

@shaedrich shaedrich left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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

Comment thread src/Illuminate/Collections/Arr.php Outdated
Co-authored-by: Sebastian Hädrich <11225821+shaedrich@users.noreply.github.com>
@taylorotwell taylorotwell merged commit 82a86ac into laravel:12.x Jun 22, 2025
59 of 60 checks passed
mohammad-fouladgar pushed a commit to mohammad-fouladgar/framework that referenced this pull request Jul 22, 2025
* Fix PHPDoc for Arr::sole method

* Update src/Illuminate/Collections/Arr.php

Co-authored-by: Sebastian Hädrich <11225821+shaedrich@users.noreply.github.com>

---------

Co-authored-by: Taylor Otwell <taylor@laravel.com>
Co-authored-by: Sebastian Hädrich <11225821+shaedrich@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants