PermissionsHashGeneratorInterface.php

Same filename in other branches
  1. 9 core/lib/Drupal/Core/Session/PermissionsHashGeneratorInterface.php
  2. 8.9.x core/lib/Drupal/Core/Session/PermissionsHashGeneratorInterface.php
  3. 11.x core/lib/Drupal/Core/Session/PermissionsHashGeneratorInterface.php

Namespace

Drupal\Core\Session

File

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

View source
<?php

namespace Drupal\Core\Session;

use Drupal\Core\Cache\CacheableMetadata;

/**
 * Defines the user permissions hash generator interface.
 */
interface PermissionsHashGeneratorInterface {
    
    /**
     * Generates a hash that uniquely identifies a user's permissions.
     *
     * @param \Drupal\Core\Session\AccountInterface $account
     *   The user account for which to get the permissions hash.
     *
     * @return string
     *   A permissions hash.
     */
    public function generate(AccountInterface $account);
    
    /**
     * Gets the cacheability metadata for the generated hash.
     *
     * @param \Drupal\Core\Session\AccountInterface $account
     *   The user account for which to get the permissions hash.
     *
     * @return \Drupal\Core\Cache\CacheableMetadata
     *   A cacheable metadata object.
     */
    public function getCacheableMetadata(AccountInterface $account) : CacheableMetadata;

}

Interfaces

Title Deprecated Summary
PermissionsHashGeneratorInterface Defines the user permissions hash generator interface.

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