You are here

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

interface GroupTypeInterface in Group 2.0.x

Same name and namespace in other branches
  1. 8 src/Entity/GroupTypeInterface.php \Drupal\group\Entity\GroupTypeInterface

Provides an interface defining a group type entity.

Hierarchy

Expanded class hierarchy of GroupTypeInterface

All classes that implement GroupTypeInterface

15 files declare their use of GroupTypeInterface
GroupContentTypeStorage.php in src/Entity/Storage/GroupContentTypeStorage.php
GroupContentTypeStorageInterface.php in src/Entity/Storage/GroupContentTypeStorageInterface.php
GroupController.php in src/Entity/Controller/GroupController.php
GroupPermissionHandler.php in src/Access/GroupPermissionHandler.php
GroupPermissionHandlerInterface.php in src/Access/GroupPermissionHandlerInterface.php

... See full list

File

src/Entity/GroupTypeInterface.php, line 12

Namespace

Drupal\group\Entity
View source 
interface GroupTypeInterface extends ConfigEntityInterface, EntityDescriptionInterface, RevisionableEntityBundleInterface {

  /**
   * The maximum length of the ID, in characters.
   *
   * This is shorter than the default limit of 32 to allow group roles to have
   * an ID which can be appended to the group type's ID without exceeding the
   * default limit there. We leave of 10 characters to account for '-anonymous'.
   */
  const ID_MAX_LENGTH = 22;

  /**
   * Gets the group roles.
   *
   * @param bool $include_internal
   *   (optional) Whether to include internal roles in the result. Defaults to
   *   TRUE.
   *
   * @return \Drupal\group\Entity\GroupRoleInterface[]
   *   The group roles this group type uses.
   */
  public function getRoles($include_internal = TRUE);

  /**
   * Gets the role IDs.
   *
   * @param bool $include_internal
   *   (optional) Whether to include internal roles in the result. Defaults to
   *   TRUE.
   *
   * @return string[]
   *   The ids of the group roles this group type uses.
   */
  public function getRoleIds($include_internal = TRUE);

  /**
   * Gets the generic anonymous group role for this group type.
   *
   * @return \Drupal\group\Entity\GroupRoleInterface
   *   The anonymous group role this group type uses.
   */
  public function getAnonymousRole();

  /**
   * Gets the generic anonymous role ID.
   *
   * @return string
   *   The ID of the anonymous group role this group type uses.
   */
  public function getAnonymousRoleId();

  /**
   * Gets the generic outsider group role for this group type.
   *
   * @return \Drupal\group\Entity\GroupRoleInterface
   *   The outsider group role this group type uses.
   */
  public function getOutsiderRole();

  /**
   * Gets the generic outsider role ID.
   *
   * @return string
   *   The ID of the outsider group role this group type uses.
   */
  public function getOutsiderRoleId();

  /**
   * Gets the generic member group role for this group type.
   *
   * @return \Drupal\group\Entity\GroupRoleInterface
   *   The generic member group role this group type uses.
   */
  public function getMemberRole();

  /**
   * Gets the generic member role ID.
   *
   * @return string
   *   The ID of the generic member group role this group type uses.
   */
  public function getMemberRoleId();

  /**
   * Sets whether a new revision should be created by default.
   *
   * @param bool $new_revision
   *   TRUE if a new revision should be created by default.
   */
  public function setNewRevision($new_revision);

  /**
   * Returns whether the group creator automatically receives a membership.
   *
   * @return bool
   *   Whether the group creator automatically receives a membership.
   */
  public function creatorGetsMembership();

  /**
   * Returns whether the group creator must complete their membership.
   *
   * @return bool
   *   Whether the group creator must complete their membership.
   */
  public function creatorMustCompleteMembership();

  /**
   * Gets the IDs of the group roles a group creator should receive.
   *
   * @return string
   *   The IDs of the group role the group creator should receive.
   */
  public function getCreatorRoleIds();

