EntityAccessCheck.php in Zircon Profile 8.0
Same filename and directory in other branches
Contains \Drupal\Core\Entity\EntityAccessCheck.
Namespace
Drupal\Core\EntityFile
core/lib/Drupal/Core/Entity/EntityAccessCheck.phpView source
<?php
/**
* @file
* Contains \Drupal\Core\Entity\EntityAccessCheck.
*/
namespace Drupal\Core\Entity;
use Drupal\Core\Access\AccessResult;
use Drupal\Core\Routing\Access\AccessInterface;
use Drupal\Core\Routing\RouteMatchInterface;
use Drupal\Core\Session\AccountInterface;
use Symfony\Component\Routing\Route;
/**
* Provides a generic access checker for entities.
*/
class EntityAccessCheck implements AccessInterface {
/**
* Checks access to the entity operation on the given route.
*
* The value of the '_entity_access' key must be in the pattern
* 'entity_type.operation.' The entity type must match the {entity_type}
* parameter in the route pattern. This will check a node for 'update' access:
* @code
* pattern: '/foo/{node}/bar'
* requirements:
* _entity_access: 'node.update'
* @endcode
* Available operations are 'view', 'update', 'create', and 'delete'.
*
* @param \Symfony\Component\Routing\Route $route
* The route to check against.
* @param \Drupal\Core\Routing\RouteMatchInterface $route_match
* The parametrized route
* @param \Drupal\Core\Session\AccountInterface $account
* The currently logged in account.
*
* @return \Drupal\Core\Access\AccessResultInterface
* The access result.
*/
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 there is valid entity of the given entity type, check its access.
$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();
}
}
Classes
Name | Description |
---|---|
EntityAccessCheck | Provides a generic access checker for entities. |