You are here

Home » API reference » Organic groups 8 » RouteGroupContentResolver.php

class RouteGroupContentResolver in Organic groups 8

Resolves the group from the route.

This plugin inspects the current route and checks if it is an entity path for a group entity.

Plugin annotation


@OgGroupResolver(
  id = "route_group_content",
  label = "Groups from the group content entity on the current route",
  description = @Translation("Checks if the current route is an entity path for a group content entity and returns the group(s) that it belongs to.")
)

Hierarchy

Expanded class hierarchy of RouteGroupContentResolver

1 file declares its use of RouteGroupContentResolver
RouteGroupContentResolverTest.php in tests/src/Unit/Plugin/OgGroupResolver/RouteGroupContentResolverTest.php

File

src/Plugin/OgGroupResolver/RouteGroupContentResolver.php, line 28

Namespace

Drupal\og\Plugin\OgGroupResolver
View source 
class RouteGroupContentResolver extends OgRouteGroupResolverBase {

  /**
   * The OG membership manager.
   *
   * @var \Drupal\og\MembershipManagerInterface
   */
  protected $membershipManager;

  /**
   * The OG group audience helper.
   *
   * @var \Drupal\og\OgGroupAudienceHelperInterface
   */
  protected $groupAudienceHelper;

  /**
   * Constructs a RouteGroupContentResolver.
   *
   * @param array $configuration
   *   A configuration array containing information about the plugin instance.
   * @param string $plugin_id
   *   The plugin_id for the plugin instance.
   * @param mixed $plugin_definition
   *   The plugin implementation definition.
   * @param \Drupal\Core\Routing\RouteMatchInterface $route_match
   *   The route match service.
   * @param \Drupal\og\GroupTypeManagerInterface $group_type_manager
   *   The group type manager.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   * @param \Drupal\og\MembershipManagerInterface $membership_manager
   *   The OG membership manager.
   * @param \Drupal\og\OgGroupAudienceHelperInterface $group_audience_helper
   *   The OG group audience helper.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, RouteMatchInterface $route_match, GroupTypeManagerInterface $group_type_manager, EntityTypeManagerInterface $entity_type_manager, MembershipManagerInterface $membership_manager, OgGroupAudienceHelperInterface $group_audience_helper) {
    parent::__construct($configuration, $plugin_id, $plugin_definition, $route_match, $group_type_manager, $entity_type_manager);
    $this->membershipManager = $membership_manager;
    $this->groupAudienceHelper = $group_audience_helper;
  }

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container, array $configuration, $plugin_id, $plugin_definition) {
    return new static($configuration, $plugin_id, $plugin_definition, $container
      ->get('current_route_match'), $container
      ->get('og.group_type_manager'), $container
      ->get('entity_type.manager'), $container
      ->get('og.membership_manager'), $container
      ->get('og.group_audience_helper'));
  }

  /**
   * {@inheritdoc}
   */
  public function resolve(OgResolvedGroupCollectionInterface $collection) {
    $entity = $this
      ->getContentEntity();

    // Check if the route entity is group content by checking if it has a group
    // audience field.
    if ($entity && $this->groupAudienceHelper
      ->hasGroupAudienceField($entity
      ->getEntityTypeId(), $entity
      ->bundle())) {
      $groups = $this->membershipManager
        ->getGroups($entity);

      // The groups are returned as a two-dimensional array. Flatten it.
      $groups = array_reduce($groups, 'array_merge', []);
      foreach ($groups as $group) {
        $collection
          ->addGroup($group, [
          'route',
        ]);
      }
    }
  }

}

Members

Namesort descending Modifiers Type Description Overrides
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function 1
DependencySerializationTrait::__wakeup public function 2
MessengerTrait::$messenger protected property The messenger. 29
MessengerTrait::messenger public function Gets the messenger. 29
MessengerTrait::setMessenger public function Sets the messenger.
OgGroupResolverBase::$propagationStopped protected property Whether the group resolving process can be stopped.
OgGroupResolverBase::isPropagationStopped public function Returns whether the group resolving process can be stopped. Overrides OgGroupResolverInterface::isPropagationStopped
OgGroupResolverBase::stopPropagation public function Declares that no further group resolving is necessary. Overrides OgGroupResolverInterface::stopPropagation
OgRouteGroupResolverBase::$contentEntityPaths protected property A list of all the link paths of enabled content entities.
OgRouteGroupResolverBase::$entityTypeManager protected property The entity type manager.
OgRouteGroupResolverBase::$groupTypeManager protected property The group type manager.
OgRouteGroupResolverBase::$routeMatch protected property The route matching service.
OgRouteGroupResolverBase::getContentEntity protected function Returns the content entity from the current route.
OgRouteGroupResolverBase::getContentEntityPaths protected function Returns the paths for the link templates of all content entities.
PluginBase::$configuration protected property Configuration information passed into the plugin. 1
PluginBase::$pluginDefinition protected property The plugin implementation definition. 1
PluginBase::$pluginId protected property The plugin_id.
PluginBase::DERIVATIVE_SEPARATOR constant A string which is used to separate base plugin IDs from the derivative ID.
PluginBase::getBaseId public function Gets the base_plugin_id of the plugin instance. Overrides DerivativeInspectionInterface::getBaseId
PluginBase::getDerivativeId public function Gets the derivative_id of the plugin instance. Overrides DerivativeInspectionInterface::getDerivativeId
PluginBase::getPluginDefinition public function Gets the definition of the plugin implementation. Overrides PluginInspectionInterface::getPluginDefinition 3
PluginBase::getPluginId public function Gets the plugin_id of the plugin instance. Overrides PluginInspectionInterface::getPluginId
PluginBase::isConfigurable public function Determines if the plugin is configurable.
RouteGroupContentResolver::$groupAudienceHelper protected property The OG group audience helper.
RouteGroupContentResolver::$membershipManager protected property The OG membership manager.
RouteGroupContentResolver::create public static function Creates an instance of the plugin. Overrides OgRouteGroupResolverBase::create
RouteGroupContentResolver::resolve public function Resolves groups within the plugin's domain. Overrides OgGroupResolverInterface::resolve
RouteGroupContentResolver::__construct public function Constructs a RouteGroupContentResolver. Overrides OgRouteGroupResolverBase::__construct
StringTranslationTrait::$stringTranslation protected property The string translation service. 1
StringTranslationTrait::formatPlural protected function Formats a string containing a count of items.
StringTranslationTrait::getNumberOfPlurals protected function Returns the number of plurals supported by a given language.
StringTranslationTrait::getStringTranslation protected function Gets the string translation service.
StringTranslationTrait::setStringTranslation public function Sets the string translation service to use. 2
StringTranslationTrait::t protected function Translates a string to the current language or to a given language.