class RouteGroupResolver 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",
  label = "Group entity from current route",
  description = @Translation("Checks if the current route is an entity path that belongs to a group entity.")
)

Hierarchy

• class \Drupal\Component\Plugin\PluginBase implements DerivativeInspectionInterface, PluginInspectionInterface
  • class \Drupal\Core\Plugin\PluginBase uses DependencySerializationTrait, MessengerTrait, StringTranslationTrait
    • class \Drupal\og\OgGroupResolverBase implements OgGroupResolverInterface
      • class \Drupal\og\OgRouteGroupResolverBase implements ContainerFactoryPluginInterface
        • class \Drupal\og\Plugin\OgGroupResolver\RouteGroupResolver

1 file declares its use of RouteGroupResolver

RouteGroupResolverTest.php in tests/src/Unit/Plugin/OgGroupResolver/RouteGroupResolverTest.php

File

src/Plugin/OgGroupResolver/RouteGroupResolver.php, line 22

Namespace

Drupal\og\Plugin\OgGroupResolver

class RouteGroupResolver extends OgRouteGroupResolverBase {

  /**
   * {@inheritdoc}
   */
  public function resolve(OgResolvedGroupCollectionInterface $collection) {
    $entity = $this
      ->getContentEntity();
    if ($entity && $this->groupTypeManager
      ->isGroup($entity
      ->getEntityTypeId(), $entity
      ->bundle())) {
      $collection
        ->addGroup($entity, [
        'route',
      ]);

      // We are on a route that matches an entity path for a group entity. We
      // can conclude with 100% certainty that this group is relevant for the
      // current context. There's no need to keep searching.
      $this
        ->stopPropagation();
    }
  }

}

Members

Name	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::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create	1
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.
OgRouteGroupResolverBase::__construct	public	function	Constructor for OgGroupResolver plugins that inspect that route. Overrides PluginBase::__construct	1
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.
RouteGroupResolver::resolve	public	function	Resolves groups within the plugin's domain. Overrides OgGroupResolverInterface::resolve
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.