vendor/symfony/dependency-injection/ServiceLocator.php line 129

Open in your IDE?
  1. <?php
  3. /*
  4.  * This file is part of the Symfony package.
  5.  *
  6.  * (c) Fabien Potencier <fabien@symfony.com>
  7.  *
  8.  * For the full copyright and license information, please view the LICENSE
  9.  * file that was distributed with this source code.
  10.  */
  12. namespace Symfony\Component\DependencyInjection;
  14. use Psr\Container\ContainerExceptionInterface;
  15. use Psr\Container\NotFoundExceptionInterface;
  16. use Symfony\Component\DependencyInjection\Exception\RuntimeException;
  17. use Symfony\Component\DependencyInjection\Exception\ServiceCircularReferenceException;
  18. use Symfony\Component\DependencyInjection\Exception\ServiceNotFoundException;
  19. use Symfony\Contracts\Service\ServiceLocatorTrait;
  20. use Symfony\Contracts\Service\ServiceProviderInterface;
  21. use Symfony\Contracts\Service\ServiceSubscriberInterface;
  23. /**
  24.  * @author Robin Chalas <robin.chalas@gmail.com>
  25.  * @author Nicolas Grekas <p@tchwork.com>
  26.  */
  27. class ServiceLocator implements ServiceProviderInterface
  28. {
  29.     use ServiceLocatorTrait {
  30.         get as private doGet;
  31.     }
  33.     private $externalId;
  34.     private $container;
  36.     /**
  37.      * {@inheritdoc}
  38.      *
  39.      * @return mixed
  40.      */
  41.     public function get(string $id)
  42.     {
  43.         if (!$this->externalId) {
  44.             return $this->doGet($id);
  45.         }
  47.         try {
  48.             return $this->doGet($id);
  49.         } catch (RuntimeException $e) {
  50.             $what = sprintf('service "%s" required by "%s"', $id, $this->externalId);
  51.             $message = preg_replace('/service "\.service_locator\.[^"]++"/', $what, $e->getMessage());
  53.             if ($e->getMessage() === $message) {
  54.                 $message = sprintf('Cannot resolve %s: %s', $what, $message);
  55.             }
  57.             $r = new \ReflectionProperty($e, 'message');
  58.             $r->setAccessible(true);
  59.             $r->setValue($e, $message);
  61.             throw $e;
  62.         }
  63.     }
  65.     public function __invoke(string $id)
  66.     {
  67.         return isset($this->factories[$id]) ? $this->get($id) : null;
  68.     }
  70.     /**
  71.      * @internal
  72.      *
  73.      * @return static
  74.      */
  75.     public function withContext(string $externalId, Container $container): self
  76.     {
  77.         $locator = clone $this;
  78.         $locator->externalId = $externalId;
  79.         $locator->container = $container;
  81.         return $locator;
  82.     }
  84.     private function createNotFoundException(string $id): NotFoundExceptionInterface
  85.     {
  86.         if ($this->loading) {
  87.             $msg = sprintf('The service "%s" has a dependency on a non-existent service "%s". This locator %s', end($this->loading), $id, $this->formatAlternatives());
  89.             return new ServiceNotFoundException($id, end($this->loading) ?: null, null, [], $msg);
  90.         }
  92.         $class = debug_backtrace(\DEBUG_BACKTRACE_PROVIDE_OBJECT | \DEBUG_BACKTRACE_IGNORE_ARGS, 4);
  93.         $class = isset($class[3]['object']) ? \get_class($class[3]['object']) : null;
  94.         $externalId = $this->externalId ?: $class;
  96.         $msg = [];
  97.         $msg[] = sprintf('Service "%s" not found:', $id);
  99.         if (!$this->container) {
  100.             $class = null;
  101.         } elseif ($this->container->has($id) || isset($this->container->getRemovedIds()[$id])) {
  102.             $msg[] = 'even though it exists in the app\'s container,';
  103.         } else {
  104.             try {
  105.                 $this->container->get($id);
  106.                 $class = null;
  107.             } catch (ServiceNotFoundException $e) {
  108.                 if ($e->getAlternatives()) {
  109.                     $msg[] = sprintf('did you mean %s? Anyway,', $this->formatAlternatives($e->getAlternatives(), 'or'));
  110.                 } else {
  111.                     $class = null;
  112.                 }
  113.             }
  114.         }
  115.         if ($externalId) {
  116.             $msg[] = sprintf('the container inside "%s" is a smaller service locator that %s', $externalId, $this->formatAlternatives());
  117.         } else {
  118.             $msg[] = sprintf('the current service locator %s', $this->formatAlternatives());
  119.         }
  121.         if (!$class) {
  122.             // no-op
  123.         } elseif (is_subclass_of($class, ServiceSubscriberInterface::class)) {
  124.             $msg[] = sprintf('Unless you need extra laziness, try using dependency injection instead. Otherwise, you need to declare it using "%s::getSubscribedServices()".', preg_replace('/([^\\\\]++\\\\)++/', '', $class));
  125.         } else {
  126.             $msg[] = 'Try using dependency injection instead.';
  127.         }
  129.         return new ServiceNotFoundException($id, end($this->loading) ?: null, null, [], implode(' ', $msg));
  130.     }
  132.     private function createCircularReferenceException(string $id, array $path): ContainerExceptionInterface
  133.     {
  134.         return new ServiceCircularReferenceException($id, $path);
  135.     }
  137.     private function formatAlternatives(?array $alternatives = null, string $separator = 'and'): string
  138.     {
  139.         $format = '"%s"%s';
  140.         if (null === $alternatives) {
  141.             if (!$alternatives = array_keys($this->factories)) {
  142.                 return 'is empty...';
  143.             }
  144.             $format = sprintf('only knows about the %s service%s.', $format, 1 < \count($alternatives) ? 's' : '');
  145.         }
  146.         $last = array_pop($alternatives);
  148.         return sprintf($format, $alternatives ? implode('", "', $alternatives) : $last, $alternatives ? sprintf(' %s "%s"', $separator, $last) : '');
  149.     }
  150. }