WorkspaceRequestSubscriber.php

Same filename in other branches
  1. 9 core/modules/workspaces/src/EventSubscriber/WorkspaceRequestSubscriber.php
  2. 8.9.x core/modules/workspaces/src/EventSubscriber/WorkspaceRequestSubscriber.php
  3. 11.x core/modules/workspaces/src/EventSubscriber/WorkspaceRequestSubscriber.php

Namespace

Drupal\workspaces\EventSubscriber

File

core/modules/workspaces/src/EventSubscriber/WorkspaceRequestSubscriber.php

View source
<?php

namespace Drupal\workspaces\EventSubscriber;

use Drupal\Core\Routing\CacheableRouteProviderInterface;
use Drupal\Core\Routing\RouteProviderInterface;
use Drupal\workspaces\WorkspaceManagerInterface;
use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Symfony\Component\HttpKernel\Event\RequestEvent;
use Symfony\Component\HttpKernel\KernelEvents;

/**
 * Provides a event subscriber for setting workspace-specific cache keys.
 *
 * @internal
 */
class WorkspaceRequestSubscriber implements EventSubscriberInterface {
    public function __construct(RouteProviderInterface $routeProvider, WorkspaceManagerInterface $workspaceManager) {
    }
    
    /**
     * Adds the active workspace as a cache key part to the route provider.
     *
     * @param \Symfony\Component\HttpKernel\Event\RequestEvent $event
     *   An event object.
     */
    public function onKernelRequest(RequestEvent $event) {
        if ($this->workspaceManager
            ->hasActiveWorkspace() && $this->routeProvider instanceof CacheableRouteProviderInterface) {
            $this->routeProvider
                ->addExtraCacheKeyPart('workspace', $this->workspaceManager
                ->getActiveWorkspace()
                ->id());
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public static function getSubscribedEvents() : array {
        // Use a priority of 33 in order to run before Symfony's router listener.
        // @see \Symfony\Component\HttpKernel\EventListener\RouterListener::getSubscribedEvents()
        $events[KernelEvents::REQUEST][] = [
            'onKernelRequest',
            33,
        ];
        return $events;
    }

}

Classes

Title Deprecated Summary
WorkspaceRequestSubscriber Provides a event subscriber for setting workspace-specific cache keys.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.