AdminContext.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/Routing/AdminContext.php
  2. 8.9.x core/lib/Drupal/Core/Routing/AdminContext.php
  3. 11.x core/lib/Drupal/Core/Routing/AdminContext.php

Namespace

Drupal\Core\Routing

File

core/lib/Drupal/Core/Routing/AdminContext.php

View source
<?php

namespace Drupal\Core\Routing;

use Symfony\Component\Routing\Route;

/**
 * Provides a helper class to determine whether the route is an admin one.
 */
class AdminContext {
    
    /**
     * The route match.
     *
     * @var \Drupal\Core\Routing\RouteMatchInterface
     */
    protected $routeMatch;
    
    /**
     * Construct a new admin context helper instance.
     *
     * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
     *   The route match.
     */
    public function __construct(RouteMatchInterface $route_match) {
        $this->routeMatch = $route_match;
    }
    
    /**
     * Determines whether the active route is an admin one.
     *
     * @param \Symfony\Component\Routing\Route $route
     *   (optional) The route to determine whether it is an admin one. Per default
     *   this falls back to the route object on the active request.
     *
     * @return bool
     *   Returns TRUE if the route is an admin one, otherwise FALSE.
     */
    public function isAdminRoute(?Route $route = NULL) {
        if (!$route) {
            $route = $this->routeMatch
                ->getRouteObject();
            if (!$route) {
                return FALSE;
            }
        }
        return (bool) $route->getOption('_admin_route');
    }

}

Classes

Title Deprecated Summary
AdminContext Provides a helper class to determine whether the route is an admin one.

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