You are here

Home » API reference » Group 2.0.x » RelationHandlerTrait.php

trait RelationHandlerTrait in Group 2.0.x

Trait for group relation plugin handlers.

This trait contains a few service getters for services that are often needed in plugin handlers. When using one of these getters, please make sure you inject the dependency into the corresponding property from within your service's constructor.

Hierarchy

2 files declare their use of RelationHandlerTrait
GroupNodePermissionProvider.php in modules/gnode/src/Plugin/Group/RelationHandler/GroupNodePermissionProvider.php
GroupRelationManagerTest.php in tests/src/Unit/GroupRelationManagerTest.php

File

src/Plugin/Group/RelationHandler/RelationHandlerTrait.php, line 13

Namespace

Drupal\group\Plugin\Group\RelationHandler
View source 
trait RelationHandlerTrait {

  /**
   * The parent relation handler in the decorator chain.
   *
   * You MUST set this when you are decorating an existing handler.
   *
   * @var \Drupal\group\Plugin\Group\RelationHandler\RelationHandlerInterface|null
   */
  protected $parent = NULL;

  /**
   * The plugin ID as read from the definition.
   *
   * @var string
   */
  protected $pluginId;

  /**
   * The plugin definition.
   *
   * @var array
   *
   * @todo Plugin definition should become a class.
   */
  protected $definition;

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

  /**
   * The group relation manager.
   *
   * @var \Drupal\group\Plugin\Group\Relation\GroupRelationManagerInterface
   */
  protected $groupRelationManager;

  /**
   * {@inheritdoc}
   */
  public function init($plugin_id, array $definition) {
    if (isset($this->parent)) {
      $this->parent
        ->init($plugin_id, $definition);
    }
    $this->pluginId = $plugin_id;
    $this->definition = $definition;
  }

  /**
   * Gets the entity type manager service.
   *
   * @return \Drupal\Core\Entity\EntityTypeManagerInterface
   *   The entity type manager service.
   */
  protected function entityTypeManager() {
    if (!$this->entityTypeManager) {
      $this->entityTypeManager = \Drupal::entityTypeManager();
    }
    return $this->entityTypeManager;
  }

  /**
   * Gets the group relation manager service.
   *
   * @return \Drupal\group\Plugin\Group\Relation\GroupRelationManagerInterface
   *   The group relation manager service.
   */
  protected function groupRelationManager() {
    if (!$this->groupRelationManager) {
      $this->groupRelationManager = \Drupal::service('plugin.manager.group_relation');
    }
    return $this->groupRelationManager;
  }

}

Members

Namesort descending Modifiers Type Description Overrides
RelationHandlerTrait::$definition protected property The plugin definition.
RelationHandlerTrait::$entityTypeManager protected property The entity type manager.
RelationHandlerTrait::$groupRelationManager protected property The group relation manager.
RelationHandlerTrait::$parent protected property The parent relation handler in the decorator chain.
RelationHandlerTrait::$pluginId protected property The plugin ID as read from the definition.
RelationHandlerTrait::entityTypeManager protected function Gets the entity type manager service.
RelationHandlerTrait::groupRelationManager protected function Gets the group relation manager service.
RelationHandlerTrait::init public function