You are here

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

abstract class OgGroupResolverBase in Organic groups 8

Base class for OgGroupResolver plugins.

Hierarchy

Expanded class hierarchy of OgGroupResolverBase

2 files declare their use of OgGroupResolverBase
RequestQueryArgumentResolver.php in src/Plugin/OgGroupResolver/RequestQueryArgumentResolver.php
UserGroupAccessResolver.php in src/Plugin/OgGroupResolver/UserGroupAccessResolver.php

File

src/OgGroupResolverBase.php, line 12

Namespace

Drupal\og
View source 
abstract class OgGroupResolverBase extends PluginBase implements OgGroupResolverInterface {

  /**
   * Whether the group resolving process can be stopped.
   *
   * @var bool
   */
  protected $propagationStopped = FALSE;

  /**
   * {@inheritdoc}
   */
  public function stopPropagation() {
    $this->propagationStopped = TRUE;
  }

  /**
   * {@inheritdoc}
   */
  public function isPropagationStopped() {
    return $this->propagationStopped;
  }

}

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
OgGroupResolverInterface::resolve public function Resolves groups within the plugin's domain. 4
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.