feat: $offset parameter type widening for ArrayAccess methods (#101)

rekalogika · Jul 5, 2024 · 36a21c3 · 36a21c3
1 parent 4dbf5e6
commit 36a21c3
Show file tree

Hide file tree

Showing 6 changed files with 72 additions and 8 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -11,6 +11,7 @@
 * feat: default count limits
 * refactor: remove `Countable` from minimal classes
 * refactor: rename `RestrictedCountStrategy` to `DisabledCountStrategy`
+* feat: `$offset` parameter type widening for `ArrayAccess` methods
 
 ## 0.7.0
 

diff --git a/packages/collections-common/src/Trait/ArrayAccessTrait.php b/packages/collections-common/src/Trait/ArrayAccessTrait.php
@@ -14,6 +14,7 @@
 namespace Rekalogika\Domain\Collections\Common\Trait;
 
 use Doctrine\Common\Collections\Collection;
+use Rekalogika\Domain\Collections\Common\Internal\KeyTransformerUtil;
 
 /**
  * @template TKey of array-key
@@ -33,28 +34,34 @@ abstract private function ensureSafety(): void;
     abstract private function getRealCollection(): Collection;
 
     /**
-     * @param TKey $offset
+     * @param mixed $offset
      */
     final public function offsetExists(mixed $offset): bool
     {
+        /** @var TKey */
+        $offset = KeyTransformerUtil::transformInputToKey($this->keyTransformer, $offset);
+
         // return $this->getSafeCollection()->containsKey($offset);
 
         return $this->containsKey($offset);
     }
 
     /**
-     * @param TKey $offset
+     * @param mixed $offset
      * @return T|null
      */
     final public function offsetGet(mixed $offset): mixed
     {
+        /** @var TKey */
+        $offset = KeyTransformerUtil::transformInputToKey($this->keyTransformer, $offset);
+
         // return $this->getSafeCollection()->get($offset);
 
         return $this->get($offset);
     }
 
     /**
-     * @param TKey|null $offset
+     * @param mixed $offset
      * @param T $value
      */
     final public function offsetSet(mixed $offset, mixed $value): void
@@ -65,16 +72,22 @@ final public function offsetSet(mixed $offset, mixed $value): void
             return;
         }
 
+        /** @var TKey */
+        $offset = KeyTransformerUtil::transformInputToKey($this->keyTransformer, $offset);
+
         $this->ensureSafety();
 
         $this->getRealCollection()->offsetSet($offset, $value);
     }
 
     /**
-     * @param TKey $offset
+     * @param mixed $offset
      */
     final public function offsetUnset(mixed $offset): void
     {
+        /** @var TKey */
+        $offset = KeyTransformerUtil::transformInputToKey($this->keyTransformer, $offset);
+
         $this->ensureSafety();
 
         // $this->getRealCollection()->offsetUnset($offset);

diff --git a/packages/collections-contracts/src/Recollection.php b/packages/collections-contracts/src/Recollection.php
@@ -41,4 +41,30 @@ public function remove(mixed $key): mixed;
      */
     #[\Override]
     public function set(mixed $key, mixed $value): void;
+
+    /**
+     * @param mixed $offset
+     */
+    #[\Override]
+    public function offsetExists(mixed $offset): bool;
+
+    /**
+     * @param mixed $offset
+     * @return T|null
+     */
+    #[\Override]
+    public function offsetGet(mixed $offset): mixed;
+
+    /**
+     * @param mixed $offset
+     * @param T $value
+     */
+    #[\Override]
+    public function offsetSet(mixed $offset, mixed $value): void;
+
+    /**
+     * @param mixed $offset
+     */
+    #[\Override]
+    public function offsetUnset(mixed $offset): void;
 }
diff --git a/packages/collections-orm/src/AbstractRepository.php b/packages/collections-orm/src/AbstractRepository.php
@@ -23,6 +23,7 @@
 use Rekalogika\Collections\ORM\Trait\RepositoryTrait;
 use Rekalogika\Contracts\Collections\Repository;
 use Rekalogika\Domain\Collections\Common\Count\CountStrategy;
