NodeAdminRouteSubscriber.php

Same filename in other branches
  1. 9 core/modules/node/src/EventSubscriber/NodeAdminRouteSubscriber.php
  2. 10 core/modules/node/src/EventSubscriber/NodeAdminRouteSubscriber.php
  3. 11.x core/modules/node/src/EventSubscriber/NodeAdminRouteSubscriber.php

Namespace

Drupal\node\EventSubscriber

File

core/modules/node/src/EventSubscriber/NodeAdminRouteSubscriber.php

View source
<?php

namespace Drupal\node\EventSubscriber;

use Drupal\Core\Config\ConfigCrudEvent;
use Drupal\Core\Config\ConfigEvents;
use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\Routing\RouteBuilderInterface;
use Drupal\Core\Routing\RouteSubscriberBase;
use Symfony\Component\Routing\RouteCollection;

/**
 * Sets the _admin_route for specific node-related routes.
 */
class NodeAdminRouteSubscriber extends RouteSubscriberBase {
    
    /**
     * The config factory.
     *
     * @var \Drupal\Core\Config\ConfigFactoryInterface
     */
    protected $configFactory;
    
    /**
     * The router builder.
     *
     * @var \Drupal\Core\Routing\RouteBuilderInterface
     */
    protected $routerBuilder;
    
    /**
     * Constructs a new NodeAdminRouteSubscriber.
     *
     * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
     *   The config factory.
     * @param \Drupal\Core\Routing\RouteBuilderInterface $router_builder
     *   The router builder service.
     */
    public function __construct(ConfigFactoryInterface $config_factory, RouteBuilderInterface $router_builder) {
        $this->configFactory = $config_factory;
        $this->routerBuilder = $router_builder;
    }
    
    /**
     * {@inheritdoc}
     */
    protected function alterRoutes(RouteCollection $collection) {
        if ($this->configFactory
            ->get('node.settings')
            ->get('use_admin_theme')) {
            foreach ($collection->all() as $route) {
                if ($route->hasOption('_node_operation_route')) {
                    $route->setOption('_admin_route', TRUE);
                }
            }
        }
    }
    
    /**
     * Rebuilds the router when node.settings:use_admin_theme is changed.
     *
     * @param \Drupal\Core\Config\ConfigCrudEvent $event
     */
    public function onConfigSave(ConfigCrudEvent $event) {
        if ($event->getConfig()
            ->getName() === 'node.settings' && $event->isChanged('use_admin_theme')) {
            $this->routerBuilder
                ->setRebuildNeeded();
        }
    }
    
    /**
     * {@inheritdoc}
     */
    public static function getSubscribedEvents() {
        $events = parent::getSubscribedEvents();
        $events[ConfigEvents::SAVE][] = [
            'onConfigSave',
            0,
        ];
        return $events;
    }

}

Classes

Title Deprecated Summary
NodeAdminRouteSubscriber Sets the _admin_route for specific node-related routes.

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