class EntityBundleAccessCheck

Same name and namespace in other branches
  1. 9 core/lib/Drupal/Core/Entity/EntityBundleAccessCheck.php \Drupal\Core\Entity\EntityBundleAccessCheck

Provides an entity bundle checker for the _entity_bundles route requirement.

Hierarchy

Expanded class hierarchy of EntityBundleAccessCheck

1 file declares its use of EntityBundleAccessCheck
EntityBundleAccessCheckTest.php in core/tests/Drupal/Tests/Core/Entity/EntityBundleAccessCheckTest.php
1 string reference to 'EntityBundleAccessCheck'
core.services.yml in core/core.services.yml
core/core.services.yml
1 service uses EntityBundleAccessCheck
access_check.entity_bundles in core/core.services.yml
Drupal\Core\Entity\EntityBundleAccessCheck

File

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

Namespace

Drupal\Core\Entity
View source 
class EntityBundleAccessCheck implements AccessInterface {
    
    /**
     * Checks entity bundle match based on the _entity_bundles route requirement.
     *
     * @code
     * example.route:
     *   path: foo/{example_entity_type}/{other_parameter}
     *   requirements:
     *     _entity_bundles: 'example_entity_type:example_bundle|other_example_bundle'
     * @endcode
     *
     * @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) {
        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.');
    }

}

Members

Title Modifiers Object type Summary
EntityBundleAccessCheck::access public function Checks entity bundle match based on the _entity_bundles route requirement.

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.