feature: introduce psr/container v2 support

Signed-off-by: Maximilian Bösing <2189546+boesing@users.noreply.github.com>
laminas · May 2, 2023 · 98ab717 · 98ab717
1 parent 3d870a0
commit 98ab717
Show file tree

Hide file tree

Showing 6 changed files with 73 additions and 43 deletions.
diff --git a/composer.json b/composer.json
@@ -34,7 +34,7 @@
         "php": "~8.1.0 || ~8.2.0",
         "brick/varexporter": "^0.3.8",
         "laminas/laminas-stdlib": "^3.2.1",
-        "psr/container": "^1.1"
+        "psr/container": "^1.1 || ^2.0"
     },
     "extra": {
         "laminas": {
@@ -58,7 +58,7 @@
         "vimeo/psalm": "^5.10"
     },
     "provide": {
-        "psr/container-implementation": "^1.0"
+        "psr/container-implementation": "^1.0 || ^2.0"
     },
     "conflict": {
         "laminas/laminas-code": "<3.3.1",

diff --git a/composer.lock b/composer.lock
diff --git a/psalm-baseline.xml b/psalm-baseline.xml
@@ -99,10 +99,6 @@
       <code><![CDATA[$config['factories']]]></code>
       <code><![CDATA[$config['shared']]]></code>
     </MixedOperand>
-    <ParamNameMismatch>
-      <code>$name</code>
-      <code>$name</code>
-    </ParamNameMismatch>
   </file>
   <file src="src/Test/CommonPluginManagerTrait.php">
     <ArgumentTypeCoercion>

diff --git a/src/AbstractPluginManager.php b/src/AbstractPluginManager.php
@@ -184,7 +184,7 @@ public function setService(string $name, mixed $service): void
     /**
      * {@inheritDoc}
      */
-    public function get($id): mixed
+    public function get(string $id): mixed
     {
         if (! $this->has($id)) {
             if (! $this->autoAddInvokableClass || ! class_exists($id)) {

diff --git a/src/ServiceManager.php b/src/ServiceManager.php
@@ -204,35 +204,35 @@ public function __construct(
     }
 
     /** {@inheritDoc} */
-    public function get($name)
+    public function get(string $id): mixed
     {
         // We start by checking if we have cached the requested service;
         // this is the fastest method.
-        if (isset($this->services[$name])) {
-            return $this->services[$name];
+        if (isset($this->services[$id])) {
+            return $this->services[$id];
         }
 
         // Determine if the service should be shared.
-        $sharedService = $this->shared[$name] ?? $this->sharedByDefault;
+        $sharedService = $this->shared[$id] ?? $this->sharedByDefault;
 
         // We achieve better performance if we can let all alias
         // considerations out.
         if (! $this->aliases) {
             /** @psalm-suppress MixedAssignment Yes indeed, service managers can return mixed. */
-            $service = $this->doCreate($name);
+            $service = $this->doCreate($id);
 
             // Cache the service for later, if it is supposed to be shared.
             if ($sharedService) {
-                $this->services[$name] = $service;
+                $this->services[$id] = $service;
             }
             return $service;
         }
 
         // We now deal with requests which may be aliases.
-        $resolvedName = $this->aliases[$name] ?? $name;
+        $resolvedName = $this->aliases[$id] ?? $id;
 
         // Update shared service information as we checked if the alias was shared before.
-        if ($resolvedName !== $name) {
+        if ($resolvedName !== $id) {
             $sharedService = $this->shared[$resolvedName] ?? $sharedService;
         }
 
@@ -241,7 +241,7 @@ public function get($name)
 
         // If the alias is configured as a shared service, we are done.
         if ($sharedAlias) {
-            $this->services[$name] = $this->services[$resolvedName];
+            $this->services[$id] = $this->services[$resolvedName];
             return $this->services[$resolvedName];
         }
 
@@ -253,7 +253,7 @@ public function get($name)
         // Cache the object for later, if it is supposed to be shared.
         if ($sharedService) {
             $this->services[$resolvedName] = $service;
-            $this->services[$name]         = $service;
+            $this->services[$id]           = $service;
         }
 
         return $service;
@@ -274,10 +274,10 @@ public function build(string $name, ?array $options = null): mixed
      * @param string|class-string $name
      * @return bool
      */
-    public function has($name)
+    public function has(string $id): bool
     {
         // Check static services and factories first to speedup the most common requests.
-        return $this->staticServiceOrFactoryCanCreate($name) || $this->abstractFactoryCanCreate($name);
+        return $this->staticServiceOrFactoryCanCreate($id) || $this->abstractFactoryCanCreate($id);
     }
 
     /**

diff --git a/test/Tool/FactoryCreatorTest.php b/test/Tool/FactoryCreatorTest.php
@@ -15,7 +15,11 @@
 use Psr\Container\ContainerInterface;
 use stdClass;
 
+use function array_pop;
+use function count;
 use function file_get_contents;
+use function func_get_args;
+use function is_array;
 use function preg_match;
 
 use const PHP_EOL;
@@ -55,9 +59,9 @@ public function testCreateFactoryCreatesForSimpleDependencies(): void
         $this->container
             ->expects(self::atLeastOnce())
             ->method('has')
-            ->willReturnMap([
+            ->willReturnCallback($this->createReturnMapCallbackWithDefault([
                 [InvokableObject::class, true],
-            ]);
+            ], false));
 
         self::assertSame($factory, $this->factoryCreator->createFactory($className));
     }
@@ -70,10 +74,10 @@ public function testCreateFactoryCreatesForComplexDependencies(): void
         $this->container
             ->expects(self::atLeastOnce())
             ->method('has')
-            ->willReturnMap([
+            ->willReturnCallback($this->createReturnMapCallbackWithDefault([
                 [SimpleDependencyObject::class, true],
                 [SecondComplexDependencyObject::class, true],
-            ]);
+            ], false));
 
         self::assertSame($factory, $this->factoryCreator->createFactory($className));
     }
@@ -89,10 +93,10 @@ public function testNamespaceGeneration(): void
         $this->container
             ->expects(self::atLeastOnce())
             ->method('has')
-            ->willReturnMap([
+            ->willReturnCallback($this->createReturnMapCallbackWithDefault([
                 [SimpleDependencyObject::class, true],
                 [SecondComplexDependencyObject::class, true],
-            ]);
+            ], false));
 
         foreach ($testClassNames as $testFqcn => $expectedNamespace) {
             $generatedFactory = $this->factoryCreator->createFactory($testFqcn);
@@ -108,4 +112,27 @@ public function testNamespaceGeneration(): void
             self::assertSame($expectedNamespace, $namespaceMatch[1]);
         }
     }
+
+    private function createReturnMapCallbackWithDefault(array $values, mixed $default): callable
+    {
+        return function () use ($values, $default): mixed {
+            $args           = func_get_args();
+            $parameterCount = count($args);
+
+            foreach ($values as $map) {
+                if (! is_array($map) || $parameterCount !== count($map) - 1) {
+                    continue;
+                }
+
+                /** @var mixed $return */
+                $return = array_pop($map);
+
+                if ($args === $map) {
+                    return $return;
+                }
+            }
+
+            return $default;
+        };
+    }
 }