[DI][Contracts] add and implement ServiceProviderInterface

mateuszsip · nicolas-grekas · commit 6ff44c4ee7a4 · 2019-03-10T00:14:13.000+01:00
diff --git a/src/Symfony/Component/DependencyInjection/CHANGELOG.md b/src/Symfony/Component/DependencyInjection/CHANGELOG.md
@@ -10,6 +10,7 @@ CHANGELOG
  * added support for deprecating aliases
  * made `ContainerParametersResource` final and not implement `Serializable` anymore
  * added ability to define an index for a tagged collection
+ * made `ServiceLocator` implement `ServiceProviderInterface`
 
 4.2.0
 -----
diff --git a/src/Symfony/Component/DependencyInjection/Compiler/ResolveServiceSubscribersPass.php b/src/Symfony/Component/DependencyInjection/Compiler/ResolveServiceSubscribersPass.php
@@ -14,6 +14,7 @@
 use Psr\Container\ContainerInterface;
 use Symfony\Component\DependencyInjection\Definition;
 use Symfony\Component\DependencyInjection\Reference;
+use Symfony\Contracts\Service\ServiceProviderInterface;
 
 /**
  * Compiler pass to inject their service locator to service subscribers.
@@ -26,7 +27,7 @@ class ResolveServiceSubscribersPass extends AbstractRecursivePass
 
     protected function processValue($value, $isRoot = false)
     {
-        if ($value instanceof Reference && $this->serviceLocator && ContainerInterface::class === (string) $value) {
+        if ($value instanceof Reference && $this->serviceLocator && \in_array((string) $value, [ContainerInterface::class, ServiceProviderInterface::class], true)) {
             return new Reference($this->serviceLocator);
         }
 
diff --git a/src/Symfony/Component/DependencyInjection/ServiceLocator.php b/src/Symfony/Component/DependencyInjection/ServiceLocator.php
@@ -12,19 +12,19 @@
 namespace Symfony\Component\DependencyInjection;
 
 use Psr\Container\ContainerExceptionInterface;
-use Psr\Container\ContainerInterface as PsrContainerInterface;
 use Psr\Container\NotFoundExceptionInterface;
 use Symfony\Component\DependencyInjection\Exception\RuntimeException;
 use Symfony\Component\DependencyInjection\Exception\ServiceCircularReferenceException;
 use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
 use Symfony\Contracts\Service\ServiceLocatorTrait;
+use Symfony\Contracts\Service\ServiceProviderInterface;
 use Symfony\Contracts\Service\ServiceSubscriberInterface;
 
 /**
  * @author Robin Chalas <robin.chalas@gmail.com>
  * @author Nicolas Grekas <p@tchwork.com>
  */
-class ServiceLocator implements PsrContainerInterface
+class ServiceLocator implements ServiceProviderInterface
 {
     use ServiceLocatorTrait {
         get as private doGet;
diff --git a/src/Symfony/Component/DependencyInjection/Tests/ServiceLocatorTest.php b/src/Symfony/Component/DependencyInjection/Tests/ServiceLocatorTest.php
@@ -86,6 +86,21 @@ public function testInvoke()
         $this->assertSame('baz', $locator('bar'));
         $this->assertNull($locator('dummy'), '->__invoke() should return null on invalid service');
     }
+
+    public function testProvidesServicesInformation()
+    {
+        $locator = new ServiceLocator([
+            'foo' => function () { return 'bar'; },
+            'bar' => function (): string { return 'baz'; },
+            'baz' => function (): ?string { return 'zaz'; },
+        ]);
+
+        $this->assertSame($locator->getProvidedServices(), [
+            'foo' => '?',
+            'bar' => 'string',
+            'baz' => '?string',
+        ]);
+    }
 }
 
 class SomeServiceSubscriber implements ServiceSubscriberInterface
