vendor/symfony/http-kernel/DataCollector/EventDataCollector.php line 61

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\HttpKernel\DataCollector;
  14. use Symfony\Component\EventDispatcher\Debug\TraceableEventDispatcher;
  15. use Symfony\Component\HttpFoundation\Request;
  16. use Symfony\Component\HttpFoundation\RequestStack;
  17. use Symfony\Component\HttpFoundation\Response;
  18. use Symfony\Component\VarDumper\Cloner\Data;
  19. use Symfony\Contracts\EventDispatcher\EventDispatcherInterface;
  20. use Symfony\Contracts\Service\ResetInterface;
  22. /**
  23. * @author Fabien Potencier <fabien@symfony.com>
  24. *
  25. * @final
  26. */
  27. class EventDataCollector extends DataCollector implements LateDataCollectorInterface
  28. {
  29. protected $dispatcher;
  30. private $requestStack;
  31. private $currentRequest;
  33. public function __construct(?EventDispatcherInterface $dispatcher = null, ?RequestStack $requestStack = null)
  34. {
  35. $this->dispatcher = $dispatcher;
  36. $this->requestStack = $requestStack;
  37. }
  39. /**
  40. * {@inheritdoc}
  41. */
  42. public function collect(Request $request, Response $response, ?\Throwable $exception = null)
  43. {
  44. $this->currentRequest = $this->requestStack && $this->requestStack->getMainRequest() !== $request ? $request : null;
  45. $this->data = [
  46. 'called_listeners' => [],
  47. 'not_called_listeners' => [],
  48. 'orphaned_events' => [],
  49. ];
  50. }
  52. public function reset()
  53. {
  54. $this->data = [];
  56. if ($this->dispatcher instanceof ResetInterface) {
  57. $this->dispatcher->reset();
  58. }
  59. }
  61. public function lateCollect()
  62. {
  63. if ($this->dispatcher instanceof TraceableEventDispatcher) {
  64. $this->setCalledListeners($this->dispatcher->getCalledListeners($this->currentRequest));
  65. $this->setNotCalledListeners($this->dispatcher->getNotCalledListeners($this->currentRequest));
  66. $this->setOrphanedEvents($this->dispatcher->getOrphanedEvents($this->currentRequest));
  67. }
  69. $this->data = $this->cloneVar($this->data);
  70. }
  72. /**
  73. * @param array $listeners An array of called listeners
  74. *
  75. * @see TraceableEventDispatcher
  76. */
  77. public function setCalledListeners(array $listeners)
  78. {
  79. $this->data['called_listeners'] = $listeners;
  80. }
  82. /**
  83. * @see TraceableEventDispatcher
  84. *
  85. * @return array|Data
  86. */
  87. public function getCalledListeners()
  88. {
  89. return $this->data['called_listeners'];
  90. }
  92. /**
  93. * @see TraceableEventDispatcher
  94. */
  95. public function setNotCalledListeners(array $listeners)
  96. {
  97. $this->data['not_called_listeners'] = $listeners;
  98. }
  100. /**
  101. * @see TraceableEventDispatcher
  102. *
  103. * @return array|Data
  104. */
  105. public function getNotCalledListeners()
  106. {
  107. return $this->data['not_called_listeners'];
  108. }
  110. /**
  111. * @param array $events An array of orphaned events
  112. *
  113. * @see TraceableEventDispatcher
  114. */
  115. public function setOrphanedEvents(array $events)
  116. {
  117. $this->data['orphaned_events'] = $events;
  118. }
  120. /**
  121. * @see TraceableEventDispatcher
  122. *
  123. * @return array|Data
  124. */
  125. public function getOrphanedEvents()
  126. {
  127. return $this->data['orphaned_events'];
  128. }
  130. /**
  131. * {@inheritdoc}
  132. */
  133. public function getName(): string
  134. {
  135. return 'events';
  136. }
  137. }