Groups and roles by permissions

src/MembershipManager.php

@@ -76,13 +76,8 @@ public function getUserGroupIds(AccountInterface $user, array $states = [OgMembe
    * {@inheritdoc}
    */
   public function getUserGroups(AccountInterface $user, array $states = [OgMembershipInterface::STATE_ACTIVE]) {
-    $groups = [];
-
-    foreach ($this->getUserGroupIds($user, $states) as $entity_type => $entity_ids) {
-      $groups[$entity_type] = $this->entityTypeManager->getStorage($entity_type)->loadMultiple($entity_ids);
-    }
-
-    return $groups;
+    $group_ids = $this->getUserGroupIds($user, $states);
+    return $this->loadGroups($group_ids);
   }
 
   /**
@@ -129,6 +124,36 @@ public function getMembership(EntityInterface $group, AccountInterface $user, ar
     return NULL;
   }
 
+  /**
+   * {@inheritdoc}
+   */
+  public function getUserGroupIdsByRoles(AccountInterface $user, array $roles, array $states = [OgMembershipInterface::STATE_ACTIVE], bool $require_all_roles = TRUE): array {
+    $role_ids = array_map(function (OgRoleInterface $role): string {
+      return $role->id();
+    }, $roles);
+
+    /** @var \Drupal\og\OgMembershipInterface[] $memberships */
+    $memberships = $this->getMemberships($user, $states);
+    $memberships = array_filter($memberships, function (OgMembershipInterface $membership) use ($role_ids, $require_all_roles): bool {
+      $membership_roles_ids = $membership->getRolesIds();
+      return $require_all_roles ? empty(array_diff($role_ids, $membership_roles_ids)) : !empty(array_intersect($membership_roles_ids, $role_ids));
+    });
+
+    $group_ids = [];
+    foreach ($memberships as $membership) {
+      $group_ids[$membership->getGroupEntityType()][] = $membership->getGroupId();
+    }
+    return $group_ids;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getUserGroupsByRoles(AccountInterface $user, array $roles, array $states = [OgMembershipInterface::STATE_ACTIVE], bool $require_all_roles = TRUE): array {
+    $group_ids = $this->getUserGroupIdsByRoles($user, $roles, $states, $require_all_roles);
+    return $this->loadGroups($group_ids);
+  }
+
   /**
    * {@inheritdoc}
    */
@@ -299,13 +324,8 @@ public function getGroupIds(EntityInterface $entity, $group_type_id = NULL, $gro
    * {@inheritdoc}
    */
   public function getGroups(EntityInterface $entity, $group_type_id = NULL, $group_bundle = NULL) {
-    $groups = [];
-
-    foreach ($this->getGroupIds($entity, $group_type_id, $group_bundle) as $entity_type => $entity_ids) {
-      $groups[$entity_type] = $this->entityTypeManager->getStorage($entity_type)->loadMultiple($entity_ids);
-    }
-
-    return $groups;
+    $group_ids = $this->getGroupIds($entity, $group_type_id, $group_bundle);
+    return $this->loadGroups($group_ids);
   }
 
   /**
@@ -413,6 +433,30 @@ protected function prepareConditionArray(array $value, array $default = NULL) {
     return array_unique($value);
   }
 
+  /**
+   * Loads the entities of an associative array of entity IDs.
+   *
+   * @param array[] $group_ids
+   *   An associative array of entity IDs indexed by their entity type ID.
+   *
+   * @return \Drupal\Core\Entity\ContentEntityInterface[][]
+   *   An associative array of entities indexed by their entity type ID.
+   *
+   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
+   *   Thrown when the entity type definition of one or more of the passed in
+   *   entity types is invalid.
+   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
+   *   Thrown when one or more of the passed in entity types is not defined.
+   */
+  protected function loadGroups(array $group_ids): array {
+    $groups = [];
+    foreach ($group_ids as $entity_type => $ids) {
+      $groups[$entity_type] = $this->entityTypeManager->getStorage($entity_type)->loadMultiple($ids);
+    }
+
+    return $groups;
+  }
+
   /**
    * Stores the given list of membership IDs in the static cache backend.
    *
@@ -435,8 +479,14 @@ protected function cacheMembershipIds($cid, array $membership_ids) {
    * @param array $ids
    *   The IDs of the memberships to load.
    *
-   * @return \Drupal\Core\Entity\EntityInterface[]
+   * @return \Drupal\og\OgMembershipInterface[]
    *   The membership entities.
+   *
+   * @throws \Drupal\Component\Plugin\Exception\InvalidPluginDefinitionException
+   *   Thrown when the entity type definition of one or more of the passed in
+   *   entity types is invalid.
+   * @throws \Drupal\Component\Plugin\Exception\PluginNotFoundException
+   *   Thrown when one or more of the passed in entity types is not defined.
    */
   protected function loadMemberships(array $ids) {
     if (empty($ids)) {

src/MembershipManagerInterface.php

@@ -43,10 +43,10 @@ public function getUserGroupIds(AccountInterface $user, array $states = [OgMembe
    *
    * @param \Drupal\Core\Session\AccountInterface $user
    *   The user to get groups for.
-   * @param array $states
+   * @param string[] $states
    *   (optional) Array with the states to return. Defaults to active.
    *
-   * @return \Drupal\Core\Entity\EntityInterface[][]
+   * @return \Drupal\Core\Entity\ContentEntityInterface[][]
    *   An associative array, keyed by group entity type, each item an array of
    *   group entities.
    *
@@ -55,6 +55,46 @@ public function getUserGroupIds(AccountInterface $user, array $states = [OgMembe
    */
   public function getUserGroups(AccountInterface $user, array $states = [OgMembershipInterface::STATE_ACTIVE]);
 
+  /**
+   * Returns an array of groups filtered by the OG roles of the user.
+   *
+   * @param \Drupal\Core\Session\AccountInterface $user
+   *   The user to get the groups for.
+   * @param \Drupal\og\OgRoleInterface[] $roles
+   *   A list of og role objects to filter by.
+   * @param string[] $states
+   *   (optional) An array of states to filter the memberships by.
+   * @param bool $require_all_roles
+   *   (optional) If set to TRUE, all requested roles must be present to return
+   *   the group. Set to FALSE to return the groups that match one or more of
+   *   the requested roles. Defaults to TRUE.
+   *
+   * @return \Drupal\Core\Entity\ContentEntityInterface[][]
+   *   An associative array, keyed by group entity type, each item an array of
+   *   group entities.
+   */
+  public function getUserGroupsByRoles(AccountInterface $user, array $roles, array $states = [OgMembershipInterface::STATE_ACTIVE], bool $require_all_roles = TRUE): array;
+
+  /**
+   * Returns an array of groups ids filtered by the og roles of the user.
+   *
+   * @param \Drupal\Core\Session\AccountInterface $user
+   *   The user to get the groups for.
+   * @param \Drupal\og\OgRoleInterface[] $roles
+   *   A list of og role objects to filter by.
+   * @param string[] $states
+   *   (optional) An array of states to filter the memberships by.
+   * @param bool $require_all_roles
+   *   (optional) If set to TRUE, all requested roles must be present to return
+   *   the group. Set to FALSE to return the groups that match one or more of
+   *   the requested roles. Defaults to TRUE.
+   *
+   * @return array[]
+   *   An associative array, keyed by group entity type, each item an array of
+   *   group IDs.
+   */
+  public function getUserGroupIdsByRoles(AccountInterface $user, array $roles, array $states = [OgMembershipInterface::STATE_ACTIVE], bool $require_all_roles = TRUE): array;
+
   /**
    * Returns the group memberships a user is associated with.
    *

src/OgRoleManager.php

@@ -132,6 +132,35 @@ public function getRolesByBundle($entity_type_id, $bundle) {
     return $this->ogRoleStorage()->loadByProperties($properties);
   }
 
+  /**
+   * {@inheritdoc}
+   */
+  public function getRolesByPermissions(array $permissions, $entity_type_id = NULL, $bundle = NULL, $require_all = TRUE): array {
+    $role_storage = $this->ogRoleStorage();
+    $query = $role_storage->getQuery();
+    if ($require_all) {
+      // If all permissions are requested, we need to add an AND condition for
+      // each permission because there is not an easy way to explicitly request
+      // a subset of an array.
+      foreach ($permissions as $permission) {
+        $query->condition('permissions.*', $permission);
+      }
+    }
+    else {
+      $query->condition('permissions.*', $permissions, 'IN');
+    }
+
+    if (!empty($entity_type_id)) {
+      $query->condition('group_type', $entity_type_id);
+    }
+    if (!empty($bundle)) {
+      $query->condition('group_bundle', $bundle);
+    }
+
+    $role_ids = $query->execute();
+    return $role_storage->loadMultiple($role_ids);
+  }
+
   /**
    * {@inheritdoc}
    */

src/OgRoleManagerInterface.php

@@ -49,15 +49,36 @@ public function getRequiredDefaultRoles();
    * Returns all the roles of a provided group.
    *
    * @param string $entity_type_id
-   *   The entity type id of the group.
+   *   The entity type ID of the group.
    * @param string $bundle
    *   The bundle of the group.
    *
    * @return \Drupal\og\OgRoleInterface[]
-   *   An array of roles indexed by their ids.
+   *   An array of roles indexed by their IDs.
    */
   public function getRolesByBundle($entity_type_id, $bundle);
 
+  /**
+   * Returns all the roles that have a specific permission.
+   *
+   * Optionally filter the roles by entity type ID and bundle.
+   *
+   * @param array $permissions
+   *   An array of permissions that the roles must have.
+   * @param string $entity_type_id
+   *   (optional) The entity type ID of the group.
+   * @param string $bundle
+   *   (optional) The bundle of the group.
+   * @param bool $require_all
+   *   (optional) Whether all given permissions are required. When set to FALSE
+   *   all roles that include one or more of the given permissions will be
+   *   returned. Defaults to TRUE.
+   *
+   * @return \Drupal\og\OgRoleInterface[]
+   *   An array of roles indexed by their IDs.
+   */
+  public function getRolesByPermissions(array $permissions, $entity_type_id = NULL, $bundle = NULL, $require_all = TRUE): array;
+
   /**
    * Deletes the roles associated with a group type.
    *