Rename findOne to findFirst

doctrine · Feb 15, 2021 · 7896f29 · 7896f29
1 parent 893f828
commit 7896f29
Show file tree

Hide file tree

Showing 6 changed files with 21 additions and 15 deletions.
diff --git a/docs/en/index.rst b/docs/en/index.rst
@@ -148,15 +148,15 @@ Tests for the existence of an element that satisfies the given predicate.
         return $value === 'first';
     }); // true
 
-findOne
--------
+findFirst
+---------
 
 Returns the first element of this collection that satisfies the given predicate.
 
 .. code-block:: php
     $collection = new Collection([1, 2, 3, 2, 1]);
 
-    $one = $collection->findOne(function(int $key, int $value): bool {
+    $one = $collection->findFirst(function(int $key, int $value): bool {
         return $value > 2 && $key > 1;
     }); // 3
 

diff --git a/lib/Doctrine/Common/Collections/AbstractLazyCollection.php b/lib/Doctrine/Common/Collections/AbstractLazyCollection.php
@@ -204,11 +204,14 @@ public function exists(Closure $p): bool
         return $this->collection->exists($p);
     }
 
-    public function findOne(Closure $func)
+    /**
+     * {@inheritDoc}
+     */
+    public function findFirst(Closure $func)
     {
         $this->initialize();
 
-        return $this->collection->findOne($func);
+        return $this->collection->findFirst($func);
     }
 
     /**

diff --git a/lib/Doctrine/Common/Collections/ArrayCollection.php b/lib/Doctrine/Common/Collections/ArrayCollection.php
@@ -370,7 +370,10 @@ public function filter(Closure $p): Collection
         return $this->createFrom(array_filter($this->elements, $p, ARRAY_FILTER_USE_BOTH));
     }
 
-    public function findOne(Closure $p)
+    /**
+     * {@inheritDoc}
+     */
+    public function findFirst(Closure $p)
     {
         foreach ($this->elements as $key => $element) {
             if ($p($key, $element)) {

diff --git a/lib/Doctrine/Common/Collections/Collection.php b/lib/Doctrine/Common/Collections/Collection.php
@@ -223,7 +223,7 @@ public function exists(Closure $p): bool;
      * @psalm-param Closure(TKey=, T=):bool $p
      * @psalm-return T|null
      */
-    public function findOne(Closure $p);
+    public function findFirst(Closure $p);
 
     /**
      * Returns all the elements of this collection that satisfy the predicate p.

diff --git a/tests/Doctrine/Tests/Common/Collections/BaseArrayCollectionTest.php b/tests/Doctrine/Tests/Common/Collections/BaseArrayCollectionTest.php
@@ -278,22 +278,22 @@ public function testExists(): void
         }), 'Element not exists');
     }
 
-    public function testFindOne(): void
+    public function testFindFirst(): void
     {
         $elements   = [1, 'A' => 'a', 2, 'null' => null, 3, 'A2' => 'a', 'zero' => 0];
         $collection = $this->buildCollection($elements);
 
-        self::assertSame('a', $collection->findOne(static function ($key, $element) {
+        self::assertSame('a', $collection->findFirst(static function ($key, $element) {
             return $key === 'A' && $element === 'a';
         }), 'Element exists');
     }
 
-    public function testFindOneNotFound(): void
+    public function testFindFirstNotFound(): void
     {
         $elements   = [1, 'A' => 'a', 2, 'null' => null, 3, 'A2' => 'a', 'zero' => 0];
         $collection = $this->buildCollection($elements);
 
-        self::assertNull($collection->findOne(static function ($key, $element) {
+        self::assertNull($collection->findFirst(static function ($key, $element) {
             return $key === 'non-existent' && $element === 'non-existent';
         }), 'Element does not exists');
     }

diff --git a/tests/Doctrine/Tests/Common/Collections/BaseCollectionTest.php b/tests/Doctrine/Tests/Common/Collections/BaseCollectionTest.php
@@ -46,21 +46,21 @@ public function testExists(): void
         self::assertFalse($exists);
     }
 
-    public function testFindOne(): void
+    public function testFindFirst(): void
     {
         $this->collection->add('one');
         $this->collection->add('two');
-        $one = $this->collection->findOne(static function ($k, $e) {
+        $one = $this->collection->findFirst(static function ($k, $e) {
             return $e === 'one';
         });
         self::assertSame('one', $one);
     }
 
-    public function testFindOneNotFound(): void
+    public function testFindFirstNotFound(): void
     {
         $this->collection->add('one');
         $this->collection->add('two');
-        $other = $this->collection->findOne(static function ($k, $e) {
+        $other = $this->collection->findFirst(static function ($k, $e) {
             return $e === 'other';
         });
         self::assertNull($other);