interface GroupContentTypeStorageInterface in Group 2.0.x

Defines an interface for group content type entity storage classes.

Hierarchy

• interface \Drupal\Core\Entity\EntityStorageInterface
  • interface \Drupal\Core\Config\Entity\ConfigEntityStorageInterface
    • interface \Drupal\group\Entity\Storage\GroupContentTypeStorageInterface

1 file declares its use of GroupContentTypeStorageInterface

GroupContentAccessControlHandlerTest.php in tests/src/Unit/GroupContentAccessControlHandlerTest.php

File

src/Entity/Storage/GroupContentTypeStorageInterface.php, line 11

Namespace

Drupal\group\Entity\Storage

interface GroupContentTypeStorageInterface extends ConfigEntityStorageInterface {

  /**
   * Retrieves all group content types for a group type.
   *
   * @param \Drupal\group\Entity\GroupTypeInterface $group_type
   *   The group type to load the group content types for.
   *
   * @return \Drupal\group\Entity\GroupContentTypeInterface[]
   *   An array of group content types indexed by their IDs.
   */
  public function loadByGroupType(GroupTypeInterface $group_type);

  /**
   * Retrieves group content types by their responsible plugin ID.
   *
   * @param string|string[] $plugin_id
   *   The ID of the group relation plugin or an array of plugin IDs. If more
   *   than one plugin ID is provided, this will load all of the group content
   *   types that match any of the provided plugin IDs.
   *
   * @return \Drupal\group\Entity\GroupContentTypeInterface[]
   *   An array of group content types indexed by their IDs.
   */
  public function loadByContentPluginId($plugin_id);

  /**
   * Retrieves group content types which could serve a given entity type.
   *
   * @param string $entity_type_id
   *   An entity type ID which may be served by one or more group content types.
   *
   * @return \Drupal\group\Entity\GroupContentTypeInterface[]
   *   An array of group content types indexed by their IDs.
   */
  public function loadByEntityTypeId($entity_type_id);

  /**
   * Creates a group content type for a group type using a specific plugin.
   *
   * @param \Drupal\group\Entity\GroupTypeInterface $group_type
   *   The group type to create the group content type for.
   * @param string $plugin_id
   *   The ID of the group relation plugin to use.
   * @param array $configuration
   *   (optional) An array of group relation plugin configuration.
   *
   * @return \Drupal\group\Entity\GroupContentTypeInterface
   *   A new, unsaved GroupContentType entity.
   */
  public function createFromPlugin(GroupTypeInterface $group_type, $plugin_id, array $configuration = []);

}

Members

Name	Modifiers	Type	Description	Overrides
ConfigEntityStorageInterface::createFromStorageRecord	public	function	Creates a configuration entity from storage values.	1
ConfigEntityStorageInterface::getIDFromConfigName	public static	function	Extracts the configuration entity ID from the full configuration name.	1
ConfigEntityStorageInterface::loadMultipleOverrideFree	public	function	Loads one or more entities in their original form without overrides.	1
ConfigEntityStorageInterface::loadOverrideFree	public	function	Loads one entity in their original form without overrides.	1
ConfigEntityStorageInterface::updateFromStorageRecord	public	function	Updates a configuration entity from storage values.	1
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 entity cache.	1
EntityStorageInterface::restore	public	function	Restores a previously saved entity.	1
EntityStorageInterface::save	public	function	Saves the entity permanently.	1
GroupContentTypeStorageInterface::createFromPlugin	public	function	Creates a group content type for a group type using a specific plugin.	1
GroupContentTypeStorageInterface::loadByContentPluginId	public	function	Retrieves group content types by their responsible plugin ID.	1
GroupContentTypeStorageInterface::loadByEntityTypeId	public	function	Retrieves group content types which could serve a given entity type.	1
GroupContentTypeStorageInterface::loadByGroupType	public	function	Retrieves all group content types for a group type.	1