group-8.x-1.x-dev/src/Entity/Storage/GroupRelationshipStorageInterface.php

<?php

namespace Drupal\group\Entity\Storage;

use Drupal\Core\Entity\ContentEntityStorageInterface;
use Drupal\Core\Entity\EntityInterface;
use Drupal\group\Entity\GroupInterface;

/**
 * Defines an interface for relationship entity storage classes.
 */
interface GroupRelationshipStorageInterface extends ContentEntityStorageInterface {

  /**
   * Creates a GroupRelationship entity for placing an entity in a group.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity to add to the group.
   * @param \Drupal\group\Entity\GroupInterface $group
   *   The group to add the entity to.
   * @param string $plugin_id
   *   The group relation type ID to add the entity with.
   * @param array $values
   *   (optional) Extra values to add to the GroupRelationship entity.
   *
   * @return \Drupal\group\Entity\GroupRelationshipInterface
   *   A new GroupRelationship entity.
   */
  public function createForEntityInGroup(EntityInterface $entity, GroupInterface $group, $plugin_id, $values = []);

  /**
   * Retrieves all GroupRelationship entities for a group.
   *
   * @param \Drupal\group\Entity\GroupInterface $group
   *   The group entity to load the relationship entities for.
   * @param string $plugin_id
   *   (optional) A group relation type ID to filter on.
   *
   * @return \Drupal\group\Entity\GroupRelationshipInterface[]
   *   A list of GroupRelationship entities indexed by their IDs.
   */
  public function loadByGroup(GroupInterface $group, $plugin_id = NULL);

  /**
   * Retrieves all GroupRelationship entities that represent a given entity.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity to load the relationship entities for.
   * @param string $plugin_id
   *   (optional) A group relation type ID to filter on.
   *
   * @return \Drupal\group\Entity\GroupRelationshipInterface[]
   *   A list of GroupRelationship entities indexed by their IDs.
   */
  public function loadByEntity(EntityInterface $entity, $plugin_id = NULL);

  /**
   * Retrieves all group relationships that represent a given entity in a group.
   *
   * @param \Drupal\Core\Entity\EntityInterface $entity
   *   The entity to load the relationship entities for.
   * @param \Drupal\group\Entity\GroupInterface $group
   *   The group entity to load the relationship entities for.
   * @param string $plugin_id
   *   (optional) A group relation type ID to filter on.
   *
   * @return \Drupal\group\Entity\GroupRelationshipInterface[]
   *   A list of GroupRelationship entities indexed by their IDs.
   */
  public function loadByEntityAndGroup(EntityInterface $entity, GroupInterface $group, $plugin_id = NULL);

  /**
   * Retrieves all GroupRelationship entities by their responsible plugin ID.
   *
   * @param string $plugin_id
   *   The group relation type ID.
   *
   * @return \Drupal\group\Entity\GroupRelationshipInterface[]
   *   A list of GroupRelationship entities indexed by their IDs.
   */
  public function loadByPluginId($plugin_id);

}