Merge release 2.1.4 into 3.0.x

.gitattributes

@@ -1,5 +1,6 @@
 /tests export-ignore
 /.github export-ignore
+.doctrine-project.json export-ignore
 .gitattributes export-ignore
 .gitignore export-ignore
 .scrutinizer.yml export-ignore

composer.json

@@ -38,7 +38,7 @@
     },
     "require-dev": {
         "ext-json": "*",
-        "doctrine/coding-standard": "^10.0",
+        "doctrine/coding-standard": "^12",
         "phpstan/phpstan": "^1.8",
         "phpstan/phpstan-phpunit": "^1.0",
         "phpunit/phpunit": "^9.5",

phpcs.xml.dist

@@ -14,7 +14,10 @@
     <file>src</file>
     <file>tests</file>
 
-    <rule ref="Doctrine" />
+    <rule ref="Doctrine" >
+        <!-- https://github.com/doctrine/collections/pull/381#issuecomment-1745206747 -->
+        <exclude name="SlevomatCodingStandard.Commenting.UselessInheritDocComment" />
+    </rule>
 
     <rule ref="PSR1.Classes.ClassDeclaration.MultipleClasses">
         <exclude-pattern>tests/*</exclude-pattern>

src/AbstractLazyCollection.php

@@ -178,12 +178,9 @@ public function findFirst(Closure $p): mixed
     }
 
     /**
-     * @psalm-param Closure(T, TKey):bool $p
-     *
-     * @return ReadableCollection<mixed>
-     * @psalm-return ReadableCollection<TKey, T>
+     * {@inheritDoc}
      */
-    public function filter(Closure $p): ReadableCollection
+    public function filter(Closure $p): Collection
     {
         $this->initialize();
 
@@ -198,14 +195,9 @@ public function forAll(Closure $p): bool
     }
 
     /**
-     * @psalm-param Closure(T):U $func
-     *
-     * @return ReadableCollection<mixed>
-     * @psalm-return ReadableCollection<TKey, U>
-     *
-     * @psalm-template U
+     * {@inheritDoc}
      */
-    public function map(Closure $func): ReadableCollection
+    public function map(Closure $func): Collection
     {
         $this->initialize();
 

src/Collection.php

@@ -5,6 +5,7 @@
 namespace Doctrine\Common\Collections;
 
 use ArrayAccess;
+use Closure;
 
 /**
  * The missing (SPL) Collection/Array/OrderedMap interface.
@@ -73,4 +74,34 @@ public function removeElement(mixed $element): bool;
      * @psalm-param T $value
      */
     public function set(string|int $key, mixed $value): void;
+
+    /**
+     * {@inheritDoc}
+     *
+     * @psalm-param Closure(T):U $func
+     *
+     * @return Collection<mixed>
+     * @psalm-return Collection<TKey, U>
+     *
+     * @psalm-template U
+     */
+    public function map(Closure $func): self;
+
+    /**
+     * {@inheritDoc}
+     *
+     * @return Collection<mixed> A collection with the results of the filter operation.
+     * @psalm-return Collection<TKey, T>
+     */
+    public function filter(Closure $p): self;
+
+    /**
+     * {@inheritDoc}
+
+     * @return Collection<mixed>[] An array with two elements. The first element contains the collection
+     *                      of elements where the predicate returned TRUE, the second element
+     *                      contains the collection of elements where the predicate returned FALSE.
+     * @psalm-return array{0: Collection<TKey, T>, 1: Collection<TKey, T>}
+     */
+    public function partition(Closure $p): array;
 }