You are here

Home » API reference » Group 8 » GroupType.php

class GroupType in Group 8

Same name in this branch
  1. 8 src/Entity/GroupType.php \Drupal\group\Entity\GroupType
  2. 8 src/Plugin/Condition/GroupType.php \Drupal\group\Plugin\Condition\GroupType
Same name and namespace in other branches
  1. 2.0.x src/Entity/GroupType.php \Drupal\group\Entity\GroupType

Defines the Group type configuration entity.

Plugin annotation


@ConfigEntityType(
  id = "group_type",
  label = @Translation("Group type"),
  label_singular = @Translation("group type"),
  label_plural = @Translation("group types"),
  label_count = @PluralTranslation(
    singular = "@count group type",
    plural = "@count group types"
  ),
  handlers = {
    "access" = "Drupal\group\Entity\Access\GroupTypeAccessControlHandler",
    "form" = {
      "add" = "Drupal\group\Entity\Form\GroupTypeForm",
      "edit" = "Drupal\group\Entity\Form\GroupTypeForm",
      "delete" = "Drupal\group\Entity\Form\GroupTypeDeleteForm"
    },
    "route_provider" = {
      "html" = "Drupal\group\Entity\Routing\GroupTypeRouteProvider",
    },
    "list_builder" = "Drupal\group\Entity\Controller\GroupTypeListBuilder",
  },
  admin_permission = "administer group",
  config_prefix = "type",
  bundle_of = "group",
  static_cache = TRUE,
  entity_keys = {
    "id" = "id",
    "label" = "label"
  },
  links = {
    "add-form" = "/admin/group/types/add",
    "collection" = "/admin/group/types",
    "content-plugins" = "/admin/group/types/manage/{group_type}/content",
    "delete-form" = "/admin/group/types/manage/{group_type}/delete",
    "edit-form" = "/admin/group/types/manage/{group_type}",
    "permissions-form" = "/admin/group/types/manage/{group_type}/permissions"
  },
  config_export = {
    "id",
    "label",
    "description",
    "new_revision",
    "creator_membership",
    "creator_wizard",
    "creator_roles",
  }
)

Hierarchy

Expanded class hierarchy of GroupType

3 files declare their use of GroupType
group.post_update.php in ./group.post_update.php
Post update functions for Group.
GroupContentEnablerBase.php in src/Plugin/GroupContentEnablerBase.php
GroupPermissions.php in src/Access/GroupPermissions.php

File

src/Entity/GroupType.php, line 60

Namespace

Drupal\group\Entity
View source 
class GroupType extends ConfigEntityBundleBase implements GroupTypeInterface {

  /**
   * The machine name of the group type.
   *
   * @var string
   */
  protected $id;

  /**
   * The human-readable name of the group type.
   *
   * @var string
   */
  protected $label;

  /**
   * A brief description of the group type.
   *
   * @var string
   */
  protected $description;

  /**
   * Whether a new revision should be created by default.
   *
   * @var bool
   */
  protected $new_revision = TRUE;

  /**
   * The group creator automatically receives a membership.
   *
   * @var bool
   */
  protected $creator_membership = TRUE;

  /**
   * The group creator must immediately complete their membership.
   *
   * @var bool
   */
  protected $creator_wizard = TRUE;

  /**
   * The IDs of the group roles a group creator should receive.
   *
   * @var string[]
   */
  protected $creator_roles = [];

  /**
   * {@inheritdoc}
   */
  public function id() {
    return $this->id;
  }

  /**
   * {@inheritdoc}
   */
  public function getDescription() {
    return $this->description;
  }

