NoBigPipeRouteAlterSubscriber.php

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

Namespace

Drupal\big_pipe\EventSubscriber

File

core/modules/big_pipe/src/EventSubscriber/NoBigPipeRouteAlterSubscriber.php

View source
<?php

namespace Drupal\big_pipe\EventSubscriber;

use Symfony\Component\EventDispatcher\EventSubscriberInterface;
use Drupal\Core\Routing\RoutingEvents;
use Drupal\Core\Routing\RouteBuildEvent;

/**
 * Sets the '_no_big_pipe' option on select routes.
 */
class NoBigPipeRouteAlterSubscriber implements EventSubscriberInterface {
    
    /**
     * Alters select routes to have the '_no_big_pipe' option.
     *
     * @param \Drupal\Core\Routing\RouteBuildEvent $event
     *   The event to process.
     */
    public function onRoutingRouteAlterSetNoBigPipe(RouteBuildEvent $event) {
        $no_big_pipe_routes = [
            // The batch system uses a <meta> refresh to work without JavaScript.
'system.batch_page.html',
            // When a user would install the BigPipe module using a browser and with
            // JavaScript disabled, the first response contains the status messages
            // for installing a module, but then the BigPipe no-JS redirect occurs,
            // which then causes the user to not see those status messages.
            // @see https://www.drupal.org/node/2469431#comment-10901944
'system.modules_list',
        ];
        $route_collection = $event->getRouteCollection();
        foreach ($no_big_pipe_routes as $excluded_route) {
            if ($route = $route_collection->get($excluded_route)) {
                $route->setOption('_no_big_pipe', TRUE);
            }
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public static function getSubscribedEvents() : array {
        $events[RoutingEvents::ALTER][] = [
            'onRoutingRouteAlterSetNoBigPipe',
        ];
        return $events;
    }

}

Classes

Title Deprecated Summary
NoBigPipeRouteAlterSubscriber Sets the '_no_big_pipe' option on select routes.

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