public function EntityAccessCheck::access in Drupal 8
Same name and namespace in other branches
- 9 core/lib/Drupal/Core/Entity/EntityAccessCheck.php \Drupal\Core\Entity\EntityAccessCheck::access()
Checks access to the entity operation on the given route.
The route's '_entity_access' requirement must follow the pattern 'entity_stub_name.operation', where available operations are: 'view', 'update', 'create', and 'delete'.
For example, this route configuration invokes a permissions check for 'update' access to entities of type 'node':
pattern: '/foo/{node}/bar'
requirements:
_entity_access: 'node.update'
And this will check 'delete' access to a dynamic entity type:
example.route:
path: foo/{entity_type}/{example}
requirements:
_entity_access: example.delete
options:
parameters:
example:
type: entity:{entity_type}
The route match parameter corresponding to the stub name is checked to see if it is entity-like i.e. implements EntityInterface.
Parameters
\Symfony\Component\Routing\Route $route: The route to check against.
\Drupal\Core\Routing\RouteMatchInterface $route_match: The parametrized route
\Drupal\Core\Session\AccountInterface $account: The currently logged in account.
Return value
\Drupal\Core\Access\AccessResultInterface The access result.
See also
\Drupal\Core\ParamConverter\EntityConverter
File
- core/
lib/ Drupal/ Core/ Entity/ EntityAccessCheck.php, line 56
Class
- EntityAccessCheck
- Provides a generic access checker for entities.
Namespace
Drupal\Core\EntityCode
public function access(Route $route, RouteMatchInterface $route_match, AccountInterface $account) {
// Split the entity type and the operation.
$requirement = $route
->getRequirement('_entity_access');
list($entity_type, $operation) = explode('.', $requirement);
// If $entity_type parameter is a valid entity, call its own access check.
$parameters = $route_match
->getParameters();
if ($parameters
->has($entity_type)) {
$entity = $parameters
->get($entity_type);
if ($entity instanceof EntityInterface) {
return $entity
->access($operation, $account, TRUE);
}
}
// No opinion, so other access checks should decide if access should be
// allowed or not.
return AccessResult::neutral();
}