vendor/symfony/doctrine-bridge/ContainerAwareEventManager.php line 143

  1. <?php
  3. /*
  4. * This file is part of the Symfony package.
  5. *
  6. * (c) Fabien Potencier <[email protected]>
  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\Bridge\Doctrine;
  14. use Doctrine\Common\EventArgs;
  15. use Doctrine\Common\EventManager;
  16. use Doctrine\Common\EventSubscriber;
  17. use Psr\Container\ContainerInterface;
  19. /**
  20. * Allows lazy loading of listener and subscriber services.
  21. *
  22. * @author Johannes M. Schmitt <[email protected]>
  23. */
  24. class ContainerAwareEventManager extends EventManager
  25. {
  26. /**
  27. * Map of registered listeners.
  28. *
  29. * <event> => <listeners>
  30. */
  31. private array $listeners = [];
  32. private array $initialized = [];
  33. private bool $initializedSubscribers = false;
  34. private array $initializedHashMapping = [];
  35. private array $methods = [];
  36. private ContainerInterface $container;
  38. /**
  39. * @param list<array{string[], string|object}> $listeners List of [events, listener] tuples
  40. */
  41. public function __construct(ContainerInterface $container, array $listeners = [])
  42. {
  43. $this->container = $container;
  44. $this->listeners = $listeners;
  45. }
  47. public function dispatchEvent($eventName, ?EventArgs $eventArgs = null): void
  48. {
  49. if (!$this->initializedSubscribers) {
  50. $this->initializeSubscribers();
  51. }
  52. if (!isset($this->listeners[$eventName])) {
  53. return;
  54. }
  56. $eventArgs ??= EventArgs::getEmptyInstance();
  58. if (!isset($this->initialized[$eventName])) {
  59. $this->initializeListeners($eventName);
  60. }
  62. foreach ($this->listeners[$eventName] as $hash => $listener) {
  63. $listener->{$this->methods[$eventName][$hash]}($eventArgs);
  64. }
  65. }
  67. public function getListeners($event = null): array
  68. {
  69. if (null === $event) {
  70. trigger_deprecation('symfony/doctrine-bridge', '6.2', 'Calling "%s()" without an event name is deprecated. Call "getAllListeners()" instead.', __METHOD__);
  72. return $this->getAllListeners();
  73. }
  74. if (!$this->initializedSubscribers) {
  75. $this->initializeSubscribers();
  76. }
  77. if (!isset($this->initialized[$event])) {
  78. $this->initializeListeners($event);
  79. }
  81. return $this->listeners[$event];
  82. }
  84. public function getAllListeners(): array
  85. {
  86. if (!$this->initializedSubscribers) {
  87. $this->initializeSubscribers();
  88. }
  90. foreach ($this->listeners as $event => $listeners) {
  91. if (!isset($this->initialized[$event])) {
  92. $this->initializeListeners($event);
  93. }
  94. }
  96. return $this->listeners;
  97. }
  99. public function hasListeners($event): bool
  100. {
  101. if (!$this->initializedSubscribers) {
  102. $this->initializeSubscribers();
  103. }
  105. return isset($this->listeners[$event]) && $this->listeners[$event];
  106. }
  108. public function addEventListener($events, $listener): void
  109. {
  110. if (!$this->initializedSubscribers) {
  111. $this->initializeSubscribers();
  112. }
  114. $hash = $this->getHash($listener);
  116. foreach ((array) $events as $event) {
  117. // Overrides listener if a previous one was associated already
  118. // Prevents duplicate listeners on same event (same instance only)
  119. $this->listeners[$event][$hash] = $listener;
  121. if (\is_string($listener)) {
  122. unset($this->initialized[$event]);
  123. unset($this->initializedHashMapping[$event][$hash]);
  124. } else {
  125. $this->methods[$event][$hash] = $this->getMethod($listener, $event);
  126. }
  127. }
  128. }
  130. public function removeEventListener($events, $listener): void
  131. {
  132. if (!$this->initializedSubscribers) {
  133. $this->initializeSubscribers();
  134. }
  136. $hash = $this->getHash($listener);
  138. foreach ((array) $events as $event) {
  139. if (isset($this->initializedHashMapping[$event][$hash])) {
  140. $hash = $this->initializedHashMapping[$event][$hash];
  141. unset($this->initializedHashMapping[$event][$hash]);
  142. }
  144. // Check if we actually have this listener associated
  145. if (isset($this->listeners[$event][$hash])) {
  146. unset($this->listeners[$event][$hash]);
  147. }
  149. if (isset($this->methods[$event][$hash])) {
  150. unset($this->methods[$event][$hash]);
  151. }
  152. }
  153. }
  155. public function addEventSubscriber(EventSubscriber $subscriber): void
  156. {
  157. if (!$this->initializedSubscribers) {
  158. $this->initializeSubscribers();
  159. }
  161. parent::addEventSubscriber($subscriber);
  162. }
  164. public function removeEventSubscriber(EventSubscriber $subscriber): void
  165. {
  166. if (!$this->initializedSubscribers) {
  167. $this->initializeSubscribers();
  168. }
  170. parent::removeEventSubscriber($subscriber);
  171. }
  173. private function initializeListeners(string $eventName): void
  174. {
  175. $this->initialized[$eventName] = true;
  177. // We'll refill the whole array in order to keep the same order
  178. $listeners = [];
  179. foreach ($this->listeners[$eventName] as $hash => $listener) {
  180. if (\is_string($listener)) {
  181. $listener = $this->container->get($listener);
  182. $newHash = $this->getHash($listener);
  184. $this->initializedHashMapping[$eventName][$hash] = $newHash;
  186. $listeners[$newHash] = $listener;
  188. $this->methods[$eventName][$newHash] = $this->getMethod($listener, $eventName);
  189. } else {
  190. $listeners[$hash] = $listener;
  191. }
  192. }
  194. $this->listeners[$eventName] = $listeners;
  195. }
  197. private function initializeSubscribers(): void
  198. {
  199. $this->initializedSubscribers = true;
  200. $listeners = $this->listeners;
  201. $this->listeners = [];
  202. foreach ($listeners as $listener) {
  203. if (\is_array($listener)) {
  204. $this->addEventListener(...$listener);
  205. continue;
  206. }
  207. if (\is_string($listener)) {
  208. $listener = $this->container->get($listener);
  209. }
  210. // throw new \InvalidArgumentException(sprintf('Using Doctrine subscriber "%s" is not allowed. Register it as a listener instead, using e.g. the #[AsDoctrineListener] or #[AsDocumentListener] attribute.', \is_object($listener) ? $listener::class : $listener));
  211. trigger_deprecation('symfony/doctrine-bridge', '6.3', 'Registering "%s" as a Doctrine subscriber is deprecated. Register it as a listener instead, using e.g. the #[AsDoctrineListener] or #[AsDocumentListener] attribute.', \is_object($listener) ? get_debug_type($listener) : $listener);
  212. parent::addEventSubscriber($listener);
  213. }
  214. }
  216. private function getHash(string|object $listener): string
  217. {
  218. if (\is_string($listener)) {
  219. return '_service_'.$listener;
  220. }
  222. return spl_object_hash($listener);
  223. }
  225. private function getMethod(object $listener, string $event): string
  226. {
  227. if (!method_exists($listener, $event) && method_exists($listener, '__invoke')) {
  228. return '__invoke';
  229. }
  231. return $event;
  232. }
  233. }