vendor/contao/core-bundle/src/Routing/ResponseContext/ResponseContext.php line 18

Open in your IDE?
  1. <?php
  3. declare(strict_types=1);
  5. /*
  6. * This file is part of Contao.
  7. *
  8. * (c) Leo Feyer
  9. *
  10. * @license LGPL-3.0-or-later
  11. */
  13. namespace Contao\CoreBundle\Routing\ResponseContext;
  15. use Contao\CoreBundle\Event\AbstractResponseContextEvent;
  16. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  18. final class ResponseContext
  19. {
  20. public const REQUEST_ATTRIBUTE_NAME = '_contao_response_context';
  22. private array $services = [];
  23. private array $current = [];
  24. private ?PartialResponseHeaderBag $headerBag = null;
  26. public function dispatchEvent(AbstractResponseContextEvent $event): void
  27. {
  28. if (!$this->has(EventDispatcherInterface::class)) {
  29. return;
  30. }
  32. $event->setResponseContext($this);
  34. /** @var EventDispatcherInterface $eventDispatcher */
  35. $eventDispatcher = $this->get(EventDispatcherInterface::class);
  36. $eventDispatcher->dispatch($event);
  37. }
  39. public function add(object $service): self
  40. {
  41. $this->registerService(\get_class($service), $service);
  43. return $this;
  44. }
  46. public function addLazy(string $classname, ?\Closure $factory = null): self
  47. {
  48. $factory ??= fn () => new $classname($this);
  50. $this->registerService($classname, $factory);
  52. return $this;
  53. }
  55. public function has(string $serviceId): bool
  56. {
  57. return isset($this->current[$serviceId]);
  58. }
  60. public function isInitialized(string $serviceId): bool
  61. {
  62. if (!$this->has($serviceId)) {
  63. return false;
  64. }
  66. return !$this->services[$serviceId] instanceof \Closure;
  67. }
  69. /**
  70. * @template T
  71. *
  72. * @param class-string<T> $serviceId
  73. *
  74. * @return object
  75. *
  76. * @phpstan-return T
  77. */
  78. public function get(string $serviceId)
  79. {
  80. if (!$this->has($serviceId)) {
  81. throw new \InvalidArgumentException(sprintf('Service "%s" does not exist.', $serviceId));
  82. }
  84. $serviceId = $this->current[$serviceId];
  86. // Lazy load the ones with factories
  87. if (!$this->isInitialized($serviceId)) {
  88. $service = $this->services[$serviceId]();
  89. $this->services[$serviceId] = $service;
  90. }
  92. return $this->services[$serviceId];
  93. }
  95. public function getHeaderBag(): PartialResponseHeaderBag
  96. {
  97. return $this->headerBag ??= new PartialResponseHeaderBag();
  98. }
  100. /**
  101. * @param \Closure|object $objectOrFactory
  102. */
  103. private function registerService(string $serviceId, $objectOrFactory): void
  104. {
  105. $this->services[$serviceId] = $objectOrFactory;
  106. $this->current[$serviceId] = $serviceId;
  108. foreach ($this->getAliases($serviceId) as $alias) {
  109. $this->current[$alias] = $serviceId;
  110. }
  111. }
  113. private function getAliases(string $classname): array
  114. {
  115. $aliases = [];
  116. $ref = new \ReflectionClass($classname);
  118. // Automatically add aliases for all interfaces and parents (last one added automatically wins by overriding here)
  119. foreach ($ref->getInterfaceNames() as $interfaceName) {
  120. $aliases[] = $interfaceName;
  121. }
  123. while ($ref = $ref->getParentClass()) {
  124. $aliases[] = $ref->getName();
  125. }
  127. return $aliases;
  128. }
  129. }