Clarify how to work with all membership states.

Fixes #335 and #336.
Gizra · Dec 11, 2018 · ac0e39d · ac0e39d
1 parent 07df1f5
commit ac0e39d
Show file tree

Hide file tree

Showing 7 changed files with 29 additions and 31 deletions.
diff --git a/og.module b/og.module
@@ -53,11 +53,7 @@ function og_entity_insert(EntityInterface $entity) {
 
   // Other modules that implement hook_entity_insert() might already have
   // created a membership ahead of us.
-  if (!Og::getMembership($entity, $entity->getOwner(), [
-    OgMembershipInterface::STATE_ACTIVE,
-    OgMembershipInterface::STATE_PENDING,
-    OgMembershipInterface::STATE_BLOCKED,
-  ])) {
+  if (!Og::getMembership($entity, $entity->getOwner(), OgMembershipInterface::STATES)) {
     $membership = Og::createMembership($entity, $entity->getOwner());
     $membership->save();
   }

diff --git a/src/Cache/Context/OgMembershipStateCacheContext.php b/src/Cache/Context/OgMembershipStateCacheContext.php
@@ -76,14 +76,8 @@ public function getContext() {
       return self::NO_CONTEXT;
     }
 
-    $states = [
-      OgMembershipInterface::STATE_ACTIVE,
-      OgMembershipInterface::STATE_PENDING,
-      OgMembershipInterface::STATE_BLOCKED,
-    ];
-
     /** @var \Drupal\og\OgMembershipInterface $membership */
-    $membership = $this->membershipManager->getMembership($group, $this->user, $states);
+    $membership = $this->membershipManager->getMembership($group, $this->user, OgMembershipInterface::STATES);
     return $membership ? $membership->getState() : self::NO_CONTEXT;
   }
 

diff --git a/src/Controller/SubscriptionController.php b/src/Controller/SubscriptionController.php
@@ -157,13 +157,7 @@ public function subscribe($entity_type_id, EntityInterface $group, OgMembershipT
   public function unsubscribe(ContentEntityInterface $group) {
     $user = $this->currentUser();
 
-    $states = [
-      OgMembershipInterface::STATE_ACTIVE,
-      OgMembershipInterface::STATE_PENDING,
-      OgMembershipInterface::STATE_BLOCKED,
-    ];
-
-    if (!$membership = Og::getMembership($group, $user, $states)) {
+    if (!$membership = Og::getMembership($group, $user, OgMembershipInterface::STATES)) {
       // User is not a member.
       throw new AccessDeniedHttpException();
     }

diff --git a/src/MembershipManager.php b/src/MembershipManager.php
@@ -81,6 +81,10 @@ public function getUserGroups(AccountInterface $user, array $states = [OgMembers
    * {@inheritdoc}
    */
   public function getMemberships(AccountInterface $user, array $states = [OgMembershipInterface::STATE_ACTIVE]) {
+    // When an empty array is passed, retrieve memberships with all possible
+    // states.
+    $states = $states ?: OgMembership::STATES;
+
     // Get a string identifier of the states, so we can retrieve it from cache.
     sort($states);
     $states_identifier = implode('|', array_unique($states));
@@ -101,11 +105,8 @@ public function getMemberships(AccountInterface $user, array $states = [OgMember
     $query = $this->entityTypeManager
       ->getStorage('og_membership')
       ->getQuery()
-      ->condition('uid', $user->id());
-
-    if ($states) {
-      $query->condition('state', $states, 'IN');
-    }
+      ->condition('uid', $user->id())
+      ->condition('state', $states, 'IN');
 
     $results = $query->execute();
 

diff --git a/src/MembershipManagerInterface.php b/src/MembershipManagerInterface.php
@@ -61,8 +61,10 @@ public function getUserGroups(AccountInterface $user, array $states = [OgMembers
    * @param \Drupal\Core\Session\AccountInterface $user
    *   The user to get groups for.
    * @param array $states
-   *   (optional) Array with the state to return. Defaults to active.
-   *
+   *   (optional) Array with the states to return. Defaults to only returning
+   *   active memberships. In order to retrieve all memberships regardless of
+   *   state, pass `OgMembershipInterface::STATES`.
+    *
    * @return \Drupal\og\OgMembershipInterface[]
    *   An array of OgMembership entities, keyed by ID.
    */
@@ -76,7 +78,9 @@ public function getMemberships(AccountInterface $user, array $states = [OgMember
    * @param \Drupal\Core\Session\AccountInterface $user
    *   The user to get the membership for.
    * @param array $states
-   *   (optional) Array with the state to return. Defaults to active.
+   *   (optional) Array with the states to return. Defaults to only returning
+   *   active memberships. In order to retrieve all memberships regardless of
+   *   state, pass `OgMembershipInterface::STATES`.
    *
    * @return \Drupal\og\OgMembershipInterface|null
    *   The OgMembership entity. NULL will be returned if no membership is

diff --git a/src/Og.php b/src/Og.php
@@ -133,9 +133,11 @@ public static function createField($plugin_id, $entity_type, $bundle, array $set
    * @param \Drupal\Core\Session\AccountInterface $user
    *   The user to get groups for.
    * @param array $states
-   *   (optional) Array with the state to return. Defaults to active.
+   *   (optional) Array with the states to return. Defaults to only returning
+   *   active memberships. In order to retrieve all memberships regardless of
+   *   state, pass `OgMembershipInterface::STATES`.
    *
-   * @return \Drupal\og\Entity\OgMembership[]
+   * @return \Drupal\og\OgMembershipInterface[]
    *   An array of OgMembership entities, keyed by ID.
    */
   public static function getMemberships(AccountInterface $user, array $states = [OgMembershipInterface::STATE_ACTIVE]) {
@@ -152,9 +154,11 @@ public static function getMemberships(AccountInterface $user, array $states = [O
    * @param \Drupal\Core\Session\AccountInterface $user
    *   The user to get the membership for.
    * @param array $states
-   *   (optional) Array with the state to return. Defaults to active.
+   *   (optional) Array with the states to return. Defaults to only returning
+   *   active memberships. In order to retrieve all memberships regardless of
+   *   state, pass `OgMembershipInterface::STATES`.
    *
-   * @return \Drupal\og\Entity\OgMembership|null
+   * @return \Drupal\og\OgMembershipInterface|null
    *   The OgMembership entity. NULL will be returned if no membership is
    *   available that matches the passed in $states.
    */

diff --git a/src/OgMembershipInterface.php b/src/OgMembershipInterface.php
@@ -38,6 +38,11 @@ interface OgMembershipInterface extends ContentEntityInterface, EntityOwnerInter
    */
   const STATE_BLOCKED = 'blocked';
 
+  /**
+   * An array containing all possible group membership states.
+   */
+  const STATES = [self::STATE_ACTIVE, self::STATE_PENDING, self::STATE_BLOCKED];
+
   /**
    * The default group membership type that is the bundle of group membership.
    */