class NodeAccessGrantsCacheContext in Drupal 9

Defines the node access view cache context service.

Cache context ID: 'user.node_grants' (to vary by all operations' grants). Calculated cache context ID: 'user.node_grants:%operation', e.g. 'user.node_grants:view' (to vary by the view operation's grants).

This allows for node access grants-sensitive caching when listing nodes.

Hierarchy

• class \Drupal\Core\Cache\Context\UserCacheContextBase
  • class \Drupal\node\Cache\NodeAccessGrantsCacheContext implements CalculatedCacheContextInterface

See also

node_query_node_access_alter()

Related topics

Node access rights

The node access system determines who can do what to which nodes.

1 string reference to 'NodeAccessGrantsCacheContext'

node.services.yml in core/modules/node/node.services.yml

core/modules/node/node.services.yml

1 service uses NodeAccessGrantsCacheContext

cache_context.user.node_grants in core/modules/node/node.services.yml

Drupal\node\Cache\NodeAccessGrantsCacheContext

File

core/modules/node/src/Cache/NodeAccessGrantsCacheContext.php, line 21

Namespace

Drupal\node\Cache

class NodeAccessGrantsCacheContext extends UserCacheContextBase implements CalculatedCacheContextInterface {

  /**
   * {@inheritdoc}
   */
  public static function getLabel() {
    return t("Content access view grants");
  }

  /**
   * {@inheritdoc}
   */
  public function getContext($operation = NULL) {

    // If the current user either can bypass node access then we don't need to
    // determine the exact node grants for the current user.
    if ($this->user
      ->hasPermission('bypass node access')) {
      return 'all';
    }

    // When no specific operation is specified, check the grants for all three
    // possible operations.
    if ($operation === NULL) {
      $result = [];
      foreach ([
        'view',
        'update',
        'delete',
      ] as $op) {
        $result[] = $this
          ->checkNodeGrants($op);
      }
      return implode('-', $result);
    }
    else {
      return $this
        ->checkNodeGrants($operation);
    }
  }

  /**
   * Checks the node grants for the given operation.
   *
   * @param string $operation
   *   The operation to check the node grants for.
   *
   * @return string
   *   The string representation of the cache context.
   */
  protected function checkNodeGrants($operation) {

    // When checking the grants for the 'view' operation and the current user
    // has a global view grant (i.e. a view grant for node ID 0) — note that
    // this is automatically the case if no node access modules exist (no
    // hook_node_grants() implementations) then we don't need to determine the
    // exact node view grants for the current user.
    if ($operation === 'view' && node_access_view_all_nodes($this->user)) {
      return 'view.all';
    }
    $grants = node_access_grants($operation, $this->user);
    $grants_context_parts = [];
    foreach ($grants as $realm => $gids) {
      $grants_context_parts[] = $realm . ':' . implode(',', $gids);
    }
    return $operation . '.' . implode(';', $grants_context_parts);
  }

  /**
   * {@inheritdoc}
   */
  public function getCacheableMetadata($operation = NULL) {
    $cacheable_metadata = new CacheableMetadata();
    if (!\Drupal::moduleHandler()
      ->getImplementations('node_grants')) {
      return $cacheable_metadata;
    }

    // The node grants may change if the user is updated. (The max-age is set to
    // zero below, but sites may override this cache context, and change it to a
    // non-zero value. In such cases, this cache tag is needed for correctness.)
    $cacheable_metadata
      ->setCacheTags([
      'user:' . $this->user
        ->id(),
    ]);

    // If the site is using node grants, this cache context can not be
    // optimized.
    return $cacheable_metadata
      ->setCacheMaxAge(0);
  }

}

Members

Name	Modifiers	Type	Description	Overrides
NodeAccessGrantsCacheContext::checkNodeGrants	protected	function	Checks the node grants for the given operation.
NodeAccessGrantsCacheContext::getCacheableMetadata	public	function	Gets the cacheability metadata for the context based on the parameter value. Overrides CalculatedCacheContextInterface::getCacheableMetadata
NodeAccessGrantsCacheContext::getContext	public	function	Returns the string representation of the cache context. Overrides CalculatedCacheContextInterface::getContext
NodeAccessGrantsCacheContext::getLabel	public static	function	Returns the label of the cache context. Overrides CalculatedCacheContextInterface::getLabel
UserCacheContextBase::$user	protected	property	The account object.
UserCacheContextBase::__construct	public	function	Constructs a new UserCacheContextBase class.	1