Add a group formatter for easier subscribe/ unsubscribe

og.module

@@ -9,6 +9,8 @@ use Drupal\user\UserInterface;
 use Drupal\Core\Access\AccessResult;
 use Drupal\Core\Entity\ContentEntityInterface;
 use Drupal\Core\Entity\EntityInterface;
+use Drupal\Core\Entity\EntityTypeInterface;
+use Drupal\Core\Field\BaseFieldDefinition;
 use Drupal\Core\Field\FieldDefinitionInterface;
 use Drupal\Core\Field\FieldItemListInterface;
 use Drupal\Core\Session\AccountInterface;
@@ -169,6 +171,47 @@ function og_entity_create_access(AccountInterface $account, array $context, $bun
   return $required ? AccessResult::forbiddenIf($node_access_strict) : AccessResult::neutral();
 }
 
+/**
+ *
+ * Implements hook_entity_bundle_field_info().
+ *
+ * Add a read only property to group entities as a group flag.
+ */
+function og_entity_bundle_field_info(EntityTypeInterface $entity_type, $bundle, array $base_field_definitions) {
+  if (!Og::isGroup($entity_type->id(), $bundle)) {
+    // Not a group type.
+    return NULL;
+  }
+
+  $fields = [];
+  $fields['og_group'] = BaseFieldDefinition::create('og_group')
+    ->setLabel(t('OG Group'))
+    ->setComputed(TRUE)
+    ->setTranslatable(FALSE)
+    ->setDefaultValue(TRUE)
+    ->setReadOnly(TRUE);
+
+  return $fields;
+}
+
+/**
+ * Implements hook_entity_bundle_field_info_alter().
+ *
+ * Set the default field formatter of fields of type OG group.
+ */
+function og_entity_bundle_field_info_alter(&$fields, EntityTypeInterface $entity_type, $bundle) {
+  if (!isset($fields['og_group'])) {
+    // No OG group fields.
+    return;
+  }
+
+  $fields['og_group']->setDisplayOptions('view', [
+    'weight' => 0,
+    'type' => 'og_group_subscribe',
+  ])->setDisplayConfigurable('view', TRUE);
+}
+
+
 /**
  * Implements hook_field_formatter_info_alter().
  *

og.routing.yml

@@ -1,7 +1,7 @@
 # Routes for Organic groups.
 
 og.subscribe:
-  path: 'group/{entity_type_id}/{entity_id}/subscribe/{membership_type}'
+  path: 'group/{entity_type_id}/{group}/subscribe/{membership_type}'
   defaults:
     _controller: '\Drupal\og\Controller\SubscriptionController::subscribe'
     _title: 'Join Group'
@@ -13,16 +13,19 @@ og.subscribe:
     _access: 'TRUE'
   options:
     parameters:
+      group:
+        type: entity:{entity_type_id}
       membership_type:
         type: entity:og_membership_type
 
-
-
 og.unsubscribe:
-  path: 'group/{entity_type_id}/{entity_id}/unsubscribe'
+  path: 'group/{entity_type_id}/{group}/unsubscribe'
   defaults:
     _controller: '\Drupal\og\Controller\SubscriptionController::unsubscribe'
     _title: 'Leave Group'
   requirements:
     _user_is_logged_in: 'TRUE'
-    _og_user_access_group: 'unsubscribe'
+  options:
+    parameters:
+      group:
+        type: entity:{entity_type_id}

og_ui/og_ui.module

@@ -8,6 +8,7 @@
 use Drupal\Core\Config\Entity\ConfigEntityBundleBase;
 use Drupal\Core\Entity\BundleEntityFormBase;
 use Drupal\Core\Entity\EntityInterface;
+use Drupal\Core\Entity\EntityTypeInterface;
 use Drupal\Core\Form\FormStateInterface;
 use Drupal\field\Entity\FieldConfig;
 use Drupal\field\Entity\FieldStorageConfig;

src/Controller/SubscriptionController.php

@@ -2,15 +2,15 @@
 
 namespace Drupal\og\Controller;
 
-use Drupal\Component\Plugin\Exception\PluginNotFoundException;
 use Drupal\Core\Controller\ControllerBase;
+use Drupal\Core\Entity\ContentEntityInterface;
+use Drupal\Core\Entity\EntityInterface;
 use Drupal\Core\Url;
 use Drupal\og\OgMembershipTypeInterface;
 use Drupal\user\Entity\User;
 use Drupal\user\EntityOwnerInterface;
 use Symfony\Component\DependencyInjection\ContainerInterface;
 use Symfony\Component\HttpFoundation\RedirectResponse;
-use Symfony\Component\HttpFoundation\Request;
 use Symfony\Component\HttpKernel\Exception\AccessDeniedHttpException;
 use Drupal\og\Og;
 use Drupal\og\OgAccess;
@@ -47,11 +47,9 @@ public static function create(ContainerInterface $container) {
   /**
    * Subscribe a user to group.
    *
-   * @param \Symfony\Component\HttpFoundation\Request $request
-   *   The request object.
    * @param string $entity_type_id
    *   The entity type of the group entity.
-   * @param string|int $entity_id
+   * @param \Drupal\Core\Entity\EntityInterface $group
    *   The entity ID of the group entity.
    * @param \Drupal\og\OgMembershipTypeInterface $membership_type
    *   The membership type to be used for creating the membership.
@@ -60,16 +58,8 @@ public static function create(ContainerInterface $container) {
    *   Redirect user or show access denied if they are not allowed to subscribe,
    *   otherwise provide a subscribe confirmation form.
    */
