interface CalculatedGroupPermissionsInterface in Group 2.0.x

Defines the calculated group permissions interface.

Hierarchy

• interface \Drupal\Core\Cache\CacheableDependencyInterface
  • interface \Drupal\group\Access\CalculatedGroupPermissionsInterface

3 files declare their use of CalculatedGroupPermissionsInterface

CalculatedGroupPermissionsTest.php in tests/src/Unit/CalculatedGroupPermissionsTest.php

ChainGroupPermissionCalculatorTest.php in tests/src/Kernel/ChainGroupPermissionCalculatorTest.php

GroupPermissionHashGeneratorTest.php in tests/src/Unit/GroupPermissionHashGeneratorTest.php

File

src/Access/CalculatedGroupPermissionsInterface.php, line 10

Namespace

Drupal\group\Access

interface CalculatedGroupPermissionsInterface extends CacheableDependencyInterface {

  /**
   * Retrieves a single calculated permission item from a given scope.
   *
   * @param $scope
   *   The scope name to retrieve the item for.
   * @param $identifier
   *   The scope identifier to retrieve the item for.
   *
   * @return \Drupal\group\Access\CalculatedGroupPermissionsItemInterface|false
   *   The calculated permission item or FALSE if it could not be found.
   */
  public function getItem($scope, $identifier);

  /**
   * Retrieves all of the calculated permission items, regardless of scope.
   *
   * @return \Drupal\group\Access\CalculatedGroupPermissionsItemInterface[]
   *   A list of calculated permission items.
   */
  public function getItems();

  /**
   * Retrieves all of the calculated permission items for the given scope.
   *
   * @param string $scope
   *   The scope name to retrieve the items for.
   *
   * @return \Drupal\group\Access\CalculatedGroupPermissionsItemInterface[]
   *   A list of calculated permission items for the given scope.
   */
  public function getItemsByScope($scope);

}

Members

Name	Modifiers	Type	Description	Overrides
CacheableDependencyInterface::getCacheContexts	public	function	The cache contexts associated with this object.	34
CacheableDependencyInterface::getCacheMaxAge	public	function	The maximum age for which this object may be cached.	34
CacheableDependencyInterface::getCacheTags	public	function	The cache tags associated with this object.	27
CalculatedGroupPermissionsInterface::getItem	public	function	Retrieves a single calculated permission item from a given scope.
CalculatedGroupPermissionsInterface::getItems	public	function	Retrieves all of the calculated permission items, regardless of scope.
CalculatedGroupPermissionsInterface::getItemsByScope	public	function	Retrieves all of the calculated permission items for the given scope.