DefaultAccessCheck.php

Same filename in other branches
  1. 8.9.x core/lib/Drupal/Core/Access/DefaultAccessCheck.php
  2. 10 core/lib/Drupal/Core/Access/DefaultAccessCheck.php
  3. 11.x core/lib/Drupal/Core/Access/DefaultAccessCheck.php

Namespace

Drupal\Core\Access

File

core/lib/Drupal/Core/Access/DefaultAccessCheck.php

View source
<?php

namespace Drupal\Core\Access;

use Drupal\Core\Routing\Access\AccessInterface as RoutingAccessInterface;
use Symfony\Component\Routing\Route;

/**
 * Allows access to routes to be controlled by an '_access' boolean parameter.
 */
class DefaultAccessCheck implements RoutingAccessInterface {
    
    /**
     * Checks access to the route based on the _access parameter.
     *
     * @param \Symfony\Component\Routing\Route $route
     *   The route to check against.
     *
     * @return \Drupal\Core\Access\AccessResultInterface
     *   The access result.
     */
    public function access(Route $route) {
        if ($route->getRequirement('_access') === 'TRUE') {
            return AccessResult::allowed();
        }
        elseif ($route->getRequirement('_access') === 'FALSE') {
            return AccessResult::forbidden();
        }
        else {
            return AccessResult::neutral();
        }
    }

}

Classes

Title Deprecated Summary
DefaultAccessCheck Allows access to routes to be controlled by an '_access' boolean parameter.

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