introduce psalm-types for complex service/extension/factory callables…

… type hints.
inpsyde · May 3, 2024 · eab8168 · eab8168
1 parent 7538809
commit eab8168
Show file tree

Hide file tree

Showing 5 changed files with 33 additions and 13 deletions.
diff --git a/src/Container/ContainerConfigurator.php b/src/Container/ContainerConfigurator.php
@@ -3,13 +3,16 @@
 
 namespace Inpsyde\Modularity\Container;
 
-use Psr\Container\ContainerExceptionInterface;
 use Psr\Container\ContainerInterface;
 
+/**
+ * @psalm-import-type Service from \Inpsyde\Modularity\Module\ServiceModule
+ * @psalm-import-type ExtendingService from \Inpsyde\Modularity\Module\ExtendingModule
+ */
 class ContainerConfigurator
 {
     /**
-     * @var array<string, callable(ContainerInterface $container):mixed>
+     * @var array<string, Service>
      */
     private $services = [];
 
@@ -19,7 +22,7 @@ class ContainerConfigurator
     private $factoryIds = [];
 
     /**
-     * @var array<string, array<callable(mixed $service, ContainerInterface $container):mixed>>
+     * @var array<string, array<ExtendingService>>
      */
     private $extensions = [];
 
@@ -55,7 +58,7 @@ public function addContainer(ContainerInterface $container): void
 
     /**
      * @param string $id
-     * @param callable(ContainerInterface $container):mixed $factory
+     * @param Service $factory
      */
     public function addFactory(string $id, callable $factory): void
     {
@@ -67,7 +70,7 @@ public function addFactory(string $id, callable $factory): void
 
     /**
      * @param string $id
-     * @param callable(ContainerInterface $container):mixed $service
+     * @param Service $service
      *
      * @return void
      */
@@ -109,7 +112,7 @@ public function hasService(string $id): bool
 
     /**
      * @param string $id
-     * @param callable(mixed $service, ContainerInterface $container):mixed $extender
+     * @param ExtendingService $extender
      *
      * @return void
      */

diff --git a/src/Container/ReadOnlyContainer.php b/src/Container/ReadOnlyContainer.php
@@ -7,10 +7,14 @@
 use Psr\Container\ContainerInterface;
 use Psr\Container\NotFoundExceptionInterface;
 
+/**
+ * @psalm-import-type Service from \Inpsyde\Modularity\Module\ServiceModule
+ * @psalm-import-type ExtendingService from \Inpsyde\Modularity\Module\ExtendingModule
+ */
 class ReadOnlyContainer implements ContainerInterface
 {
     /**
-     * @var array<string, callable(\Psr\Container\ContainerInterface $container):mixed>
+     * @var array<string, Service>
      */
     private $services;
 
@@ -20,7 +24,7 @@ class ReadOnlyContainer implements ContainerInterface
     private $factoryIds;
 
     /**
-     * @var array<string, array<callable(mixed, ContainerInterface $container):mixed>>
+     * @var array<string, array<ExtendingService>>
      */
     private $extensions;
 
@@ -39,9 +43,9 @@ class ReadOnlyContainer implements ContainerInterface
     /**
      * ReadOnlyContainer constructor.
      *
-     * @param array<string, callable(ContainerInterface $container):mixed> $services
+     * @param array<string, Service> $services
      * @param array<string, bool> $factoryIds
-     * @param array<string, array<callable(mixed, ContainerInterface $container):mixed>> $extensions
+     * @param array<string, array<ExtendingService>> $extensions
      * @param ContainerInterface[] $containers
      */
     public function __construct(

diff --git a/src/Module/ExtendingModule.php b/src/Module/ExtendingModule.php
@@ -4,6 +4,11 @@
 
 namespace Inpsyde\Modularity\Module;
 
+use Psr\Container\ContainerInterface;
+
+/**
+ * @psalm-type ExtendingService = callable(mixed $service, ContainerInterface $container):mixed
+ */
 interface ExtendingModule extends Module
 {
 
@@ -18,7 +23,7 @@ interface ExtendingModule extends Module
      * That is done by using as ID (array key in the `extensions` method) the target module ID
      * and the service ID.
      *
-     * @return array<string, callable(mixed $service, \Psr\Container\ContainerInterface $container):mixed>
+     * @return array<string, ExtendingService>
      */
     public function extensions(): array;
 }
diff --git a/src/Module/FactoryModule.php b/src/Module/FactoryModule.php
@@ -4,6 +4,9 @@
 
 namespace Inpsyde\Modularity\Module;
 
+/**
+ * @psalm-import-type Service from ServiceModule
+ */
 interface FactoryModule extends Module
 {
     /**
@@ -12,7 +15,7 @@ interface FactoryModule extends Module
      * Similar to `services`, but object created by given factories are not "cached", but a *new*
      * instance is returned everytime `get()` is called in the container.
      *
-     * @return array<string, callable(\Psr\Container\ContainerInterface $container):mixed>
+     * @return array<string, Service>
      */
     public function factories(): array;
 }
diff --git a/src/Module/ServiceModule.php b/src/Module/ServiceModule.php
@@ -4,6 +4,11 @@
 
 namespace Inpsyde\Modularity\Module;
 
+use Psr\Container\ContainerInterface;
+
+/**
+ * @psalm-type Service = callable(ContainerInterface $container):mixed
+ */
 interface ServiceModule extends Module
 {
 
@@ -15,7 +20,7 @@ interface ServiceModule extends Module
      * Services are "cached", so the given factory is called once the first time `get()` is called
      * in the container, and on subsequent `get()` the same instance is returned again and again.
      *
-     * @return array<string, callable(\Psr\Container\ContainerInterface $container):mixed>
+     * @return array<string, Service>
      */
     public function services(): array;
 }