[DI] allow service subscribers to return SubscribedService[]

kbond · kbond · commit 263acddcdfe8 · 2022-07-28T12:51:13.000-04:00
diff --git a/src/Symfony/Contracts/Service/Attribute/SubscribedService.php b/src/Symfony/Contracts/Service/Attribute/SubscribedService.php
@@ -11,9 +11,14 @@
 
 namespace Symfony\Contracts\Service\Attribute;
 
+use Symfony\Contracts\Service\ServiceSubscriberInterface;
 use Symfony\Contracts\Service\ServiceSubscriberTrait;
 
 /**
+ * For use as the return value for {@see ServiceSubscriberInterface}.
+ *
+ * @example new SubscribedService('http_client', HttpClientInterface::class, false, new Target('githubApi'))
+ *
  * Use with {@see ServiceSubscriberTrait} to mark a method's return type
  * as a subscribed service.
  *
@@ -22,12 +27,21 @@
 #[\Attribute(\Attribute::TARGET_METHOD)]
 final class SubscribedService
 {
+    /** @var object[] */
+    public array $attributes;
+
     /**
-     * @param string|null $key The key to use for the service
-     *                         If null, use "ClassName::methodName"
+     * @param string|null       $key        The key to use for the service
+     * @param class-string|null $type       The service class
+     * @param bool              $nullable   Whether the service is optional
+     * @param object|object[]   $attributes One or more dependency injection attributes to use
      */
     public function __construct(
-        public ?string $key = null
+        public ?string $key = null,
+        public ?string $type = null,
+        public bool $nullable = false,
+        array|object $attributes = [],
     ) {
+        $this->attributes = \is_array($attributes) ? $attributes : [$attributes];
     }
 }
diff --git a/src/Symfony/Contracts/Service/ServiceSubscriberInterface.php b/src/Symfony/Contracts/Service/ServiceSubscriberInterface.php
@@ -11,6 +11,8 @@
 
 namespace Symfony\Contracts\Service;
 
+use Symfony\Contracts\Service\Attribute\SubscribedService;
+
 /**
  * A ServiceSubscriber exposes its dependencies via the static {@link getSubscribedServices} method.
  *
@@ -29,7 +31,8 @@
 interface ServiceSubscriberInterface
 {
     /**
-     * Returns an array of service types required by such instances, optionally keyed by the service names used internally.
+     * Returns an array of service types (or {@see SubscribedService} objects) required
+     * by such instances, optionally keyed by the service names used internally.
      *
      * For mandatory dependencies:
      *
@@ -47,7 +50,13 @@ interface ServiceSubscriberInterface
      *  * ['?Psr\Log\LoggerInterface'] is a shortcut for
      *  * ['Psr\Log\LoggerInterface' => '?Psr\Log\LoggerInterface']
      *
-     * @return string[] The required service types, optionally keyed by service names
+     * additionally, an array of {@see SubscribedService}'s can be returned:
+     *
+     *  * [new SubscribedService('logger', Psr\Log\LoggerInterface::class)]
+     *  * [new SubscribedService(type: Psr\Log\LoggerInterface::class, nullable: true)]
+     *  * [new SubscribedService('http_client', HttpClientInterface::class, attributes: new Target('githubApi'))]
+     *
+     * @return string[]|SubscribedService[] The required service types, optionally keyed by service names
      */
     public static function getSubscribedServices(): array;
 }
diff --git a/src/Symfony/Contracts/Service/ServiceSubscriberTrait.php b/src/Symfony/Contracts/Service/ServiceSubscriberTrait.php
@@ -50,13 +50,15 @@ public static function getSubscribedServices(): array
                 throw new \LogicException(sprintf('Cannot use "%s" on methods without a return type in "%s::%s()".', SubscribedService::class, $method->name, self::class));
             }
 
-            $serviceId = $returnType instanceof \ReflectionNamedType ? $returnType->getName() : (string) $returnType;
+            $attribute = $attribute->newInstance();
 
-            if ($returnType->allowsNull()) {
-                $serviceId = '?'.$serviceId;
-            }
+            /* @var SubscribedService $attribute */
+
+            $attribute->key ??= self::class.'::'.$method->name;
+            $attribute->type ??= $returnType instanceof \ReflectionNamedType ? $returnType->getName() : (string) $returnType;
+            $attribute->nullable = $returnType->allowsNull();
 
-            $services[$attribute->newInstance()->key ?? self::class.'::'.$method->name] = $serviceId;
+            $services[] = $attribute;
         }
 
         return $services;

Original file line number	Diff line number	Diff line change
`@@ -11,6 +11,8 @@`
`11`	`11`
`12`	`12`	`namespace Symfony\Contracts\Service;`
`13`	`13`
	`14`	`+use Symfony\Contracts\Service\Attribute\SubscribedService;`
	`15`	`+`
`14`	`16`	`/**`
`15`	`17`	`* A ServiceSubscriber exposes its dependencies via the static {@link getSubscribedServices} method.`
`16`	`18`	`*`
`@@ -29,7 +31,8 @@`
`29`	`31`	`interface ServiceSubscriberInterface`
`30`	`32`	`{`
`31`	`33`	`/**`
`32`		`- * Returns an array of service types required by such instances, optionally keyed by the service names used internally.`
	`34`	`+ * Returns an array of service types (or {@see SubscribedService} objects) required`
	`35`	`+ * by such instances, optionally keyed by the service names used internally.`
`33`	`36`	`*`
`34`	`37`	`* For mandatory dependencies:`
`35`	`38`	`*`
`@@ -47,7 +50,13 @@ interface ServiceSubscriberInterface`
`47`	`50`	`* * ['?Psr\Log\LoggerInterface'] is a shortcut for`
`48`	`51`	`* * ['Psr\Log\LoggerInterface' => '?Psr\Log\LoggerInterface']`
`49`	`52`	`*`
`50`		`- * @return string[] The required service types, optionally keyed by service names`
	`53`	`+ * additionally, an array of {@see SubscribedService}'s can be returned:`
	`54`	`+ *`
	`55`	`+ * * [new SubscribedService('logger', Psr\Log\LoggerInterface::class)]`
	`56`	`+ * * [new SubscribedService(type: Psr\Log\LoggerInterface::class, nullable: true)]`
	`57`	`+ * * [new SubscribedService('http_client', HttpClientInterface::class, attributes: new Target('githubApi'))]`
	`58`	`+ *`
	`59`	`+ * @return string[]\|SubscribedService[] The required service types, optionally keyed by service names`
`51`	`60`	`*/`
`52`	`61`	`public static function getSubscribedServices(): array;`
`53`	`62`	`}`