AdminNegotiator.php

Same filename and directory in other branches
  1. 9 core/modules/user/src/Theme/AdminNegotiator.php
  2. 8.9.x core/modules/user/src/Theme/AdminNegotiator.php
  3. 10 core/modules/user/src/Theme/AdminNegotiator.php

Namespace

Drupal\user\Theme

File

core/modules/user/src/Theme/AdminNegotiator.php

View source
<?php

namespace Drupal\user\Theme;

use Drupal\Core\Config\ConfigFactoryInterface;
use Drupal\Core\DependencyInjection\DeprecatedServicePropertyTrait;
use Drupal\Core\Entity\EntityTypeManagerInterface;
use Drupal\Core\Routing\AdminContext;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\Core\Session\AccountInterface;
use Drupal\Core\Theme\ThemeNegotiatorInterface;

/**
 * Sets the active theme on admin pages.
 */
class AdminNegotiator implements ThemeNegotiatorInterface {
  use DeprecatedServicePropertyTrait;
  
  /**
   * The service properties that should raise a deprecation error.
   */
  private array $deprecatedProperties = [
    'entityTypeManager' => 'entity_type.manager',
  ];
  
  /**
   * The current user.
   *
   * @var \Drupal\Core\Session\AccountInterface
   */
  protected $user;
  
  /**
   * The config factory.
   *
   * @var \Drupal\Core\Config\ConfigFactoryInterface
   */
  protected $configFactory;
  
  /**
   * The route admin context to determine whether a route is an admin one.
   *
   * @var \Drupal\Core\Routing\AdminContext
   */
  protected $adminContext;
  
  /**
   * Creates a new AdminNegotiator instance.
   *
   * @param \Drupal\Core\Session\AccountInterface $user
   *   The current user.
   * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
   *   The config factory.
   * @param \Drupal\Core\Routing\AdminContext|EntityTypeManagerInterface $admin_context
   *   The route admin context to determine whether the route is an admin one.
   */
  public function __construct(AccountInterface $user, ConfigFactoryInterface $config_factory, AdminContext|EntityTypeManagerInterface $admin_context) {
    $this->user = $user;
    $this->configFactory = $config_factory;
    if ($admin_context instanceof EntityTypeManagerInterface) {
      $deprecated_service_name = EntityTypeManagerInterface::class;
      @trigger_error("Passing the {$deprecated_service_name} (entity_type.manager service) to AdminNegotiator is deprecated in drupal:11.2.0 and will be removed in drupal:12.0.0. There is no replacement for this service, as it is not used. See https://www.drupal.org/project/drupal/issues/3501727", E_USER_DEPRECATED);
      $this->adminContext = \Drupal::service('router.admin_context');
    }
    else {
      $this->adminContext = $admin_context;
    }
  }
  
  /**
   * {@inheritdoc}
   */
  public function applies(RouteMatchInterface $route_match) {
    $is_admin_route = $this->adminContext
      ->isAdminRoute($route_match->getRouteObject());
    return $is_admin_route && $this->user
      ->hasPermission('view the administration theme');
  }
  
  /**
   * {@inheritdoc}
   */
  public function determineActiveTheme(RouteMatchInterface $route_match) {
    return $this->configFactory
      ->get('system.theme')
      ->get('admin') ?: NULL;
  }

}

Classes

Title Deprecated Summary
AdminNegotiator Sets the active theme on admin pages.

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