class UserGroupAccessResolver in Organic groups 8

Checks that the current user has access to the resolved groups.

This plugin loops over all groups that were found by previous plugins and removes the ones that are not accessible by the current user. It is recommended to place this plugin at the end of the list of plugins.

Plugin annotation


@OgGroupResolver(
  id = "user_access",
  label = "Current user has access to group",
  description = @Translation("Filters the resolved groups, keeping the ones the current user has access to.")
)

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\Plugin\OgGroupResolver\UserGroupAccessResolver

Expanded class hierarchy of UserGroupAccessResolver

1 file declares its use of UserGroupAccessResolver

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

File

src/Plugin/OgGroupResolver/UserGroupAccessResolver.php, line 23

Namespace

Drupal\og\Plugin\OgGroupResolver

View source

class UserGroupAccessResolver extends OgGroupResolverBase {

  /**
   * {@inheritdoc}
   */
  public function resolve(OgResolvedGroupCollectionInterface $collection) {
    foreach ($collection
      ->getGroupInfo() as $group_info) {

      /** @var \Drupal\Core\Entity\ContentEntityInterface $group */
      $group = $group_info['entity'];

      // If the current user has access, cast a vote along with the 'user'
      // cache context, since the current user affects the outcome of the final
      // result.
      if ($group
        ->access('view')) {
        $collection
          ->addGroup($group, [
          'user',
        ]);
      }
      else {

        // The user doesn't have access. Remove the group from the collection.
        $collection
          ->removeGroup($group);
      }
    }
  }

}

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
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.
PluginBase::__construct	public	function	Constructs a \Drupal\Component\Plugin\PluginBase object.	92
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.
UserGroupAccessResolver::resolve	public	function	Resolves groups within the plugin's domain. Overrides OgGroupResolverInterface::resolve

You are here