interface GroupRoleSynchronizerInterface in Group 8

Provides information about how site roles are synchronized to group roles.

Hierarchy

• interface \Drupal\group\GroupRoleSynchronizerInterface

3 files declare their use of GroupRoleSynchronizerInterface

GroupPermissionsOutsiderForm.php in src/Form/GroupPermissionsOutsiderForm.php

GroupRoleStorage.php in src/Entity/Storage/GroupRoleStorage.php

SynchronizedGroupPermissionCalculator.php in src/Access/SynchronizedGroupPermissionCalculator.php

File

src/GroupRoleSynchronizerInterface.php, line 10

Namespace

Drupal\group

interface GroupRoleSynchronizerInterface {

  /**
   * Generates an ID for a synchronized group role.
   *
   * @param $group_type_id
   *   The ID of the group type the group role ID should be generated for.
   * @param $role_id
   *   The ID of the user role the group role ID should be generated for.
   *
   * @return string
   *   The group role ID for the given group type and user role.
   */
  public function getGroupRoleId($group_type_id, $role_id);

  /**
   * Retrieves all synchronized group role IDs for a group type.
   *
   * @param string $group_type_id
   *   The ID of the group type the group role IDs should be retrieved for.
   *
   * @return string[]
   *   The synchronized group role IDs for the given group type.
   */
  public function getGroupRoleIdsByGroupType($group_type_id);

  /**
   * Retrieves all synchronized group role IDs for a list of group types.
   *
   * @param string[] $group_type_ids
   *   The IDs of the group types the group role IDs should be retrieved for.
   *
   * @return string[]
   *   The synchronized group role IDs for the given group type.
   */
  public function getGroupRoleIdsByGroupTypes($group_type_ids);

  /**
   * Retrieves all synchronized group role IDs for a user role.
   *
   * @param string $role_id
   *   The ID of the user role the group role IDs should be retrieved for.
   *
   * @return string[]
   *   The synchronized group role IDs for the given user role.
   */
  public function getGroupRoleIdsByUserRole($role_id);

  /**
   * Retrieves all synchronized group role IDs for a list of user roles.
   *
   * @param string[] $role_ids
   *   The IDs of the user roles the group role IDs should be retrieved for.
   *
   * @return string[]
   *   The synchronized group role IDs for the given user role.
   */
  public function getGroupRoleIdsByUserRoles($role_ids);

}

Members

Name	Modifiers	Type	Description	Overrides
GroupRoleSynchronizerInterface::getGroupRoleId	public	function	Generates an ID for a synchronized group role.	1
GroupRoleSynchronizerInterface::getGroupRoleIdsByGroupType	public	function	Retrieves all synchronized group role IDs for a group type.	1
GroupRoleSynchronizerInterface::getGroupRoleIdsByGroupTypes	public	function	Retrieves all synchronized group role IDs for a list of group types.	1
GroupRoleSynchronizerInterface::getGroupRoleIdsByUserRole	public	function	Retrieves all synchronized group role IDs for a user role.	1
GroupRoleSynchronizerInterface::getGroupRoleIdsByUserRoles	public	function	Retrieves all synchronized group role IDs for a list of user roles.	1