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

  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, \Countable
  28. {
  29.     use ServiceLocatorTrait {
  30.         get as private doGet;
  31.     }
  33.     private ?string $externalId = null;
  34.     private ?Container $container = null;
  36.     public function get(string $id): mixed
  37.     {
  38.         if (!$this->externalId) {
  39.             return $this->doGet($id);
  40.         }
  42.         try {
  43.             return $this->doGet($id);
  44.         } catch (RuntimeException $e) {
  45.             $what = sprintf('service "%s" required by "%s"', $id, $this->externalId);
  46.             $message = preg_replace('/service "\.service_locator\.[^"]++"/', $what, $e->getMessage());
  48.             if ($e->getMessage() === $message) {
  49.                 $message = sprintf('Cannot resolve %s: %s', $what, $message);
  50.             }
  52.             $r = new \ReflectionProperty($e, 'message');
  53.             $r->setValue($e, $message);
  55.             throw $e;
  56.         }
  57.     }
  59.     public function __invoke(string $id)
  60.     {
  61.         return isset($this->factories[$id]) ? $this->get($id) : null;
  62.     }
  64.     /**
  65.      * @internal
  66.      */
  67.     public function withContext(string $externalId, Container $container): static
  68.     {
  69.         $locator = clone $this;
  70.         $locator->externalId = $externalId;
  71.         $locator->container = $container;
  73.         return $locator;
  74.     }
  76.     public function count(): int
  77.     {
  78.         return \count($this->getProvidedServices());
  79.     }
  81.     private function createNotFoundException(string $id): NotFoundExceptionInterface
  82.     {
  83.         if ($this->loading) {
  84.             $msg = sprintf('The service "%s" has a dependency on a non-existent service "%s". This locator %s', end($this->loading), $id, $this->formatAlternatives());
  86.             return new ServiceNotFoundException($id, end($this->loading) ?: null, null, [], $msg);
  87.         }
  89.         $class = debug_backtrace(\DEBUG_BACKTRACE_PROVIDE_OBJECT | \DEBUG_BACKTRACE_IGNORE_ARGS, 4);
  90.         $class = isset($class[3]['object']) ? \get_class($class[3]['object']) : null;
  91.         $externalId = $this->externalId ?: $class;
  93.         $msg = [];
  94.         $msg[] = sprintf('Service "%s" not found:', $id);
  96.         if (!$this->container) {
  97.             $class = null;
  98.         } elseif ($this->container->has($id) || isset($this->container->getRemovedIds()[$id])) {
  99.             $msg[] = 'even though it exists in the app\'s container,';
  100.         } else {
  101.             try {
  102.                 $this->container->get($id);
  103.                 $class = null;
  104.             } catch (ServiceNotFoundException $e) {
  105.                 if ($e->getAlternatives()) {
  106.                     $msg[] = sprintf('did you mean %s? Anyway,', $this->formatAlternatives($e->getAlternatives(), 'or'));
  107.                 } else {
  108.                     $class = null;
  109.                 }
  110.             }
  111.         }
  112.         if ($externalId) {
  113.             $msg[] = sprintf('the container inside "%s" is a smaller service locator that %s', $externalId, $this->formatAlternatives());
  114.         } else {
  115.             $msg[] = sprintf('the current service locator %s', $this->formatAlternatives());
  116.         }
  118.         if (!$class) {
  119.             // no-op
  120.         } elseif (is_subclass_of($class, ServiceSubscriberInterface::class)) {
  121.             $msg[] = sprintf('Unless you need extra laziness, try using dependency injection instead. Otherwise, you need to declare it using "%s::getSubscribedServices()".', preg_replace('/([^\\\\]++\\\\)++/', '', $class));
  122.         } else {
  123.             $msg[] = 'Try using dependency injection instead.';
  124.         }
  126.         return new ServiceNotFoundException($id, end($this->loading) ?: null, null, [], implode(' ', $msg));
  127.     }
  129.     private function createCircularReferenceException(string $id, array $path): ContainerExceptionInterface
  130.     {
  131.         return new ServiceCircularReferenceException($id, $path);
  132.     }
  134.     private function formatAlternatives(array $alternatives = null, string $separator = 'and'): string
  135.     {
  136.         $format = '"%s"%s';
  137.         if (null === $alternatives) {
  138.             if (!$alternatives = array_keys($this->factories)) {
  139.                 return 'is empty...';
  140.             }
  141.             $format = sprintf('only knows about the %s service%s.', $format, 1 < \count($alternatives) ? 's' : '');
  142.         }
  143.         $last = array_pop($alternatives);
  145.         return sprintf($format, $alternatives ? implode('", "', $alternatives) : $last, $alternatives ? sprintf(' %s "%s"', $separator, $last) : '');
  146.     }
  147. }