Skip to main content
Drupal API
User account menu
  • Log in

Breadcrumb

  1. Drupal Core 11.1.x
  2. EventDataCollector.php

class EventDataCollector

@author Fabien Potencier <fabien@symfony.com>

@final

Hierarchy

  • class \Symfony\Component\HttpKernel\DataCollector\DataCollector implements \Symfony\Component\HttpKernel\DataCollector\DataCollectorInterface
    • class \Symfony\Component\HttpKernel\DataCollector\EventDataCollector extends \Symfony\Component\HttpKernel\DataCollector\DataCollector implements \Symfony\Component\HttpKernel\DataCollector\LateDataCollectorInterface

Expanded class hierarchy of EventDataCollector

See also

TraceableEventDispatcher

File

vendor/symfony/http-kernel/DataCollector/EventDataCollector.php, line 29

Namespace

Symfony\Component\HttpKernel\DataCollector
View source
class EventDataCollector extends DataCollector implements LateDataCollectorInterface {
    
    /** @var iterable<EventDispatcherInterface> */
    private iterable $dispatchers;
    private ?Request $currentRequest = null;
    
    /**
     * @param iterable<EventDispatcherInterface>|EventDispatcherInterface|null $dispatchers
     */
    public function __construct(iterable|EventDispatcherInterface|null $dispatchers = null, ?RequestStack $requestStack = null, string $defaultDispatcher = 'event_dispatcher') {
        if ($dispatchers instanceof EventDispatcherInterface) {
            $dispatchers = [
                $this->defaultDispatcher => $dispatchers,
            ];
        }
        $this->dispatchers = $dispatchers ?? [];
    }
    public function collect(Request $request, Response $response, ?\Throwable $exception = null) : void {
        $this->currentRequest = $this->requestStack && $this->requestStack
            ->getMainRequest() !== $request ? $request : null;
        $this->data = [];
    }
    public function reset() : void {
        parent::reset();
        foreach ($this->dispatchers as $dispatcher) {
            if ($dispatcher instanceof ResetInterface) {
                $dispatcher->reset();
            }
        }
    }
    public function lateCollect() : void {
        foreach ($this->dispatchers as $name => $dispatcher) {
            if (!$dispatcher instanceof TraceableEventDispatcher) {
                continue;
            }
            $this->setCalledListeners($dispatcher->getCalledListeners($this->currentRequest), $name);
            $this->setNotCalledListeners($dispatcher->getNotCalledListeners($this->currentRequest), $name);
            $this->setOrphanedEvents($dispatcher->getOrphanedEvents($this->currentRequest), $name);
        }
        $this->data = $this->cloneVar($this->data);
    }
    public function getData() : array|Data {
        return $this->data;
    }
    
    /**
     * @see TraceableEventDispatcher
     */
    public function setCalledListeners(array $listeners, ?string $dispatcher = null) : void {
        $this->data[$dispatcher ?? $this->defaultDispatcher]['called_listeners'] = $listeners;
    }
    
    /**
     * @see TraceableEventDispatcher
     */
    public function getCalledListeners(?string $dispatcher = null) : array|Data {
        return $this->data[$dispatcher ?? $this->defaultDispatcher]['called_listeners'] ?? [];
    }
    
    /**
     * @see TraceableEventDispatcher
     */
    public function setNotCalledListeners(array $listeners, ?string $dispatcher = null) : void {
        $this->data[$dispatcher ?? $this->defaultDispatcher]['not_called_listeners'] = $listeners;
    }
    
    /**
     * @see TraceableEventDispatcher
     */
    public function getNotCalledListeners(?string $dispatcher = null) : array|Data {
        return $this->data[$dispatcher ?? $this->defaultDispatcher]['not_called_listeners'] ?? [];
    }
    
    /**
     * @param array $events An array of orphaned events
     *
     * @see TraceableEventDispatcher
     */
    public function setOrphanedEvents(array $events, ?string $dispatcher = null) : void {
        $this->data[$dispatcher ?? $this->defaultDispatcher]['orphaned_events'] = $events;
    }
    
    /**
     * @see TraceableEventDispatcher
     */
    public function getOrphanedEvents(?string $dispatcher = null) : array|Data {
        return $this->data[$dispatcher ?? $this->defaultDispatcher]['orphaned_events'] ?? [];
    }
    public function getName() : string {
        return 'events';
    }

}

Members

Title Sort descending Modifiers Object type Summary Overriden Title Overrides
DataCollector::$cloner private property
DataCollector::$data protected property
DataCollector::cloneVar protected function Converts the variable into a serializable Data instance.
DataCollector::getCasters protected function 1
DataCollector::serialize final protected function @internal to prevent implementing \Serializable
DataCollector::unserialize final protected function @internal to prevent implementing \Serializable
DataCollector::__sleep public function 1
DataCollector::__wakeup public function 1
EventDataCollector::$currentRequest private property
EventDataCollector::$dispatchers private property @var iterable&lt;EventDispatcherInterface&gt;
EventDataCollector::collect public function Collects data for the given Request and Response. Overrides DataCollectorInterface::collect
EventDataCollector::getCalledListeners public function
EventDataCollector::getData public function
EventDataCollector::getName public function Returns the name of the collector. Overrides DataCollectorInterface::getName
EventDataCollector::getNotCalledListeners public function
EventDataCollector::getOrphanedEvents public function
EventDataCollector::lateCollect public function Collects data as late as possible. Overrides LateDataCollectorInterface::lateCollect
EventDataCollector::reset public function Overrides DataCollector::reset
EventDataCollector::setCalledListeners public function
EventDataCollector::setNotCalledListeners public function
EventDataCollector::setOrphanedEvents public function
EventDataCollector::__construct public function
RSS feed
Powered by Drupal