class AdminNegotiator
Same name in other branches
- 9 core/modules/user/src/Theme/AdminNegotiator.php \Drupal\user\Theme\AdminNegotiator
- 8.9.x core/modules/user/src/Theme/AdminNegotiator.php \Drupal\user\Theme\AdminNegotiator
- 10 core/modules/user/src/Theme/AdminNegotiator.php \Drupal\user\Theme\AdminNegotiator
Sets the active theme on admin pages.
Hierarchy
- class \Drupal\user\Theme\AdminNegotiator implements \Drupal\Core\Theme\ThemeNegotiatorInterface uses \Drupal\Core\DependencyInjection\DeprecatedServicePropertyTrait
Expanded class hierarchy of AdminNegotiator
1 file declares its use of AdminNegotiator
- AdminNegotiatorTest.php in core/
modules/ user/ tests/ src/ Unit/ Theme/ AdminNegotiatorTest.php
1 string reference to 'AdminNegotiator'
- user.services.yml in core/
modules/ user/ user.services.yml - core/modules/user/user.services.yml
1 service uses AdminNegotiator
- theme.negotiator.admin_theme in core/
modules/ user/ user.services.yml - Drupal\user\Theme\AdminNegotiator
File
-
core/
modules/ user/ src/ Theme/ AdminNegotiator.php, line 16
Namespace
Drupal\user\ThemeView source
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;
}
}
Members
Title Sort descending | Modifiers | Object type | Summary | Overriden Title |
---|---|---|---|---|
AdminNegotiator::$adminContext | protected | property | The route admin context to determine whether a route is an admin one. | |
AdminNegotiator::$configFactory | protected | property | The config factory. | |
AdminNegotiator::$deprecatedProperties | private | property | The service properties that should raise a deprecation error. | |
AdminNegotiator::$user | protected | property | The current user. | |
AdminNegotiator::applies | public | function | Whether this theme negotiator should be used to set the theme. | Overrides ThemeNegotiatorInterface::applies |
AdminNegotiator::determineActiveTheme | public | function | Determine the active theme for the request. | Overrides ThemeNegotiatorInterface::determineActiveTheme |
AdminNegotiator::__construct | public | function | Creates a new AdminNegotiator instance. | |
DeprecatedServicePropertyTrait::__get | public | function | Allows to access deprecated/removed properties. |
Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.