add containsKey alias

azjezz · Aug 30, 2024 · def70e0 · def70e0
1 parent ce10be4
commit def70e0
Show file tree

Hide file tree

Showing 9 changed files with 91 additions and 2 deletions.
diff --git a/src/Psl/Collection/IndexAccessInterface.php b/src/Psl/Collection/IndexAccessInterface.php
@@ -34,6 +34,17 @@ public function at(int|string $k): mixed;
      */
     public function contains(int|string $k): bool;
 
+    /**
+     * Alias of `contains`.
+     *
+     * @param Tk $k
+     *
+     * @see contains() method
+     *
+     * @psalm-mutation-free
+     */
+    public function containsKey(int|string $k): bool;
+
     /**
      * Returns the value at the specified key in the current collection.
      *

diff --git a/src/Psl/Collection/Map.php b/src/Psl/Collection/Map.php
@@ -253,6 +253,18 @@ public function contains(int|string $k): bool
         return array_key_exists($k, $this->elements);
     }
 
+    /**
+     * Alias of `contains`.
+     *
+     * @param Tk $k
+     *
+     * @psalm-mutation-free
+     */
+    public function containsKey(int|string $k): bool
+    {
+        return $this->contains($k);
+    }
+
     /**
      * Returns the value at the specified key in the current map.
      *

diff --git a/src/Psl/Collection/MutableMap.php b/src/Psl/Collection/MutableMap.php
@@ -253,6 +253,18 @@ public function contains(int|string $k): bool
         return array_key_exists($k, $this->elements);
     }
 
+    /**
+     * Alias of `contains`.
+     *
+     * @param Tk $k
+     *
+     * @psalm-mutation-free
+     */
+    public function containsKey(int|string $k): bool
+    {
+        return $this->contains($k);
+    }
+
     /**
      * Returns the value at the specified key in the current map.
      *

diff --git a/src/Psl/Collection/MutableSet.php b/src/Psl/Collection/MutableSet.php
@@ -233,6 +233,20 @@ public function contains(int|string $k): bool
         return array_key_exists($k, $this->elements);
     }
 
+    /**
+     * Alias of `contains`.
+     *
+     * @param T $k
+     *
+     * @return bool True if the value is in the set, false otherwise.
+     *
+     * @psalm-mutation-free
+     */
+    public function containsKey(int|string $k): bool
+    {
+        return $this->contains($k);
+    }
+
     /**
      * Returns the provided value if it is part of the set, or null if it is not.
      *

diff --git a/src/Psl/Collection/MutableVector.php b/src/Psl/Collection/MutableVector.php
@@ -204,6 +204,18 @@ public function contains(int|string $k): bool
         return array_key_exists($k, $this->elements);
     }
 
+    /**
+     * Alias of `contains`.
+     *
+     * @param int<0, max> $k
+     *
+     * @psalm-mutation-free
+     */
+    public function containsKey(int|string $k): bool
+    {
+        return $this->contains($k);
+    }
+
     /**
      * Returns the value at the specified key in the current `MutableVector`.
      *

diff --git a/src/Psl/Collection/Set.php b/src/Psl/Collection/Set.php
@@ -236,6 +236,20 @@ public function contains(int|string $k): bool
         return array_key_exists($k, $this->elements);
     }
 
+    /**
+     * Alias of `contains`.
+     *
+     * @param T $k
+     *
+     * @return bool True if the value is in the set, false otherwise.
+     *
+     * @psalm-mutation-free
+     */
+    public function containsKey(int|string $k): bool
+    {
+        return $this->contains($k);
+    }
+
     /**
      * Returns the provided value if it is part of the set, or null if it is not.
      *

diff --git a/src/Psl/Collection/Vector.php b/src/Psl/Collection/Vector.php
@@ -204,6 +204,18 @@ public function contains(int|string $k): bool
         return array_key_exists($k, $this->elements);
     }
 
+    /**
+     * Alias of `contains`.
+     *
+     * @param int<0, max> $k
+     *
+     * @psalm-mutation-free
+     */
+    public function containsKey(int|string $k): bool
+    {
+        return $this->contains($k);
+    }
+
     /**
      * Returns the value at the specified key in the current `Vector`.
      *

diff --git a/tests/unit/Collection/MutableMapTest.php b/tests/unit/Collection/MutableMapTest.php
@@ -235,7 +235,8 @@ public function testOffsetGetThrowsForInvalidOffsetType(): void
         $map[false];
     }
 
-    public function testFromItems(): void {
+    public function testFromItems(): void
+    {
         $map = MutableMap::fromItems([
             'foo' => 'bar',
             'bar' => 'baz',

diff --git a/tests/unit/Collection/SetTest.php b/tests/unit/Collection/SetTest.php
@@ -15,7 +15,8 @@ final class SetTest extends AbstractSetTest
      */
     protected string $setClass = Set::class;
 
-    public function testFromItems(): void {
+    public function testFromItems(): void
+    {
         $set = Set::fromItems([
             'foo',
             'bar',