[9.x] Add sole() to Enumerable contract. (#37066)

ash-jc-allen · taylorotwell · web-flow · commit e769e3d2d37f · 2021-04-21T08:12:57.000-05:00
* Added sole() to Enumerable contract.

* Update Enumerable.php

Co-authored-by: Taylor Otwell &lt;taylor@laravel.com&gt;
diff --git a/src/Illuminate/Collections/Enumerable.php b/src/Illuminate/Collections/Enumerable.php
@@ -808,6 +808,19 @@ public function slice($offset, $length = null);
      */
     public function split($numberOfGroups);
 
+    /**
+     * Get the first item in the collection, but only if exactly one item exists. Otherwise, throw an exception.
+     *
+     * @param  mixed  $key
+     * @param  mixed  $operator
+     * @param  mixed  $value
+     * @return mixed
+     *
+     * @throws \Illuminate\Collections\ItemNotFoundException
+     * @throws \Illuminate\Collections\MultipleItemsFoundException
+     */
+    public function sole($key = null, $operator = null, $value = null);
+
     /**
      * Chunk the collection into chunks of the given size.
      *