-  public function subscribe(Request $request, $entity_type_id, $entity_id, OgMembershipTypeInterface $membership_type) {
-    try {
-      $entity_storage = $this->entityTypeManager()->getStorage($entity_type_id);
-    }
-    catch (PluginNotFoundException $e) {
-      // Not a valid entity type.
-      throw new AccessDeniedHttpException();
-    }
-
-    if (!$group = $entity_storage->load($entity_id)) {
+  public function subscribe($entity_type_id, EntityInterface $group, OgMembershipTypeInterface $membership_type) {
+    if (!$group instanceof ContentEntityInterface) {
       // Not a valid entity.
       throw new AccessDeniedHttpException();
     }
@@ -142,19 +132,14 @@ public function subscribe(Request $request, $entity_type_id, $entity_id, OgMembe
   /**
    * Unsubscribe a user from group.
    *
-   * @param string $entity_type_id
-   *   The entity type of the group entity.
-   * @param string|int $entity_id
+   * @param \Drupal\core\Entity\EntityInterface $group
    *   The entity ID of the group entity.
    *
    * @return mixed
    *   Redirect user or show access denied if they are not allowed to subscribe,
    *   otherwise provide an un-subscribe confirmation form.
    */
-  public function unsubscribe($entity_type_id, $entity_id) {
-    $entity_storage = $this->entityTypeManager()->getStorage($entity_type_id);
-    $group = $entity_storage->load($entity_id);
-
+  public function unsubscribe(EntityInterface $group) {
     $user = $this->currentUser();
 
     if (!$membership = Og::getMembership($group, $user)) {

src/EventSubscriber/OgEventSubscriber.php

@@ -110,13 +110,6 @@ public function provideDefaultOgPermissions(PermissionEventInterface $event) {
         'roles' => [OgRoleInterface::ANONYMOUS],
         'default roles' => [],
       ]),
-      new GroupPermission([
-        'name' => 'unsubscribe',
-        'title' => t('Unsubscribe from group'),
-        'description' => t('Allow members to unsubscribe themselves from a group, removing their membership.'),
-        'roles' => [OgRoleInterface::AUTHENTICATED],
-        'default roles' => [OgRoleInterface::AUTHENTICATED],
-      ]),
       new GroupPermission([
         'name' => 'approve and deny subscription',
         'title' => t('Approve and deny subscription'),

src/GroupTypeManager.php

@@ -123,7 +123,7 @@ class GroupTypeManager {
   protected $ogRoleManager;
 
   /**
-   * Constructs an GroupManager object.
+   * Constructs a GroupTypeManager object.
    *
    * @param \Drupal\Core\Config\ConfigFactoryInterface $config_factory
    *   The config factory.

src/Og.php

@@ -196,8 +196,7 @@ public static function createMembership(EntityInterface $group, AccountInterface
    *   Defaults to active memberships.
    *
    * @return bool
-   *   TRUE if the entity (e.g. the user or node) belongs to a group with
-   *   a certain state.
+   *   TRUE if the user belongs to a group with a certain state.
    */
   public static function isMember(EntityInterface $group, AccountInterface $user, $states = [OgMembershipInterface::STATE_ACTIVE]) {
     /** @var \Drupal\og\MembershipManagerInterface $membership_manager */

src/OgAccess.php

@@ -67,8 +67,6 @@ class OgAccess implements OgAccessInterface {
    * The group manager.
    *
    * @var \Drupal\og\GroupTypeManager
-   *
-   * @todo This should be GroupManagerInterface.
    */
   protected $groupTypeManager;
 

src/OgGroupAlwaysTrue.php

@@ -0,0 +1,26 @@
+<?php
+
+namespace Drupal\og;
+
+use Drupal\Core\TypedData\Plugin\DataType\BooleanData;
+
+/**
+ * Overridden boolean data type to hardcode TRUE.
+ */
+class OgGroupAlwaysTrue extends BooleanData {
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getValue() {
+    return TRUE;
+  }
+
+  /**
+   * {@inheritdoc}
+   */
+  public function getCastedValue() {
+    return $this->getValue();
+  }
+
+}

src/OgRoleManager.php

@@ -34,7 +34,7 @@ class OgRoleManager implements OgRoleManagerInterface {
   protected $permissionManager;
 
   /**
-   * Constructs an GroupManager object.
+   * Constructs an OgRoleManager object.
    *
    * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
    *   The entity type manager.