Merge pull request #72 from aeviiq/master

update 3.2

Author: aeviiq

src/Collection.php

@@ -6,37 +6,37 @@
 use Aeviiq\Collection\Exception\LogicException;
 
 /**
- * @psalm-template TKey as array-key
- * @psalm-template TValue
+ * @template TKey as array-key
+ * @template TValue
  * @phpstan-template TKey
  * @phpstan-template TValue
  *
- * @psalm-implements CollectionInterface<TKey, TValue>
+ * @implements CollectionInterface<TKey, TValue>
  * @phpstan-implements CollectionInterface<TKey, TValue>
  */
 class Collection implements CollectionInterface
 {
     /**
-     * @psalm-var array<TKey, TValue>
+     * @var array<TKey, TValue>
      * @phpstan-var array<TKey, TValue>
      *
      * @var array<string|int, mixed>
      */
     private $elements;
 
     /**
-     * @psalm-var class-string<\ArrayAccess>|string
+     * @var class-string<\ArrayAccess>|string
      * @phpstan-var class-string<\ArrayAccess>|string
      *
      * @var string
      */
     private $iteratorClass;
 
     /**
-     * @psalm-param array<TKey, TValue> $elements
+     * @param array<TKey, TValue> $elements
      * @phpstan-param array<TKey, TValue> $elements
      *
-     * @psalm-param class-string<\ArrayAccess>|string $iteratorClass
+     * @param class-string<\ArrayAccess>|string $iteratorClass
      * @phpstan-param class-string<\ArrayAccess>|string $iteratorClass
      *
      * @param array<string|int, mixed> $elements
@@ -79,7 +79,7 @@ public function last()
     public function remove($element): void
     {
         /**
-         * @psalm-var TKey $key
+         * @var TKey $key
          * @phpstan-var TKey $key
          */
         $key = \array_search($element, $this->elements, true);
@@ -157,7 +157,7 @@ public function clear(): void
     public function getKeys(): array
     {
         /**
-         * @psalm-var array<int, TKey>
+         * @var array<int, TKey>
          * @phpstan-var array<int, TKey>
          */
         return \array_keys($this->elements);
@@ -343,7 +343,7 @@ public function uksort(callable $func): void
     }
 
     /**
-     * @psalm-param TValue $element
+     * @param TValue $element
      * @phpstan-param TValue $element
      *
      * @param mixed $element
@@ -355,12 +355,10 @@ protected function validateElement($element): void
     }
 
     /**
-     * @psalm-param array<TKey, TValue> $elements
      * @phpstan-param array<TKey, TValue> $elements
      *
      * @param array<string|int, mixed> $elements
      *
-     * @psalm-return self<TKey, TValue>
      * @phpstan-return self<TKey, TValue>
      */
     protected function createFrom(array $elements): self
@@ -369,7 +367,7 @@ protected function createFrom(array $elements): self
     }
 
     /**
-     * @psalm-param array<TKey, TValue> $elements
+     * @param array<TKey, TValue> $elements
      * @phpstan-param array<TKey, TValue> $elements
      *
      * @param array<string|int, mixed> $elements

src/CollectionInterface.php

@@ -6,44 +6,40 @@
 use Aeviiq\Collection\Exception\LogicException;
 
 /**
- * @psalm-template TKey as array-key
- * @psalm-template TValue
+ * @template         TKey as array-key
+ * @template         TValue
  * @phpstan-template TKey
  * @phpstan-template TValue
  *
- * @psalm-extends \IteratorAggregate<TKey, TValue>
- * @psalm-extends \ArrayAccess<TKey, TValue>
+ * @extends \IteratorAggregate<TKey, TValue>
+ * @extends \ArrayAccess<TKey, TValue>
  * @phpstan-extends \IteratorAggregate<TKey, TValue>
  * @phpstan-extends \ArrayAccess<TKey, TValue>
  */
 interface CollectionInterface extends SortableInterface, \IteratorAggregate, \ArrayAccess, \Countable
 {
     /**
-     * @psalm-return array<TKey, TValue>
      * @phpstan-return array<TKey, TValue>
      *
      * @return array<string|int, mixed>
      */
     public function toArray(): array;
 
     /**
-     * @psalm-return TValue|null
      * @phpstan-return TValue|null
      *
      * @return mixed The first element in the collection or null if there is none.
      */
     public function first();
 
     /**
-     * @psalm-return TValue|null
      * @phpstan-return TValue|null
      *
      * @return mixed The last element in the collection or null if there is none.
      */
     public function last();
 
     /**
-     * @psalm-param TValue $element
      * @phpstan-param TValue $element
      *
      * @param mixed $element The value of the element you wish to remove.
@@ -52,15 +48,13 @@ public function last();
     public function remove($element): void;
 
     /**
-     * @psalm-return array<TKey, mixed>
      * @phpstan-return array<TKey, mixed>
      *
      * @return array<string|int, mixed>
      */
     public function map(\Closure $closure): array;
 
     /**
-     * @psalm-return self<TKey, TValue>
      * @phpstan-return self<TKey, TValue>
      */
     public function filter(\Closure $closure): CollectionInterface;
@@ -69,9 +63,6 @@ public function filter(\Closure $closure): CollectionInterface;
      * Merges the input with the collection. This can take an array with valid values or
      * an instance of the collection itself.
      *
-     * @psalm-param array<TKey, TValue>|self<TKey, TValue> $input
-     * @phpstan-param array<TKey, TValue>|self<TKey, TValue> $input
-     *
      * @param array<string|int, mixed>|CollectionInterface $input
      *
      * @throws InvalidArgumentException When the $input is not of the expected type(s).
@@ -84,7 +75,6 @@ public function merge($input): void;
     public function isEmpty(): bool;
 
     /**
-     * @psalm-param TValue $element
      * @phpstan-param TValue $element
      *
      * @param mixed $element
@@ -99,23 +89,20 @@ public function contains($element): bool;
     public function clear(): void;
 
     /**
-     * @psalm-return array<int, TKey>
      * @phpstan-return array<int, TKey>
      *
      * @return array<int, int|string>
      */
     public function getKeys(): array;
 
     /**
-     * @psalm-return array<int, TValue>
      * @phpstan-return array<int, TValue>
      *
      * @return array<int, mixed>
      */
     public function getValues(): array;
 
     /**
-     * @psalm-return TValue
      * @phpstan-return TValue
      *
      * @return mixed The one element that was found using the closure.
@@ -125,15 +112,13 @@ public function getValues(): array;
     public function getOneBy(\Closure $closure);
 
     /**
-     * @psalm-return TValue|null
      * @phpstan-return TValue|null
      *
      * @return mixed The one element that was found using the closure or null if none was found.
      */
     public function getOneOrNullBy(\Closure $closure);
 
     /**
-     * @psalm-param array<TKey, TValue> $elements
      * @phpstan-param array<TKey, TValue> $elements
      *
      * @param array<string|int, mixed> $elements
@@ -143,23 +128,20 @@ public function getOneOrNullBy(\Closure $closure);
     public function exchangeArray(array $elements): void;
 
     /**
-     * @psalm-param TValue $element
      * @phpstan-param TValue $element
      *
      * @param mixed $element
      */
     public function append($element): void;
 
     /**
-     * @psalm-param class-string<ArrayAccess>|string $iteratorClass
      * @phpstan-param class-string<ArrayAccess>|string $iteratorClass
      *
      * @throws InvalidArgumentException When the given iterator class does not implement ArrayAccess.
      */
     public function setIteratorClass(string $iteratorClass): void;
 
     /**
-     * @psalm-return self<TKey, TValue>
      * @phpstan-return self<TKey, TValue>
      */
     public function copy(): CollectionInterface;

src/FloatCollection.php

@@ -5,7 +5,7 @@
 use Aeviiq\Collection\Exception\InvalidArgumentException;
 
 /**
- * @psalm-extends Collection<array-key, float>
+ * @extends Collection<array-key, float>
  * @phpstan-extends Collection<array-key, float>
  *
  * @method \ArrayIterator|array<string|int, float> getIterator()

src/ImmutableCollection.php

@@ -5,12 +5,12 @@
 use Aeviiq\Collection\Exception\BadMethodCallException;
 
 /**
- * @psalm-template TKey as array-key
- * @psalm-template TValue
+ * @template TKey as array-key
+ * @template TValue
  * @phpstan-template TKey
  * @phpstan-template TValue
  *
- * @psalm-extends Collection<TKey, TValue>
+ * @extends Collection<TKey, TValue>
  * @phpstan-extends Collection<TKey, TValue>
  */
 class ImmutableCollection extends Collection

src/ImmutableObjectCollection.php

@@ -5,12 +5,12 @@
 use Aeviiq\Collection\Exception\InvalidArgumentException;
 
 /**
- * @psalm-template TKey as array-key
- * @psalm-template TValue of object
+ * @template TKey as array-key
+ * @template TValue of object
  * @phpstan-template TKey
  * @phpstan-template TValue of object
  *
- * @psalm-extends ImmutableCollection<TKey, TValue>
+ * @extends ImmutableCollection<TKey, TValue>
  * @phpstan-extends ImmutableCollection<TKey, TValue>
  */
 class ImmutableObjectCollection extends ImmutableCollection
@@ -33,7 +33,6 @@ protected function validateElement($element): void
     /**
      * If this is kept empty, any element can be passed, as long as it is an object.
      *
-     * @psalm-return class-string<TValue>|string
      * @phpstan-return class-string<TValue>|string
      *
      * @return string The class name of the allowed object instance.

src/IntCollection.php

@@ -5,7 +5,7 @@
 use Aeviiq\Collection\Exception\InvalidArgumentException;
 
 /**
- * @psalm-extends Collection<array-key, int>
+ * @extends Collection<array-key, int>
  * @phpstan-extends Collection<array-key, int>
  *
  * @method \ArrayIterator|array<string|int, int> getIterator()

src/ObjectCollection.php

@@ -5,12 +5,12 @@
 use Aeviiq\Collection\Exception\InvalidArgumentException;
 
 /**
- * @psalm-template TKey as array-key
- * @psalm-template TValue of object
+ * @template TKey as array-key
+ * @template TValue of object
  * @phpstan-template TKey
  * @phpstan-template TValue of object
  *
- * @psalm-extends Collection<TKey, TValue>
+ * @extends Collection<TKey, TValue>
  * @phpstan-extends Collection<TKey, TValue>
  *
  * @method \ArrayIterator|array<string|int, object> getIterator()
@@ -37,7 +37,6 @@ protected function validateElement($element): void
     /**
      * If this is kept empty, any element can be passed, as long as it is an object.
      *
-     * @psalm-return class-string<TValue>|string
      * @phpstan-return class-string<TValue>|string
      *
      * @return string The class name of the allowed object instance.

src/StringCollection.php

@@ -5,7 +5,7 @@
 use Aeviiq\Collection\Exception\InvalidArgumentException;
 
 /**
- * @psalm-extends Collection<array-key, string>
+ * @extends Collection<array-key, string>
  * @phpstan-extends Collection<array-key, string>
  *
  * @method \ArrayIterator|array<string|int, string> getIterator()