AccessPolicyProcessorInterface.php

Same filename in other branches
  1. 10 core/lib/Drupal/Core/Session/AccessPolicyProcessorInterface.php

Namespace

Drupal\Core\Session

File

core/lib/Drupal/Core/Session/AccessPolicyProcessorInterface.php

View source
<?php

namespace Drupal\Core\Session;


/**
 * Processes all added access policies until the full permissions are built.
 */
interface AccessPolicyProcessorInterface {
    
    /**
     * Adds an access policy.
     *
     * @param \Drupal\Core\Session\AccessPolicyInterface $access_policy
     *   The access policy.
     */
    public function addAccessPolicy(AccessPolicyInterface $access_policy) : void;
    
    /**
     * Processes the access policies for an account within a given scope.
     *
     * @param \Drupal\Core\Session\AccountInterface $account
     *   The user account for which to calculate the permissions.
     * @param string $scope
     *   (optional) The scope to calculate the permissions, defaults to 'drupal'.
     *
     * @return \Drupal\Core\Session\CalculatedPermissionsInterface
     *   The access policies' permissions within the given scope.
     */
    public function processAccessPolicies(AccountInterface $account, string $scope = AccessPolicyInterface::SCOPE_DRUPAL) : CalculatedPermissionsInterface;

}

Interfaces

Title Deprecated Summary
AccessPolicyProcessorInterface Processes all added access policies until the full permissions are built.

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