1. interface
  2. Drupal
  3. \
  4. Core
  5. \
  6. Access
  7. \
  8. AccessManagerInterface

AccessManagerInterface

interface AccessManagerInterface (View source)

Provides an interface for attaching and running access check services.

Methods

bool|AccessResultInterface
checkNamedRoute(string $route_name, array $parameters = [], AccountInterface $account = NULL, bool $return_as_object = FALSE)

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

bool|AccessResultInterface
checkRequest(Request $request, AccountInterface $account = NULL, bool $return_as_object = FALSE)

Execute access checks against the incoming request.

bool|AccessResultInterface
check(RouteMatchInterface $route_match, AccountInterface $account = NULL, Request $request = NULL, bool $return_as_object = FALSE)

Checks a route against applicable access check services.

Details

at line 36
bool|AccessResultInterface checkNamedRoute(string $route_name, array $parameters = [], AccountInterface $account = NULL, bool $return_as_object = FALSE)

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

Determines whether the route is accessible or not.

Parameters

string $route_name

The route to check access to.
array $parameters

Optional array of values to substitute into the route path pattern.
AccountInterface $account

(optional) Run access checks for this account. Defaults to the current user.
bool $return_as_object

(optional) Defaults to FALSE.

Return Value

bool|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".

at line 56
bool|AccessResultInterface checkRequest(Request $request, AccountInterface $account = NULL, bool $return_as_object = FALSE)

Execute access checks against the incoming request.

Parameters

Request $request

The incoming request.
AccountInterface $account

(optional) Run access checks for this account. Defaults to the current user.
bool $return_as_object

(optional) Defaults to FALSE.

Return Value

bool|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".

at line 81
bool|AccessResultInterface check(RouteMatchInterface $route_match, AccountInterface $account = NULL, Request $request = NULL, bool $return_as_object = FALSE)

Checks a route against applicable access check services.

Determines whether the route is accessible or not.

Parameters

RouteMatchInterface $route_match

The route match.
AccountInterface $account

(optional) Run access checks for this account. Defaults to the current user.
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|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".