Align signatures with Container Interop v2

Dhii · Sep 21, 2024 · a8ce109 · a8ce109
1 parent e0a2bd2
commit a8ce109
Show file tree

Hide file tree

Showing 20 changed files with 47 additions and 181 deletions.
diff --git a/src/AliasingContainer.php b/src/AliasingContainer.php
@@ -49,23 +49,17 @@ public function __construct(PsrContainerInterface $inner, array $aliases)
 
     /**
      * @inheritdoc
-     *
-     * @since [*next-version*]
      */
-    public function get($key)
+    public function get(string $key)
     {
         return $this->inner->get($this->getInnerKey($key));
     }
 
     /**
      * @inheritdoc
-     *
-     * @since [*next-version*]
      */
-    public function has($key)
+    public function has(string $key): bool
     {
-        $key = (string) $key;
-
         return $this->inner->has($this->getInnerKey($key));
     }
 

diff --git a/src/CachingContainer.php b/src/CachingContainer.php
@@ -39,14 +39,8 @@ public function __construct(PsrContainerInterface $container)
     /**
      * {@inheritDoc}
      */
-    public function get($key)
+    public function get(string $key)
     {
-        /** @psalm-suppress RedundantCastGivenDocblockType
-         * @psalm-suppress RedundantCast
-         * Will remove when switching to PHP 7.2 and new PSR-11 interfaces
-         */
-        $key = (string) $key;
-
         /**
          * @psalm-suppress InvalidCatch
          * The base interface does not extend Throwable, but in fact everything that is possible
@@ -76,13 +70,8 @@ public function get($key)
     /**
      * {@inheritDoc}
      */
-    public function has($key)
+    public function has(string $key): bool
     {
-        /** @psalm-suppress RedundantCastGivenDocblockType
-         * Will remove when switching to PHP 7.2 and new PSR-11 interfaces
-         */
-        $key = (string) $key;
-
         /**
          * @psalm-suppress InvalidCatch
          * The base interface does not extend Throwable, but in fact everything that is possible

diff --git a/src/CompositeContainer.php b/src/CompositeContainer.php
@@ -11,8 +11,6 @@
 use Exception;
 use Psr\Container\ContainerInterface as PsrContainerInterface;
 use Psr\Container\NotFoundExceptionInterface;
-use Traversable;
-use UnexpectedValueException;
 
 class CompositeContainer implements ContainerInterface
 {
@@ -34,14 +32,8 @@ public function __construct(iterable $containers)
     /**
      * {@inheritDoc}
      */
-    public function get($key)
+    public function get(string $key)
     {
-        /** @psalm-suppress RedundantCastGivenDocblockType
-         * @psalm-suppress RedundantCast
-         * Will remove when switching to PHP 7.2 and new PSR-11 interfaces
-         */
-        $key = (string) $key;
-
         foreach ($this->containers as $index => $container) {
             /**
              * @psalm-suppress InvalidCatch
@@ -77,13 +69,8 @@ public function get($key)
     /**
      * {@inheritDoc}
      */
-    public function has($key)
+    public function has(string $key): bool
     {
-        /** @psalm-suppress RedundantCastGivenDocblockType
-         * Will remove when switching to PHP 7.2 and new PSR-11 interfaces
-         */
-        $key = (string) $key;
-
         foreach ($this->containers as $index => $container) {
             try {
                 if ($container->has($key)) {

diff --git a/src/DataStructureBasedFactory.php b/src/DataStructureBasedFactory.php
@@ -5,7 +5,7 @@
 namespace Dhii\Container;
 
 use Dhii\Collection\WritableMapFactoryInterface;
-use Psr\Container\ContainerInterface;
+use Dhii\Collection\WritableMapInterface;
 
 /**
  * @inheritDoc
@@ -24,7 +24,7 @@ public function __construct(WritableMapFactoryInterface $containerFactory)
     /**
      * @inheritDoc
      */
-    public function createContainerFromArray(array $structure): ContainerInterface
+    public function createContainerFromArray(array $structure): WritableMapInterface
     {
         $map = [];
         foreach ($structure as $key => $value) {

diff --git a/src/DataStructureBasedFactoryInterface.php b/src/DataStructureBasedFactoryInterface.php
@@ -7,7 +7,6 @@
 use Dhii\Collection\WritableMapFactoryInterface;
 use Dhii\Collection\WritableMapInterface;
 use Exception;
-use Psr\Container\ContainerInterface as BaseContainerInterface;
 
 /**
  * Creates a container hierarchy based on a traditional data structure.
@@ -23,5 +22,5 @@ interface DataStructureBasedFactoryInterface extends WritableMapFactoryInterface
      *
      * @throws Exception If problem creating.
      */
-    public function createContainerFromArray(array $structure): BaseContainerInterface;
+    public function createContainerFromArray(array $structure): WritableMapInterface;
 }
diff --git a/src/DelegatingContainer.php b/src/DelegatingContainer.php
@@ -43,7 +43,7 @@ public function __construct(ServiceProviderInterface $provider, PsrContainerInte
     /**
      * {@inheritDoc}
      */
-    public function get($id)
+    public function get(string $id)
     {
         if (array_key_exists($id, $this->stack)) {
             $trace = implode(' -> ', array_keys($this->stack)) . ' -> ' . $id;
@@ -67,10 +67,9 @@ public function get($id)
     /**
      * {@inheritDoc}
      */
-    public function has($id)
+    public function has(string $id): bool
     {
         $services = $this->provider->getFactories();
-        $id = (string) $id;
 
         return array_key_exists($id, $services);
     }

diff --git a/src/DeprefixingContainer.php b/src/DeprefixingContainer.php
@@ -56,10 +56,8 @@ public function __construct(PsrContainerInterface $container, string $prefix, bo
 
     /**
      * @inheritdoc
-     *
-     * @since [*next-version*]
      */
-    public function get($key)
+    public function get(string $key)
     {
         /**
          * @psalm-suppress InvalidCatch
@@ -79,12 +77,9 @@ public function get($key)
 
     /**
      * @inheritdoc
-     *
-     * @since [*next-version*]
      */
-    public function has($key)
+    public function has(string $key): bool
     {
-        $key = (string) $key;
         $realKey = $this->getInnerKey($key);
 
         return $this->inner->has($realKey) || (!$this->strict && $this->inner->has($key));
@@ -93,8 +88,6 @@ public function has($key)
     /**
      * Retrieves the key to use for the inner container.
      *
-     * @since [*next-version*]
-     *
      * @param string $key The outer key.
      *
      * @return string The inner key.

diff --git a/src/Dictionary.php b/src/Dictionary.php
@@ -36,7 +36,7 @@ public function __construct(array $data)
     /**
      * {@inheritDoc}
      */
-    public function get($key)
+    public function get(string $key)
     {
         if (!array_key_exists($key, $this->data)) {
             throw new NotFoundException(
@@ -52,10 +52,8 @@ public function get($key)
     /**
      * {@inheritDoc}
      */
-    public function has($key)
+    public function has(string $key): bool
     {
-        $key = (string) $key;
-
         $isHas = array_key_exists($key, $this->data);
 
         return $isHas;

diff --git a/src/DictionaryFactory.php b/src/DictionaryFactory.php
@@ -5,7 +5,7 @@
 namespace Dhii\Container;
 
 use Dhii\Collection\WritableMapFactoryInterface;
-use Psr\Container\ContainerInterface;
+use Dhii\Collection\WritableMapInterface;
 
 /**
  * @inheritDoc
@@ -15,7 +15,7 @@ class DictionaryFactory implements WritableMapFactoryInterface
     /**
      * @inheritDoc
      */
-    public function createContainerFromArray(array $data): ContainerInterface
+    public function createContainerFromArray(array $data): WritableMapInterface
     {
         return new Dictionary($data);
     }

diff --git a/src/FlashContainer.php b/src/FlashContainer.php
@@ -7,7 +7,6 @@
 use Dhii\Collection\ClearableContainerInterface;
 use Dhii\Collection\MutableContainerInterface;
 use Dhii\Container\Exception\NotFoundException;
-use Psr\Container\ContainerExceptionInterface;
 
 /**
  * A container for data that is accessible once per init.
@@ -59,10 +58,8 @@ public function init(): void
     /**
      * @inheritDoc
      */
-    public function has($key)
+    public function has(string $key): bool
     {
-        $key = (string) $key;
-
         return array_key_exists($key, $this->flashData);
     }
 
@@ -71,7 +68,7 @@ public function has($key)
      *
      * Retrieves the value for the specified key from memory.
      */
-    public function get($key)
+    public function get(string $key)
     {
         if (!array_key_exists($key, $this->flashData)) {
             throw new NotFoundException(sprintf('Flash data not found for key "%1$s"', $key));

diff --git a/src/HierarchyContainer.php b/src/HierarchyContainer.php
@@ -59,10 +59,8 @@ public function __construct(array $data)
 
     /**
      * @inheritDoc
-     *
-     * @since [*next-version*]
      */
-    public function get($key)
+    public function get(string $key)
     {
         if (!array_key_exists($key, $this->data)) {
             throw new NotFoundException("Key '{$key}' does not exist", 0, null);
@@ -83,13 +81,9 @@ public function get($key)
 
     /**
      * @inheritDoc
-     *
-     * @since [*next-version*]
      */
-    public function has($key)
+    public function has(string $key): bool
     {
-        $key = (string) $key;
-
         return array_key_exists($key, $this->data);
     }
 }
diff --git a/src/MappingContainer.php b/src/MappingContainer.php
@@ -34,28 +34,15 @@
  */
 class MappingContainer implements ContainerInterface
 {
-    /* @since [*next-version*] */
     use StringTranslatingTrait;
 
-    /**
-     * @since [*next-version*]
-     *
-     * @var callable
-     */
+    /** @var callable */
     protected $callback;
 
-    /**
-     * @since [*next-version*]
-     *
-     * @var PsrContainerInterface
-     */
+    /** @var PsrContainerInterface */
     protected $inner;
 
     /**
-     * Constructor.
-     *
-     * @since [*next-version*]
-     *
      * @param PsrContainerInterface $inner    The container instance to decorate.
      * @param callable              $callback The callback to invoke on get. It will be passed 3 parameters:
      *                                         * The inner container's value for the key being fetched.
@@ -70,8 +57,6 @@ public function __construct(PsrContainerInterface $inner, callable $callback)
 
     /**
      * @inheritdoc
-     *
-     * @since [*next-version*]
      */
     public function get($key)
     {
@@ -80,13 +65,9 @@ public function get($key)
 
     /**
      * @inheritdoc
-     *
-     * @since [*next-version*]
      */
-    public function has($key)
+    public function has(string $key): bool
     {
-        $key = (string) $key;
-
         return $this->inner->has($key);
     }
 }
diff --git a/src/MaskingContainer.php b/src/MaskingContainer.php
@@ -13,12 +13,9 @@
 
 /**
  * An implementation of a container that wraps around another to selectively expose or mask certain keys.
- *
- * @since [*next-version*]
  */
 class MaskingContainer implements ContainerInterface
 {
-    /* @since [*next-version*] */
     use StringTranslatingTrait;
 
     /**
@@ -39,8 +36,6 @@ class MaskingContainer implements ContainerInterface
     /**
      * Constructor.
      *
-     * @since [*next-version*]
-     *
      * @param PsrContainerInterface $inner       The container whose entries to mask.
      * @param bool                  $defaultMask The default mask. If true, all inner keys are exposed. If false, all
      *                                           inner keys are hidden. Any keys specified in the $mask parameter will
@@ -57,10 +52,8 @@ public function __construct(PsrContainerInterface $inner, bool $defaultMask, arr
 
     /**
      * @inheritdoc
-     *
-     * @since [*next-version*]
      */
-    public function get($key)
+    public function get(string $key)
     {
         if (!$this->isExposed($key)) {
             throw new NotFoundException(
@@ -75,21 +68,15 @@ public function get($key)
 
     /**
      * @inheritdoc
-     *
-     * @since [*next-version*]
      */
-    public function has($key)
+    public function has(string $key): bool
     {
-        $key = (string) $key;
-
         return $this->isExposed($key) && $this->inner->has($key);
     }
 
     /**
      * Checks if a key is exposed through the mask.
      *
-     * @since [*next-version*]
-     *
      * @param string $key The key to check.
      *
      * @return bool True if the key is exposed, false if the key is hidden.