12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273 |
- <?php
- 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 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':
- * @code
- * pattern: '/foo/{node}/bar'
- * requirements:
- * _entity_access: 'node.update'
- * @endcode
- * And this will check 'delete' access to a dynamic entity type:
- * @code
- * example.route:
- * path: foo/{entity_type}/{example}
- * requirements:
- * _entity_access: example.delete
- * options:
- * parameters:
- * example:
- * type: entity:{entity_type}
- * @endcode
- * The route match parameter corresponding to the stub name is checked to
- * see if it is entity-like i.e. implements EntityInterface.
- *
- * @see \Drupal\Core\ParamConverter\EntityConverter
- *
- * @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 $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();
- }
- }
|