public function AccessManager::check in Drupal 9

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Access/AccessManager.php \Drupal\Core\Access\AccessManager::check()
2. 10 core/lib/Drupal/Core/Access/AccessManager.php \Drupal\Core\Access\AccessManager::check()

Checks a route against applicable access check services.

Determines whether the route is accessible or not.

Parameters

\Drupal\Core\Routing\RouteMatchInterface $route_match: The route match.

\Drupal\Core\Session\AccountInterface $account: (optional) Run access checks for this account. Defaults to the current user.

\Symfony\Component\HttpFoundation\Request $request: Optional, a request. Only supply this parameter when checking the incoming request, do not specify when checking routes on output.

bool $return_as_object: (optional) Defaults to FALSE.

Return value

bool|\Drupal\Core\Access\AccessResultInterface The access result. Returns a boolean if $return_as_object is FALSE (this is the default) and otherwise an AccessResultInterface object. When a boolean is returned, the result of AccessInterface::isAllowed() is returned, i.e. TRUE means access is explicitly allowed, FALSE means access is either explicitly forbidden or "no opinion".

Overrides AccessManagerInterface::check

2 calls to AccessManager::check()

AccessManager::checkNamedRoute in core/lib/Drupal/Core/Access/AccessManager.php

Checks a named route with parameters against applicable access check services.

AccessManager::checkRequest in core/lib/Drupal/Core/Access/AccessManager.php

Execute access checks against the incoming request.

File

core/lib/Drupal/Core/Access/AccessManager.php, line 118

Class

AccessManager

Attaches access check services to routes and runs them on request.

Namespace

Drupal\Core\Access

Code

public function check(RouteMatchInterface $route_match, AccountInterface $account = NULL, Request $request = NULL, $return_as_object = FALSE) {
  if (!isset($account)) {
    $account = $this->currentUser;
  }
  $route = $route_match
    ->getRouteObject();
  $checks = $route
    ->getOption('_access_checks') ?: [];

  // Filter out checks which require the incoming request.
  if (!isset($request)) {
    $checks = array_diff($checks, $this->checkProvider
      ->getChecksNeedRequest());
  }
  $result = AccessResult::neutral();
  if (!empty($checks)) {
    $arguments_resolver = $this->argumentsResolverFactory
      ->getArgumentsResolver($route_match, $account, $request);
    $result = AccessResult::allowed();
    foreach ($checks as $service_id) {
      $result = $result
        ->andIf($this
        ->performCheck($service_id, $arguments_resolver));
    }
  }
  return $return_as_object ? $result : $result
    ->isAllowed();
}