public function EntityBundleAccessCheck::access in Drupal 9

Same name and namespace in other branches

1. 8 core/lib/Drupal/Core/Entity/EntityBundleAccessCheck.php \Drupal\Core\Entity\EntityBundleAccessCheck::access()

Checks entity bundle match based on the _entity_bundles route requirement.

example.route:
  path: foo/{example_entity_type}/{other_parameter}
  requirements:
    _entity_bundles: 'example_entity_type:example_bundle|other_example_bundle'

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.

File

core/lib/Drupal/Core/Entity/EntityBundleAccessCheck.php, line 42

Class

EntityBundleAccessCheck

Provides an entity bundle checker for the _entity_bundles route requirement.

Namespace

Drupal\Core\Entity

Code

public function access(Route $route, RouteMatchInterface $route_match, AccountInterface $account) {
  @trigger_error('The ' . __NAMESPACE__ . '\\EntityBundleAccessCheck is deprecated in drupal:9.2.0 and is removed from drupal:10.0.0. Specify the list of bundles in the entity parameter, under "bundle" key, as a sequence, instead. See https://www.drupal.org/node/3155569', E_USER_DEPRECATED);
  if ($route
    ->hasRequirement('_entity_bundles')) {
    list($entity_type, $bundle_definition) = explode(':', $route
      ->getRequirement('_entity_bundles'));
    $bundles = explode('|', $bundle_definition);
    $parameters = $route_match
      ->getParameters();
    if ($parameters
      ->has($entity_type)) {
      $entity = $parameters
        ->get($entity_type);
      if ($entity instanceof EntityInterface && in_array($entity
        ->bundle(), $bundles, TRUE)) {
        return AccessResult::allowed()
          ->addCacheableDependency($entity);
      }
    }
  }
  return AccessResult::neutral('The entity bundle does not match the route _entity_bundles requirement.');
}