abstract class OgRouteGroupResolverBase in Organic groups 8

Base class for OgGroupResolver plugins that inspect the route.

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

Expanded class hierarchy of OgRouteGroupResolverBase

2 files declare their use of OgRouteGroupResolverBase

RouteGroupContentResolver.php in src/Plugin/OgGroupResolver/RouteGroupContentResolver.php
RouteGroupResolver.php in src/Plugin/OgGroupResolver/RouteGroupResolver.php

File

src/OgRouteGroupResolverBase.php, line 16

Namespace

Drupal\og

View source

abstract class OgRouteGroupResolverBase extends OgGroupResolverBase implements ContainerFactoryPluginInterface {

  /**
   * The route matching service.
   *
   * @var \Drupal\Core\Routing\RouteMatchInterface
   */
  protected $routeMatch;

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

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

  /**
   * A list of all the link paths of enabled content entities.
   *
   * @var array
   */
  protected $contentEntityPaths;

  /**
   * Constructor for OgGroupResolver plugins that inspect that route.
   *
   * @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.
   */
  public function __construct(array $configuration, $plugin_id, $plugin_definition, RouteMatchInterface $route_match, GroupTypeManagerInterface $group_type_manager, EntityTypeManagerInterface $entity_type_manager) {
    parent::__construct($configuration, $plugin_id, $plugin_definition);
    $this->routeMatch = $route_match;
    $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('current_route_match'), $container
      ->get('og.group_type_manager'), $container
      ->get('entity_type.manager'));
  }

  /**
   * Returns the content entity from the current route.
   *
   * This will return the entity if the current route matches the entity paths
   * ('link templates') that are defined in the entity definition.
   *
   * @return \Drupal\Core\Entity\ContentEntityInterface|null
   *   The entity, or NULL if we are not on a content entity path.
   */
  protected function getContentEntity() {
    $route = $this->routeMatch
      ->getRouteObject();
    if (!$route) {
      return NULL;
    }

    // Check if we are on a content entity path.
    $path = $route
      ->getPath();
    $paths = $this
      ->getContentEntityPaths();
    if (array_key_exists($path, $paths)) {

      // Return the entity.
      return $this->routeMatch
        ->getParameter($paths[$path]);
    }
    return NULL;
  }

  /**
   * Returns the paths for the link templates of all content entities.
   *
   * Based on LanguageNegotiationContentEntity::getContentEntityPaths().
   *
   * @return array
   *   An array of all content entity type IDs, keyed by the corresponding link
   *   template paths.
   *
   * @see \Drupal\language\Plugin\LanguageNegotiation\LanguageNegotiationContentEntity::getContentEntityPaths()
   */
  protected function getContentEntityPaths() {
    if (!isset($this->contentEntityPaths)) {
      $this->contentEntityPaths = [];

      /** @var \Drupal\Core\Entity\EntityTypeInterface[] $entity_types */
      $entity_types = $this->entityTypeManager
        ->getDefinitions();
      foreach ($entity_types as $entity_type_id => $entity_type) {
        if ($entity_type
          ->entityClassImplements(ContentEntityInterface::class)) {
          $entity_paths = array_fill_keys($entity_type
            ->getLinkTemplates(), $entity_type_id);
          $this->contentEntityPaths = array_merge($this->contentEntityPaths, $entity_paths);
        }
      }
    }
    return $this->contentEntityPaths;
  }

}

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

abstract class OgRouteGroupResolverBase in Organic groups 8

Hierarchy

File

Namespace

Members

API Navigation