+use Rekalogika\Domain\Collections\Common\KeyTransformer\KeyTransformer;
 use Rekalogika\Domain\Collections\Common\Trait\SafeCollectionTrait;
 
 /**
@@ -81,6 +82,8 @@ abstract class AbstractRepository implements Repository
      */
     private readonly ?int $hardLimit;
 
+    private readonly ?KeyTransformer $keyTransformer;
+
     final public function __construct(
         private EntityManagerInterface $entityManager,
     ) {
@@ -92,6 +95,7 @@ final public function __construct(
         $this->softLimit = $configuration->getSoftLimit();
         $this->hardLimit = $configuration->getHardLimit();
         $this->orderBy = $configuration->getOrderBy();
+        $this->keyTransformer = $configuration->getKeyTransformer();
 
         // set query builder
         $criteria = Criteria::create()->orderBy($configuration->getOrderBy());

diff --git a/packages/collections-orm/src/Configuration/RepositoryConfiguration.php b/packages/collections-orm/src/Configuration/RepositoryConfiguration.php
@@ -15,6 +15,7 @@
 
 use Doctrine\Common\Collections\Order;
 use Rekalogika\Domain\Collections\Common\Count\CountStrategy;
+use Rekalogika\Domain\Collections\Common\KeyTransformer\KeyTransformer;
 
 /**
  * @template T of object
@@ -37,6 +38,7 @@ public function __construct(
         ?CountStrategy $count = null,
         private readonly ?int $softLimit = null,
         private readonly ?int $hardLimit = null,
+        private readonly ?KeyTransformer $keyTransformer = null,
     ) {
         parent::__construct(
             class: $class,
@@ -62,4 +64,12 @@ public function getHardLimit(): ?int
     {
         return $this->hardLimit;
     }
+
+    /**
+     * @return null|KeyTransformer
+     */
+    public function getKeyTransformer(): ?KeyTransformer
+    {
+        return $this->keyTransformer;
+    }
 }
diff --git a/packages/collections-orm/src/Trait/RepositoryTrait.php b/packages/collections-orm/src/Trait/RepositoryTrait.php
@@ -14,6 +14,7 @@
 namespace Rekalogika\Collections\ORM\Trait;
 
 use Rekalogika\Contracts\Collections\Exception\InvalidArgumentException;
+use Rekalogika\Domain\Collections\Common\Internal\KeyTransformerUtil;
 
 /**
  * @template TKey of array-key
@@ -41,24 +42,30 @@ final public function clear(): void
     }
 
     /**
-     * @param TKey $offset
+     * @param mixed $offset
      */
     final public function offsetExists(mixed $offset): bool
     {
+        /** @var TKey */
+        $offset = KeyTransformerUtil::transformInputToKey($this->keyTransformer, $offset);
+
         return $this->containsKey($offset);
     }
 
     /**
-     * @param TKey $offset
+     * @param mixed $offset
      * @return T|null
      */
     final public function offsetGet(mixed $offset): mixed
     {
+        /** @var TKey */
+        $offset = KeyTransformerUtil::transformInputToKey($this->keyTransformer, $offset);
+
         return $this->get($offset);
     }
 
     /**
-     * @param TKey|null $offset
+     * @param mixed $offset
      * @param T $value
      */
     final public function offsetSet(mixed $offset, mixed $value): void
@@ -71,10 +78,13 @@ final public function offsetSet(mixed $offset, mixed $value): void
     }
 
     /**
-     * @param TKey $offset
+     * @param mixed $offset
      */
     final public function offsetUnset(mixed $offset): void
     {
+        /** @var TKey */
+        $offset = KeyTransformerUtil::transformInputToKey($this->keyTransformer, $offset);
+
         $this->remove($offset);
     }