  /**
   * Returns the installed group relation plugins for this group type.
   *
   * @return \Drupal\group\Plugin\Group\Relation\GroupRelationCollection
   *   The group content plugin collection.
   */
  public function getInstalledContentPlugins();

  /**
   * Checks whether a group relation plugin is installed for this group type.
   *
   * @param string $plugin_id
   *   The ID of the group relation plugin to check for.
   *
   * @return bool
   *   Whether the group relation plugin is installed.
   */
  public function hasContentPlugin($plugin_id);

  /**
   * Gets an installed group relation plugin for this group type.
   *
   * Warning: In places where the plugin may not be installed on the group type,
   * you should always run ::hasContentPlugin() first or you may risk ending up
   * with crashes or unreliable data.
   *
   * @param string $plugin_id
   *   The ID of the group relation plugin.
   *
   * @return \Drupal\group\Plugin\Group\Relation\GroupRelationInterface
   *   The installed group relation plugin for the group type.
   */
  public function getContentPlugin($plugin_id);

}

Members

Namesort descending Modifiers Type Description Overrides
AccessibleInterface::access public function Checks data value access. 9
CacheableDependencyInterface::getCacheContexts public function The cache contexts associated with this object. 34
CacheableDependencyInterface::getCacheMaxAge public function The maximum age for which this object may be cached. 34
CacheableDependencyInterface::getCacheTags public function The cache tags associated with this object. 27
ConfigEntityInterface::calculateDependencies public function Calculates dependencies and stores them in the dependency property. 2
ConfigEntityInterface::disable public function Disables the configuration entity. 2
ConfigEntityInterface::enable public function Enables the configuration entity. 2
ConfigEntityInterface::get public function Returns the value of a property. 2
ConfigEntityInterface::getDependencies public function Gets the configuration dependencies. 2
ConfigEntityInterface::hasTrustedData public function Gets whether on not the data is trusted. 2
ConfigEntityInterface::isInstallable public function Checks whether this entity is installable. 2
ConfigEntityInterface::isUninstalling public function Returns whether this entity is being changed during the uninstall process. 2
ConfigEntityInterface::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. 2
ConfigEntityInterface::set public function Sets the value of a property. 2
ConfigEntityInterface::setStatus public function Sets the status of the configuration entity. 2
ConfigEntityInterface::status public function Returns whether the configuration entity is enabled. 2
ConfigEntityInterface::trustData public function Sets that the data should be trusted. 2
EntityDescriptionInterface::getDescription public function Gets the entity description. 3
EntityDescriptionInterface::setDescription public function Sets the entity description. 3
EntityInterface::bundle public function Gets the bundle of the entity. 2
EntityInterface::create public static function Constructs a new entity object, without permanently saving it. 2
EntityInterface::createDuplicate public function Creates a duplicate of the entity. 2
EntityInterface::delete public function Deletes an entity permanently. 2
EntityInterface::enforceIsNew public function Enforces an entity to be new. 2
EntityInterface::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. 2
EntityInterface::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. 2
EntityInterface::getConfigDependencyName public function Gets the configuration dependency name. 2
EntityInterface::getConfigTarget public function Gets the configuration target identifier for the entity. 2
EntityInterface::getEntityType public function Gets the entity type definition. 2
EntityInterface::getEntityTypeId public function Gets the ID of the type of the entity. 2
EntityInterface::getOriginalId public function Gets the original ID. 2
EntityInterface::getTypedData public function Gets a typed data object for this entity object. 2
EntityInterface::hasLinkTemplate public function Indicates if a link template exists for a given key. 2
EntityInterface::id public function Gets the identifier. 2
EntityInterface::isNew public function Determines whether the entity is new. 2
EntityInterface::label public function Gets the label of the entity. 2
EntityInterface::language public function Gets the language of the entity. 2
EntityInterface::load public static function Loads an entity. 2
EntityInterface::loadMultiple public static function Loads one or more entities. 2
EntityInterface::postCreate public function Acts on a created entity before hooks are invoked. 2
EntityInterface::postDelete public static function Acts on deleted entities before the delete hook is invoked. 2
EntityInterface::postLoad public static function Acts on loaded entities. 3
EntityInterface::postSave public function Acts on a saved entity before the insert or update hook is invoked. 2
EntityInterface::preCreate public static function Changes the values of an entity before it is created. 2
EntityInterface::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. 2
EntityInterface::preSave public function Acts on an entity before the presave hook is invoked. 2
EntityInterface::referencedEntities public function Gets a list of entities referenced by this entity. 2
EntityInterface::save public function Saves an entity permanently. 2
EntityInterface::setOriginalId public function Sets the original ID. 2
EntityInterface::toArray public function Gets an array of all property values. 3
EntityInterface::toLink public function Generates the HTML for a link to this entity. 2
EntityInterface::toUrl public function Gets the URL object for the entity. 2
EntityInterface::uriRelationships public function Gets a list of URI relationships supported by this entity. 2
EntityInterface::uuid public function Gets the entity UUID (Universally Unique Identifier). 2
GroupTypeInterface::creatorGetsMembership public function Returns whether the group creator automatically receives a membership. 1
GroupTypeInterface::creatorMustCompleteMembership public function Returns whether the group creator must complete their membership. 1
GroupTypeInterface::getAnonymousRole public function Gets the generic anonymous group role for this group type. 1
GroupTypeInterface::getAnonymousRoleId public function Gets the generic anonymous role ID. 1
GroupTypeInterface::getContentPlugin public function Gets an installed group relation plugin for this group type. 1
GroupTypeInterface::getCreatorRoleIds public function Gets the IDs of the group roles a group creator should receive. 1
GroupTypeInterface::getInstalledContentPlugins public function Returns the installed group relation plugins for this group type. 1
GroupTypeInterface::getMemberRole public function Gets the generic member group role for this group type. 1
GroupTypeInterface::getMemberRoleId public function Gets the generic member role ID. 1
GroupTypeInterface::getOutsiderRole public function Gets the generic outsider group role for this group type. 1
GroupTypeInterface::getOutsiderRoleId public function Gets the generic outsider role ID. 1
GroupTypeInterface::getRoleIds public function Gets the role IDs. 1
GroupTypeInterface::getRoles public function Gets the group roles. 1
GroupTypeInterface::hasContentPlugin public function Checks whether a group relation plugin is installed for this group type. 1
GroupTypeInterface::ID_MAX_LENGTH constant The maximum length of the ID, in characters.
GroupTypeInterface::setNewRevision public function Sets whether a new revision should be created by default. 1
RefinableCacheableDependencyInterface::addCacheableDependency public function Adds a dependency on an object: merges its cacheability metadata. 1
RefinableCacheableDependencyInterface::addCacheContexts public function Adds cache contexts. 1
RefinableCacheableDependencyInterface::addCacheTags public function Adds cache tags. 1
RefinableCacheableDependencyInterface::mergeCacheMaxAge public function Merges the maximum age (in seconds) with the existing maximum age. 1
RevisionableEntityBundleInterface::shouldCreateNewRevision public function Gets whether a new revision should be created by default. 3
SynchronizableInterface::isSyncing public function Returns whether this entity is being changed as part of a synchronization. 1
SynchronizableInterface::setSyncing public function Sets the status of the synchronization flag. 1
ThirdPartySettingsInterface::getThirdPartyProviders public function Gets the list of third parties that store information. 5
ThirdPartySettingsInterface::getThirdPartySetting public function Gets the value of a third-party setting. 5
ThirdPartySettingsInterface::getThirdPartySettings public function Gets all third-party settings of a given module. 5
ThirdPartySettingsInterface::setThirdPartySetting public function Sets the value of a third-party setting. 5
ThirdPartySettingsInterface::unsetThirdPartySetting public function Unsets a third-party setting. 5