[9.x] Let Multiple* exceptions hold the number of records and items f…

…ound (#41164) * Let Multiple* exceptions hold the number of records and items found. * formatting Co-authored-by: Taylor Otwell <taylor@laravel.com>
laravel · Feb 22, 2022 · 5ba19a2 · 5ba19a2
1 parent 7e0d9a6
commit 5ba19a2
Show file tree

Hide file tree

Showing 8 changed files with 81 additions and 14 deletions.
diff --git a/src/Illuminate/Collections/Collection.php b/src/Illuminate/Collections/Collection.php
@@ -1208,12 +1208,14 @@ public function sole($key = null, $operator = null, $value = null)
 
         $items = $this->unless($filter == null)->filter($filter);
 
-        if ($items->isEmpty()) {
+        $count = $items->count();
+
+        if ($count === 0) {
             throw new ItemNotFoundException;
         }
 
-        if ($items->count() > 1) {
-            throw new MultipleItemsFoundException;
+        if ($count > 1) {
+            throw new MultipleItemsFoundException($count);
         }
 
         return $items->first();

diff --git a/src/Illuminate/Collections/MultipleItemsFoundException.php b/src/Illuminate/Collections/MultipleItemsFoundException.php
@@ -6,4 +6,35 @@
 
 class MultipleItemsFoundException extends RuntimeException
 {
+    /**
+     * The number of items found.
+     *
+     * @var int
+     */
+    public $count;
+
+    /**
+     * Create a new exception instance.
+     *
+     * @param  int  $count
+     * @param  int  $code
+     * @param  \Throwable|null  $previous
+     * @return void
+     */
+    public function __construct($count, $code = 0, $previous = null)
+    {
+        $this->count = $count;
+
+        parent::__construct("$count items were found.", $code, $previous);
+    }
+
+    /**
+     * Get the number of items found.
+     *
+     * @return int
+     */
+    public function getCount()
+    {
+        return $this->count;
+    }
 }
diff --git a/src/Illuminate/Database/Concerns/BuildsQueries.php b/src/Illuminate/Database/Concerns/BuildsQueries.php
@@ -309,12 +309,14 @@ public function sole($columns = ['*'])
     {
         $result = $this->take(2)->get($columns);
 
-        if ($result->isEmpty()) {
+        $count = $result->count();
+
+        if ($count === 0) {
             throw new RecordsNotFoundException;
         }
 
-        if ($result->count() > 1) {
-            throw new MultipleRecordsFoundException;
+        if ($count > 1) {
+            throw new MultipleRecordsFoundException($count);
         }
 
         return $result->first();

diff --git a/src/Illuminate/Database/Eloquent/Relations/Relation.php b/src/Illuminate/Database/Eloquent/Relations/Relation.php
@@ -171,12 +171,14 @@ public function sole($columns = ['*'])
     {
         $result = $this->take(2)->get($columns);
 
-        if ($result->isEmpty()) {
+        $count = $result->count();
+
+        if ($count === 0) {
             throw (new ModelNotFoundException)->setModel(get_class($this->related));
         }
 
-        if ($result->count() > 1) {
-            throw new MultipleRecordsFoundException;
+        if ($count > 1) {
+            throw new MultipleRecordsFoundException($count);
         }
 
         return $result->first();

diff --git a/src/Illuminate/Database/MultipleRecordsFoundException.php b/src/Illuminate/Database/MultipleRecordsFoundException.php
@@ -6,5 +6,35 @@
 
 class MultipleRecordsFoundException extends RuntimeException
 {
-    //
+    /**
+     * The number of records found.
+     *
+     * @var int
+     */
+    public $count;
+
+    /**
+     * Create a new exception instance.
+     *
+     * @param  int  $count
+     * @param  int  $code
+     * @param  \Throwable|null  $previous
+     * @return void
+     */
+    public function __construct($count, $code = 0, $previous = null)
+    {
+        $this->count = $count;
+
+        parent::__construct("$count records were found.", $code, $previous);
+    }
+
+    /**
+     * Get the number of records found.
+     *
+     * @return int
+     */
+    public function getCount()
+    {
+        return $this->count;
+    }
 }
diff --git a/tests/Integration/Database/EloquentWhereTest.php b/tests/Integration/Database/EloquentWhereTest.php
@@ -115,7 +115,7 @@ public function testSoleFailsForMultipleRecords()
             'address' => 'other-address',
         ]);
 
-        $this->expectException(MultipleRecordsFoundException::class);
+        $this->expectExceptionObject(new MultipleRecordsFoundException(2));
 
         UserWhereTest::where('name', 'test-name')->sole();
     }

diff --git a/tests/Integration/Database/QueryBuilderTest.php b/tests/Integration/Database/QueryBuilderTest.php
@@ -40,7 +40,7 @@ public function testSoleFailsForMultipleRecords()
             ['title' => 'Foo Post', 'content' => 'Lorem Ipsum.', 'created_at' => new Carbon('2017-11-12 13:14:15')],
         ]);
 
-        $this->expectException(MultipleRecordsFoundException::class);
+        $this->expectExceptionObject(new MultipleRecordsFoundException(2));
 
         DB::table('posts')->where('title', 'Foo Post')->sole();
     }

diff --git a/tests/Support/SupportCollectionTest.php b/tests/Support/SupportCollectionTest.php
@@ -104,7 +104,7 @@ public function testSoleThrowsExceptionIfNoItemsExist($collection)
      */
     public function testSoleThrowsExceptionIfMoreThanOneItemExists($collection)
     {
-        $this->expectException(MultipleItemsFoundException::class);
+        $this->expectExceptionObject(new MultipleItemsFoundException(2));
 
         $collection = new $collection([
             ['name' => 'foo'],
@@ -146,7 +146,7 @@ public function testSoleThrowsExceptionIfNoItemsExistWithCallback($collection)
      */
     public function testSoleThrowsExceptionIfMoreThanOneItemExistsWithCallback($collection)
     {
-        $this->expectException(MultipleItemsFoundException::class);
+        $this->expectExceptionObject(new MultipleItemsFoundException(2));
 
         $data = new $collection(['foo', 'bar', 'bar']);