diff --git a/src/Symfony/Component/DependencyInjection/composer.json b/src/Symfony/Component/DependencyInjection/composer.json
@@ -18,7 +18,7 @@
     "require": {
         "php": "^7.1.3",
         "psr/container": "^1.0",
-        "symfony/contracts": "^1.0"
+        "symfony/contracts": "^1.1"
     },
     "require-dev": {
         "symfony/yaml": "~3.4|~4.0",
diff --git a/src/Symfony/Contracts/CHANGELOG.md b/src/Symfony/Contracts/CHANGELOG.md
@@ -5,6 +5,7 @@ CHANGELOG
 -----
 
  * added `HttpClient` namespace with contracts for implementing flexible HTTP clients
+ * added `ServiceProviderInterface`
 
 1.0.0
 -----
diff --git a/src/Symfony/Contracts/Service/ServiceLocatorTrait.php b/src/Symfony/Contracts/Service/ServiceLocatorTrait.php
@@ -15,7 +15,7 @@
 use Psr\Container\NotFoundExceptionInterface;
 
 /**
- * A trait to help implement PSR-11 service locators.
+ * A trait to help implement ServiceProviderInterface.
  *
  * @author Robin Chalas <robin.chalas@gmail.com>
  * @author Nicolas Grekas <p@tchwork.com>
@@ -24,6 +24,7 @@ trait ServiceLocatorTrait
 {
     private $factories;
     private $loading = [];
+    private $providedTypes;
 
     /**
      * @param callable[] $factories
@@ -66,6 +67,24 @@ public function get($id)
         }
     }
 
+    /**
+     * {@inheritdoc}
+     */
+    public function getProvidedServices(): array
+    {
+        if (null === $this->providedTypes) {
+            $this->providedTypes = [];
+
+            foreach ($this->factories as $name => $factory) {
+                $type = (new \ReflectionFunction($factory))->getReturnType();
+
+                $this->providedTypes[$name] = $type ? ($type->allowsNull() ? '?' : '').$type->getName() : '?';
+            }
+        }
+
+        return $this->providedTypes;
+    }
+
     private function createNotFoundException(string $id): NotFoundExceptionInterface
     {
         if (!$alternatives = array_keys($this->factories)) {
diff --git a/src/Symfony/Contracts/Service/ServiceProviderInterface.php b/src/Symfony/Contracts/Service/ServiceProviderInterface.php
@@ -0,0 +1,36 @@
+<?php
+
+/*
+ * This file is part of the Symfony package.
+ *
+ * (c) Fabien Potencier <fabien@symfony.com>
+ *
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Symfony\Contracts\Service;
+
+use Psr\Container\ContainerInterface;
+
+/**
+ * A ServiceProviderInterface exposes the identifiers and the types of services provided by a container.
+ *
+ * @author Nicolas Grekas <p@tchwork.com>
+ * @author Mateusz Sip <mateusz.sip@gmail.com>
+ */
+interface ServiceProviderInterface extends ContainerInterface
+{
+    /**
+     * Returns an associative array of service types keyed by the identifiers provided by the current container.
+     *
+     * Examples:
+     *
+     *  * ['logger' => 'Psr\Log\LoggerInterface'] means the object provides a service named "logger" that implements Psr\Log\LoggerInterface
+     *  * ['foo' => '?'] means the container provides service name "foo" of unspecified type
+     *  * ['bar' => '?Bar\Baz'] means the container provides a service "bar" of type Bar\Baz|null
+     *
+     * @return string[] The provided service types, keyed by service names
+     */
+    public function getProvidedServices(): array;
+}

Original file line number	Diff line number	Diff line change
`@@ -14,6 +14,7 @@`
`14`	`14`	`use Psr\Container\ContainerInterface;`
`15`	`15`	`use Symfony\Component\DependencyInjection\Definition;`
`16`	`16`	`use Symfony\Component\DependencyInjection\Reference;`
	`17`	`+use Symfony\Contracts\Service\ServiceProviderInterface;`
`17`	`18`
`18`	`19`	`/**`
`19`	`20`	`* Compiler pass to inject their service locator to service subscribers.`
`@@ -26,7 +27,7 @@ class ResolveServiceSubscribersPass extends AbstractRecursivePass`
`26`	`27`
`27`	`28`	`protected function processValue($value, $isRoot = false)`
`28`	`29`	`{`
`29`		`- if ($value instanceof Reference && $this->serviceLocator && ContainerInterface::class === (string) $value) {`
	`30`	`+ if ($value instanceof Reference && $this->serviceLocator && \in_array((string) $value, [ContainerInterface::class, ServiceProviderInterface::class], true)) {`
`30`	`31`	`return new Reference($this->serviceLocator);`
`31`	`32`	`}`
`32`	`33`