You are here

interface GroupContentStorageInterface in Group 8

Same name and namespace in other branches
  1. 2.0.x src/Entity/Storage/GroupContentStorageInterface.php \Drupal\group\Entity\Storage\GroupContentStorageInterface

Defines an interface for group content entity storage classes.

Hierarchy

Expanded class hierarchy of GroupContentStorageInterface

All classes that implement GroupContentStorageInterface

1 file declares its use of GroupContentStorageInterface
GroupContentAccessControlHandlerTest.php in tests/src/Unit/GroupContentAccessControlHandlerTest.php

File

src/Entity/Storage/GroupContentStorageInterface.php, line 12

Namespace

Drupal\group\Entity\Storage
View source
interface GroupContentStorageInterface extends ContentEntityStorageInterface {

  /**
   * Creates a GroupContent entity for placing a content entity in a group.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
   *   The content entity to add to the group.
   * @param \Drupal\group\Entity\GroupInterface $group
   *   The group to add the content entity to.
   * @param string $plugin_id
   *   The ID of the content enabler plugin to add the entity with.
   * @param array $values
   *   (optional) Extra values to add to the GroupContent entity.
   *
   * @return \Drupal\group\Entity\GroupContentInterface
   *   A new GroupContent entity.
   */
  public function createForEntityInGroup(ContentEntityInterface $entity, GroupInterface $group, $plugin_id, $values = []);

  /**
   * Retrieves all GroupContent entities for a group.
   *
   * @param \Drupal\group\Entity\GroupInterface $group
   *   The group entity to load the group content entities for.
   * @param string $plugin_id
   *   (optional) A content enabler plugin ID to filter on.
   * @param array $filters
   *   (optional) An associative array of extra filters where the keys are
   *   property or field names and the values are the value to filter on.
   *
   * @return \Drupal\group\Entity\GroupContentInterface[]
   *   A list of GroupContent entities matching the criteria.
   */
  public function loadByGroup(GroupInterface $group, $plugin_id = NULL, $filters = []);

  /**
   * Retrieves all GroupContent entities that represent a given entity.
   *
   * @param \Drupal\Core\Entity\ContentEntityInterface $entity
   *   An entity which may be within one or more groups.
   *
   * @return \Drupal\group\Entity\GroupContentInterface[]
   *   A list of GroupContent entities which refer to the given entity.
   */
  public function loadByEntity(ContentEntityInterface $entity);

  /**
   * Retrieves all GroupContent entities by their responsible plugin ID.
   *
   * @param string $plugin_id
   *   The ID of the content enabler plugin.
   *
   * @return \Drupal\group\Entity\GroupContentInterface[]
   *   A list of GroupContent entities indexed by their IDs.
   */
  public function loadByContentPluginId($plugin_id);

}

Members

Namesort descending Modifiers Type Description Overrides
ContentEntityStorageInterface::createWithSampleValues public function Creates an entity with sample field values. 2
EntityStorageInterface::create public function Constructs a new entity object, without permanently saving it. 1
EntityStorageInterface::delete public function Deletes permanently saved entities. 1
EntityStorageInterface::deleteRevision public function Delete a specific entity revision. 4
EntityStorageInterface::FIELD_LOAD_CURRENT constant Load the most recent version of an entity's field data.
EntityStorageInterface::FIELD_LOAD_REVISION constant Load the version of an entity's field data specified in the entity.
EntityStorageInterface::getAggregateQuery public function Gets an aggregated query instance. 1
EntityStorageInterface::getEntityType public function Gets the entity type definition. 1
EntityStorageInterface::getEntityTypeId public function Gets the entity type ID. 1
EntityStorageInterface::getQuery public function Gets an entity query instance. 1
EntityStorageInterface::hasData public function Determines if the storage contains any data. 1
EntityStorageInterface::load public function Loads one entity. 1
EntityStorageInterface::loadByProperties public function Load entities by their property values. 1
EntityStorageInterface::loadMultiple public function Loads one or more entities. 1
EntityStorageInterface::loadRevision public function Load a specific entity revision. 4
EntityStorageInterface::loadUnchanged public function Loads an unchanged entity from the database. 1
EntityStorageInterface::resetCache public function Resets the internal, static entity cache. 1
EntityStorageInterface::restore public function Restores a previously saved entity. 1
EntityStorageInterface::save public function Saves the entity permanently. 1
GroupContentStorageInterface::createForEntityInGroup public function Creates a GroupContent entity for placing a content entity in a group. 1
GroupContentStorageInterface::loadByContentPluginId public function Retrieves all GroupContent entities by their responsible plugin ID. 1
GroupContentStorageInterface::loadByEntity public function Retrieves all GroupContent entities that represent a given entity. 1
GroupContentStorageInterface::loadByGroup public function Retrieves all GroupContent entities for a group. 1
RevisionableStorageInterface::getLatestRevisionId public function Returns the latest revision identifier for an entity. 2
RevisionableStorageInterface::loadMultipleRevisions public function Loads multiple entity revisions. 2
TranslatableRevisionableStorageInterface::createRevision public function Creates a new revision starting off from the specified entity object. Overrides RevisionableStorageInterface::createRevision 2
TranslatableRevisionableStorageInterface::getLatestTranslationAffectedRevisionId public function Returns the latest revision affecting the specified translation. 2
TranslatableStorageInterface::createTranslation public function Constructs a new entity translation object, without permanently saving it. 2