class RequestQueryArgumentResolver in Organic groups 8

Resolves the group from the query arguments on the request.

This plugin inspects the current request and checks if there are query arguments available that point to a group entity.

Plugin annotation


@OgGroupResolver(
  id = "request_query_argument",
  label = "Group entity from query arguments",
  description = @Translation("Checks if the current request has query arguments that indicate the group context.")
)

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\RequestQueryArgumentResolver implements ContainerFactoryPluginInterface

Expanded class hierarchy of RequestQueryArgumentResolver

1 file declares its use of RequestQueryArgumentResolver

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

File

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

Namespace

Drupal\og\Plugin\OgGroupResolver

View source

class RequestQueryArgumentResolver extends OgGroupResolverBase implements ContainerFactoryPluginInterface {

  /**
   * The query argument that holds the group entity type.
   */
  const GROUP_TYPE_ARGUMENT = 'og-type';

  /**
   * The query argument that holds the group entity ID.
   */
  const GROUP_ID_ARGUMENT = 'og-id';

  /**
   * The request stack.
   *
   * @var \Symfony\Component\HttpFoundation\RequestStack
   */
  protected $requestStack;

  /**
   * The group type manager.
   *
   * @var \Drupal\og\GroupTypeManagerInterface
   */
  protected $groupTypeManager;

  /**
   * The entity type manager.
   *
   * @var \Drupal\Core\Entity\EntityTypeManagerInterface
   */
  protected $entityTypeManager;

  /**
   * Constructs a RequestQueryArgumentResolver.
   *
   * @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 \Symfony\Component\HttpFoundation\RequestStack $request_stack
   *   The request stack.
   * @param \Drupal\og\GroupTypeManagerInterface $group_type_manager
   *   The group type manager.
   * @param \Drupal\Core\Entity\EntityTypeManagerInterface $entity_type_manager
   *   The entity type manager.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, RequestStack $request_stack, GroupTypeManagerInterface $group_type_manager, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->requestStack = $request_stack;
    $this->groupTypeManager = $group_type_manager;
    $this->entityTypeManager = $entity_type_manager;
  }

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

  /**
   * {@inheritdoc}
   */
  public function resolve(OgResolvedGroupCollectionInterface $collection) {

    // Check if our arguments are present on the request.
    $query = $this->requestStack
      ->getCurrentRequest()->query;
    if ($query
      ->has(self::GROUP_TYPE_ARGUMENT) && $query
      ->has(self::GROUP_ID_ARGUMENT)) {
      try {
        $storage = $this->entityTypeManager
          ->getStorage($query
          ->get(self::GROUP_TYPE_ARGUMENT));
      } catch (InvalidPluginDefinitionException $e) {

        // Invalid entity type specified, cannot resolve group.
        return;
      }

      // Load the entity and check if it is a group.

      /** @var \Drupal\Core\Entity\ContentEntityInterface $entity */
      if ($entity = $storage
        ->load($query
        ->get(self::GROUP_ID_ARGUMENT))) {
        if ($this->groupTypeManager
          ->isGroup($entity
          ->getEntityTypeId(), $entity
          ->bundle())) {

          // Only add a vote for the group if it already has been discovered by
          // a previous plugin. This will make sure that users cannot fake a
          // group context by messing with the query arguments.
          if ($collection
            ->hasGroup($entity)) {
            $collection
              ->addGroup($entity, [
              'url',
            ]);
          }
        }
      }
    }
  }

}

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.
RequestQueryArgumentResolver::$entityTypeManager	protected	property	The entity type manager.
RequestQueryArgumentResolver::$groupTypeManager	protected	property	The group type manager.
RequestQueryArgumentResolver::$requestStack	protected	property	The request stack.
RequestQueryArgumentResolver::create	public static	function	Creates an instance of the plugin. Overrides ContainerFactoryPluginInterface::create
RequestQueryArgumentResolver::GROUP_ID_ARGUMENT		constant	The query argument that holds the group entity ID.
RequestQueryArgumentResolver::GROUP_TYPE_ARGUMENT		constant	The query argument that holds the group entity type.
RequestQueryArgumentResolver::resolve	public	function	Resolves groups within the plugin's domain. Overrides OgGroupResolverInterface::resolve
RequestQueryArgumentResolver::__construct	public	function	Constructs a RequestQueryArgumentResolver. Overrides PluginBase::__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.

You are here