  /**
   * {@inheritdoc}
   */
  public function setDescription($description) {
    $this->description = $description;
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function getRoles($include_internal = TRUE) {
    $properties = [
      'group_type' => $this
        ->id(),
    ];

    // Exclude internal roles if told to.
    if ($include_internal === FALSE) {
      $properties['internal'] = FALSE;
    }
    return $this
      ->entityTypeManager()
      ->getStorage('group_role')
      ->loadByProperties($properties);
  }

  /**
   * {@inheritdoc}
   */
  public function getRoleIds($include_internal = TRUE) {
    $query = $this
      ->entityTypeManager()
      ->getStorage('group_role')
      ->getQuery()
      ->condition('group_type', $this
      ->id());

    // Exclude internal roles if told to.
    if ($include_internal === FALSE) {
      $query
        ->condition('internal', FALSE);
    }
    return $query
      ->execute();
  }

  /**
   * {@inheritdoc}
   */
  public function getAnonymousRole() {
    return $this
      ->entityTypeManager()
      ->getStorage('group_role')
      ->load($this
      ->getAnonymousRoleId());
  }

  /**
   * {@inheritdoc}
   */
  public function getAnonymousRoleId() {
    return $this
      ->id() . '-anonymous';
  }

  /**
   * {@inheritdoc}
   */
  public function getOutsiderRole() {
    return $this
      ->entityTypeManager()
      ->getStorage('group_role')
      ->load($this
      ->getOutsiderRoleId());
  }

  /**
   * {@inheritdoc}
   */
  public function getOutsiderRoleId() {
    return $this
      ->id() . '-outsider';
  }

  /**
   * {@inheritdoc}
   */
  public function getMemberRole() {
    return $this
      ->entityTypeManager()
      ->getStorage('group_role')
      ->load($this
      ->getMemberRoleId());
  }

  /**
   * {@inheritdoc}
   */
  public function getMemberRoleId() {
    return $this
      ->id() . '-member';
  }

  /**
   * {@inheritdoc}
   */
  public function shouldCreateNewRevision() {
    return $this->new_revision;
  }

  /**
   * {@inheritdoc}
   */
  public function setNewRevision($new_revision) {
    $this->new_revision = $new_revision;
  }

  /**
   * {@inheritdoc}
   */
  public function creatorGetsMembership() {
    return $this->creator_membership;
  }

  /**
   * {@inheritdoc}
   */
  public function creatorMustCompleteMembership() {
    return $this->creator_membership && $this->creator_wizard;
  }

  /**
   * {@inheritdoc}
   */
  public function getCreatorRoleIds() {
    return $this->creator_roles;
  }

  /**
   * {@inheritdoc}
   */
  public function preSave(EntityStorageInterface $storage) {

    // Throw an exception if the group type ID is longer than the limit.
    if (strlen($this
      ->id()) > GroupTypeInterface::ID_MAX_LENGTH) {
      throw new ConfigEntityIdLengthException("Attempt to create a group type with an ID longer than " . GroupTypeInterface::ID_MAX_LENGTH . " characters: {$this->id()}.");
    }
    parent::preSave($storage);
  }

  /**
   * {@inheritdoc}
   */
  public function postSave(EntityStorageInterface $storage, $update = TRUE) {
    parent::postSave($storage, $update);
    if (!$update) {

      // Store the id in a short variable for readability.
      $group_type_id = $this
        ->id();

      // @todo Remove this line when https://www.drupal.org/node/2645202 lands.
      $this
        ->setOriginalId($group_type_id);

      // The code below will create the default group roles, synchronized group
      // roles and the group content types for enforced plugins. It is extremely
      // important that we only run this code when we're not dealing with config
      // synchronization.
      //
      // Any of the config entities created here could still be queued up for
      // import in a combined config import. Therefore, we only create them in
      // \Drupal\group\EventSubscriber\ConfigSubscriber after the entire import
      // has finished.
      if (!$this
        ->isSyncing()) {

        /** @var \Drupal\group\Entity\Storage\GroupRoleStorageInterface $group_role_storage */
        $group_role_storage = $this
          ->entityTypeManager()
          ->getStorage('group_role');

        // Enable enforced content plugins for the new group type.
        $this
          ->getContentEnablerManager()
          ->installEnforced($this);

        // Create internal and synchronized group roles for the new group type.
        $group_role_storage
          ->createInternal([
          $group_type_id,
        ]);
        $group_role_storage
          ->createSynchronized([
          $group_type_id,
        ]);
      }
    }
  }

  /**
   * Returns the group role synchronizer service.
   *
   * @return \Drupal\group\GroupRoleSynchronizerInterface
   *   The group role synchronizer service.
   */
  protected function getGroupRoleSynchronizer() {
    return \Drupal::service('group_role.synchronizer');
  }

  /**
   * Returns the content enabler plugin manager.
   *
   * @return \Drupal\group\Plugin\GroupContentEnablerManagerInterface
   *   The group content plugin manager.
   */
  protected function getContentEnablerManager() {
    return \Drupal::service('plugin.manager.group_content_enabler');
  }

  /**
   * {@inheritdoc}
   */
  public function getInstalledContentPlugins() {
    return $this
      ->getContentEnablerManager()
      ->getInstalled($this);
  }

  /**
   * {@inheritdoc}
   */
  public function hasContentPlugin($plugin_id) {
    $installed = $this
      ->getContentEnablerManager()
      ->getInstalledIds($this);
    return in_array($plugin_id, $installed);
  }

  /**
   * {@inheritdoc}
   */
  public function getContentPlugin($plugin_id) {
    return $this
      ->getInstalledContentPlugins()
      ->get($plugin_id);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
CacheableDependencyTrait::$cacheContexts protected property Cache contexts.
CacheableDependencyTrait::$cacheMaxAge protected property Cache max-age.
CacheableDependencyTrait::$cacheTags protected property Cache tags.
CacheableDependencyTrait::setCacheability protected function Sets cacheability; useful for value object constructors.
ConfigEntityBase::$isUninstalling private property Whether the config is being deleted by the uninstall process.
ConfigEntityBase::$langcode protected property The language code of the entity's default language.
ConfigEntityBase::$originalId protected property The original ID of the configuration entity.
ConfigEntityBase::$status protected property The enabled/disabled status of the configuration entity. 4
ConfigEntityBase::$third_party_settings protected property Third party entity settings.
ConfigEntityBase::$trustedData protected property Trust supplied data and not use configuration schema on save.
ConfigEntityBase::$uuid protected property The UUID for this entity.
ConfigEntityBase::$_core protected property Information maintained by Drupal core about configuration.
ConfigEntityBase::addDependency protected function Overrides \Drupal\Core\Entity\DependencyTrait:addDependency().
ConfigEntityBase::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityInterface::calculateDependencies 13
ConfigEntityBase::createDuplicate public function Creates a duplicate of the entity. Overrides EntityBase::createDuplicate 1
ConfigEntityBase::disable public function Disables the configuration entity. Overrides ConfigEntityInterface::disable 1
ConfigEntityBase::enable public function Enables the configuration entity. Overrides ConfigEntityInterface::enable
ConfigEntityBase::get public function Returns the value of a property. Overrides ConfigEntityInterface::get
ConfigEntityBase::getCacheTagsToInvalidate public function Returns the cache tags that should be used to invalidate caches. Overrides EntityBase::getCacheTagsToInvalidate 1
ConfigEntityBase::getConfigDependencyName public function Gets the configuration dependency name. Overrides EntityBase::getConfigDependencyName
ConfigEntityBase::getConfigManager protected static function Gets the configuration manager.
ConfigEntityBase::getConfigTarget public function Gets the configuration target identifier for the entity. Overrides EntityBase::getConfigTarget
ConfigEntityBase::getDependencies public function Gets the configuration dependencies. Overrides ConfigEntityInterface::getDependencies
ConfigEntityBase::getOriginalId public function Gets the original ID. Overrides EntityBase::getOriginalId
ConfigEntityBase::getThirdPartyProviders public function Gets the list of third parties that store information. Overrides ThirdPartySettingsInterface::getThirdPartyProviders
ConfigEntityBase::getThirdPartySetting public function Gets the value of a third-party setting. Overrides ThirdPartySettingsInterface::getThirdPartySetting
ConfigEntityBase::getThirdPartySettings public function Gets all third-party settings of a given module. Overrides ThirdPartySettingsInterface::getThirdPartySettings
ConfigEntityBase::getTypedConfig protected function Gets the typed config manager.
ConfigEntityBase::hasTrustedData public function Gets whether on not the data is trusted. Overrides ConfigEntityInterface::hasTrustedData
ConfigEntityBase::invalidateTagsOnDelete protected static function Override to never invalidate the individual entities' cache tags; the config system already invalidates them. Overrides EntityBase::invalidateTagsOnDelete
ConfigEntityBase::invalidateTagsOnSave protected function Override to never invalidate the entity's cache tag; the config system already invalidates it. Overrides EntityBase::invalidateTagsOnSave
ConfigEntityBase::isInstallable public function Checks whether this entity is installable. Overrides ConfigEntityInterface::isInstallable 2
ConfigEntityBase::isNew public function Overrides Entity::isNew(). Overrides EntityBase::isNew
ConfigEntityBase::isUninstalling public function Returns whether this entity is being changed during the uninstall process. Overrides ConfigEntityInterface::isUninstalling
ConfigEntityBase::link public function Deprecated way of generating a link to the entity. See toLink(). Overrides EntityBase::link
ConfigEntityBase::onDependencyRemoval public function Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityInterface::onDependencyRemoval 7
ConfigEntityBase::preDelete public static function Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete 8
ConfigEntityBase::save public function Saves an entity permanently. Overrides EntityBase::save 1
ConfigEntityBase::set public function Sets the value of a property. Overrides ConfigEntityInterface::set
ConfigEntityBase::setOriginalId public function Sets the original ID. Overrides EntityBase::setOriginalId
ConfigEntityBase::setStatus public function Sets the status of the configuration entity. Overrides ConfigEntityInterface::setStatus
ConfigEntityBase::setThirdPartySetting public function Sets the value of a third-party setting. Overrides ThirdPartySettingsInterface::setThirdPartySetting
ConfigEntityBase::setUninstalling public function
ConfigEntityBase::sort public static function Helper callback for uasort() to sort configuration entities by weight and label. 6
ConfigEntityBase::status public function Returns whether the configuration entity is enabled. Overrides ConfigEntityInterface::status 4
ConfigEntityBase::toArray public function Gets an array of all property values. Overrides EntityBase::toArray 2
ConfigEntityBase::toUrl public function Gets the URL object for the entity. Overrides EntityBase::toUrl
ConfigEntityBase::trustData public function Sets that the data should be trusted. Overrides ConfigEntityInterface::trustData
ConfigEntityBase::unsetThirdPartySetting public function Unsets a third-party setting. Overrides ThirdPartySettingsInterface::unsetThirdPartySetting
ConfigEntityBase::url public function Gets the public URL for this entity. Overrides EntityBase::url
ConfigEntityBase::urlInfo public function Gets the URL object for the entity. Overrides EntityBase::urlInfo
ConfigEntityBase::__construct public function Constructs an Entity object. Overrides EntityBase::__construct 10
ConfigEntityBase::__sleep public function Overrides EntityBase::__sleep 4
ConfigEntityBundleBase::deleteDisplays protected function Deletes display if a bundle is deleted.
ConfigEntityBundleBase::loadDisplays protected function Returns view or form displays for this bundle.
ConfigEntityBundleBase::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityBase::postDelete 2
DependencySerializationTrait::$_entityStorages protected property An array of entity type IDs keyed by the property name of their storages.
DependencySerializationTrait::$_serviceIds protected property An array of service IDs keyed by property name used for serialization.
DependencySerializationTrait::__sleep public function Aliased as: traitSleep 1
DependencySerializationTrait::__wakeup public function 2
DependencyTrait::$dependencies protected property The object's dependencies.
DependencyTrait::addDependencies protected function Adds multiple dependencies.
DependencyTrait::addDependency protected function Adds a dependency. Aliased as: addDependencyTrait
EntityBase::$enforceIsNew protected property Boolean indicating whether the entity should be forced to be new.
EntityBase::$entityTypeId protected property The entity type.
EntityBase::$typedData protected property A typed data object wrapping this entity.
EntityBase::access public function Checks data value access. Overrides AccessibleInterface::access 1
EntityBase::bundle public function Gets the bundle of the entity. Overrides EntityInterface::bundle 1
EntityBase::create public static function Constructs a new entity object, without permanently saving it. Overrides EntityInterface::create
EntityBase::delete public function Deletes an entity permanently. Overrides EntityInterface::delete 2
EntityBase::enforceIsNew public function Enforces an entity to be new. Overrides EntityInterface::enforceIsNew
EntityBase::entityManager Deprecated protected function Gets the entity manager.
EntityBase::entityTypeBundleInfo protected function Gets the entity type bundle info service.
EntityBase::entityTypeManager protected function Gets the entity type manager.
EntityBase::getCacheContexts public function The cache contexts associated with this object. Overrides CacheableDependencyTrait::getCacheContexts
EntityBase::getCacheMaxAge public function The maximum age for which this object may be cached. Overrides CacheableDependencyTrait::getCacheMaxAge
EntityBase::getCacheTags public function The cache tags associated with this object. Overrides CacheableDependencyTrait::getCacheTags
EntityBase::getConfigDependencyKey public function Gets the key that is used to store configuration dependencies. Overrides EntityInterface::getConfigDependencyKey
EntityBase::getEntityType public function Gets the entity type definition. Overrides EntityInterface::getEntityType
EntityBase::getEntityTypeId public function Gets the ID of the type of the entity. Overrides EntityInterface::getEntityTypeId
EntityBase::getListCacheTagsToInvalidate protected function The list cache tags to invalidate for this entity.
EntityBase::getTypedData public function Gets a typed data object for this entity object. Overrides EntityInterface::getTypedData
EntityBase::hasLinkTemplate public function Indicates if a link template exists for a given key. Overrides EntityInterface::hasLinkTemplate
EntityBase::label public function Gets the label of the entity. Overrides EntityInterface::label 6
EntityBase::language public function Gets the language of the entity. Overrides EntityInterface::language 1
EntityBase::languageManager protected function Gets the language manager.
EntityBase::linkTemplates protected function Gets an array link templates. 1
EntityBase::load public static function Loads an entity. Overrides EntityInterface::load
EntityBase::loadMultiple public static function Loads one or more entities. Overrides EntityInterface::loadMultiple
EntityBase::postCreate public function Acts on a created entity before hooks are invoked. Overrides EntityInterface::postCreate 4
EntityBase::postLoad public static function Acts on loaded entities. Overrides EntityInterface::postLoad 2
EntityBase::preCreate public static function Changes the values of an entity before it is created. Overrides EntityInterface::preCreate 5
EntityBase::referencedEntities public function Gets a list of entities referenced by this entity. Overrides EntityInterface::referencedEntities 1
EntityBase::toLink public function Generates the HTML for a link to this entity. Overrides EntityInterface::toLink
EntityBase::uriRelationships public function Gets a list of URI relationships supported by this entity. Overrides EntityInterface::uriRelationships
EntityBase::urlRouteParameters protected function Gets an array of placeholders for this entity. 2
EntityBase::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
GroupType::$creator_membership protected property The group creator automatically receives a membership.
GroupType::$creator_roles protected property The IDs of the group roles a group creator should receive.
GroupType::$creator_wizard protected property The group creator must immediately complete their membership.
GroupType::$description protected property A brief description of the group type.
GroupType::$id protected property The machine name of the group type.
GroupType::$label protected property The human-readable name of the group type.
GroupType::$new_revision protected property Whether a new revision should be created by default.
GroupType::creatorGetsMembership public function Returns whether the group creator automatically receives a membership. Overrides GroupTypeInterface::creatorGetsMembership
GroupType::creatorMustCompleteMembership public function Returns whether the group creator must complete their membership. Overrides GroupTypeInterface::creatorMustCompleteMembership
GroupType::getAnonymousRole public function Gets the generic anonymous group role for this group type. Overrides GroupTypeInterface::getAnonymousRole
GroupType::getAnonymousRoleId public function Gets the generic anonymous role ID. Overrides GroupTypeInterface::getAnonymousRoleId
GroupType::getContentEnablerManager protected function Returns the content enabler plugin manager.
GroupType::getContentPlugin public function Gets an installed content enabler plugin for this group type. Overrides GroupTypeInterface::getContentPlugin
GroupType::getCreatorRoleIds public function Gets the IDs of the group roles a group creator should receive. Overrides GroupTypeInterface::getCreatorRoleIds
GroupType::getDescription public function Gets the entity description. Overrides EntityDescriptionInterface::getDescription
GroupType::getGroupRoleSynchronizer protected function Returns the group role synchronizer service.
GroupType::getInstalledContentPlugins public function Returns the installed content enabler plugins for this group type. Overrides GroupTypeInterface::getInstalledContentPlugins
GroupType::getMemberRole public function Gets the generic member group role for this group type. Overrides GroupTypeInterface::getMemberRole
GroupType::getMemberRoleId public function Gets the generic member role ID. Overrides GroupTypeInterface::getMemberRoleId
GroupType::getOutsiderRole public function Gets the generic outsider group role for this group type. Overrides GroupTypeInterface::getOutsiderRole
GroupType::getOutsiderRoleId public function Gets the generic outsider role ID. Overrides GroupTypeInterface::getOutsiderRoleId
GroupType::getRoleIds public function Gets the role IDs. Overrides GroupTypeInterface::getRoleIds
GroupType::getRoles public function Gets the group roles. Overrides GroupTypeInterface::getRoles
GroupType::hasContentPlugin public function Checks whether a content enabler plugin is installed for this group type. Overrides GroupTypeInterface::hasContentPlugin
GroupType::id public function Gets the identifier. Overrides EntityBase::id
GroupType::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides ConfigEntityBundleBase::postSave
GroupType::preSave public function Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBundleBase::preSave
GroupType::setDescription public function Sets the entity description. Overrides EntityDescriptionInterface::setDescription
GroupType::setNewRevision public function Sets whether a new revision should be created by default. Overrides GroupTypeInterface::setNewRevision
GroupType::shouldCreateNewRevision public function Gets whether a new revision should be created by default. Overrides RevisionableEntityBundleInterface::shouldCreateNewRevision
GroupTypeInterface::ID_MAX_LENGTH constant The maximum length of the ID, in characters.
PluginDependencyTrait::calculatePluginDependencies protected function Calculates and adds dependencies of a specific plugin instance. 1
PluginDependencyTrait::getPluginDependencies protected function Calculates and returns dependencies of a specific plugin instance.
PluginDependencyTrait::moduleHandler protected function Wraps the module handler. 1
PluginDependencyTrait::themeHandler protected function Wraps the theme handler. 1
RefinableCacheableDependencyTrait::addCacheableDependency public function 1
RefinableCacheableDependencyTrait::addCacheContexts public function
RefinableCacheableDependencyTrait::addCacheTags public function
RefinableCacheableDependencyTrait::mergeCacheMaxAge public function
SynchronizableEntityTrait::$isSyncing protected property Whether this entity is being created, updated or deleted through a synchronization process.
SynchronizableEntityTrait::isSyncing public function
SynchronizableEntityTrait::setSyncing public function