You are here

Home » API reference » Group 8 » GroupRole.php

class GroupRole in Group 8

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

Defines the Group role configuration entity.

Plugin annotation


@ConfigEntityType(
  id = "group_role",
  label = @Translation("Group role"),
  label_singular = @Translation("group role"),
  label_plural = @Translation("group roles"),
  label_count = @PluralTranslation(
    singular = "@count group role",
    plural = "@count group roles"
  ),
  handlers = {
    "storage" = "Drupal\group\Entity\Storage\GroupRoleStorage",
    "access" = "Drupal\group\Entity\Access\GroupRoleAccessControlHandler",
    "form" = {
      "add" = "Drupal\group\Entity\Form\GroupRoleForm",
      "edit" = "Drupal\group\Entity\Form\GroupRoleForm",
      "delete" = "Drupal\group\Entity\Form\GroupRoleDeleteForm"
    },
    "route_provider" = {
      "html" = "Drupal\group\Entity\Routing\GroupRoleRouteProvider",
    },
    "list_builder" = "Drupal\group\Entity\Controller\GroupRoleListBuilder",
  },
  admin_permission = "administer group",
  config_prefix = "role",
  static_cache = TRUE,
  entity_keys = {
    "id" = "id",
    "weight" = "weight",
    "label" = "label"
  },
  links = {
    "add-form" = "/admin/group/types/manage/{group_type}/roles/add",
    "collection" = "/admin/group/types/manage/{group_type}/roles",
    "delete-form" = "/admin/group/types/manage/{group_type}/roles/{group_role}/delete",
    "edit-form" = "/admin/group/types/manage/{group_type}/roles/{group_role}",
    "permissions-form" = "/admin/group/types/manage/{group_type}/roles/{group_role}/permissions"
  },
  config_export = {
    "id",
    "label",
    "weight",
    "internal",
    "audience",
    "group_type",
    "permissions_ui",
    "permissions"
  }
)

Hierarchy

Expanded class hierarchy of GroupRole

1 file declares its use of GroupRole
GroupRoleForm.php in src/Entity/Form/GroupRoleForm.php

File

src/Entity/GroupRole.php, line 60

Namespace

Drupal\group\Entity
View source 
class GroupRole extends ConfigEntityBase implements GroupRoleInterface {

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

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

  /**
   * The weight of the group role in administrative listings.
   *
   * @var int
   */
  protected $weight;

  /**
   * Whether the group role is used internally.
   *
   * Internal roles cannot be edited or assigned directly. They do not show in
   * the list of group roles to edit or assign and do not have an individual
   * permissions page either. Examples of these are the special group roles
   * 'anonymous', 'outsider' and 'member'.
   *
   * @var bool
   */
  protected $internal = FALSE;

  /**
   * The audience the role is intended for.
   *
   * Supported values are: 'anonymous', 'outsider' or 'member'.
   *
   * @var string
   */
  protected $audience = 'member';

  /**
   * The ID of the group type this role belongs to.
   *
   * @var string
   */
  protected $group_type;

  /**
   * Whether the role shows in the default permissions UI.
   *
   * By default, group roles show on the permissions page regardless of their
   * 'internal' property. If you want to hide a group role from that UI, you can
   * do so by setting this to FALSE.
   *
   * @var bool
   */
  protected $permissions_ui = TRUE;

  /**
   * The permissions belonging to the group role.
   *
   * @var string[]
   */
  protected $permissions = [];

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

  /**
   * {@inheritdoc}
   */
  public function getWeight() {
    return $this
      ->get('weight');
  }

  /**
   * {@inheritdoc}
   */
  public function setWeight($weight) {
    $this
      ->set('weight', $weight);
    return $this;
  }

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

  /**
   * {@inheritdoc}
   */
  public function isAnonymous() {
    return $this->audience == 'anonymous';
  }

  /**
   * {@inheritdoc}
   */
  public function isOutsider() {
    return $this->audience == 'outsider';
  }

  /**
   * {@inheritdoc}
   */
  public function isMember() {

    // Instead of checking whether the audience property is set to 'member', we
    // check whether it isn't 'anonymous' or 'outsider'. Any unsupported value
    // will therefore default to 'member'.
    return !$this
      ->isAnonymous() && !$this
      ->isOutsider();
  }

  /**
   * {@inheritdoc}
   */
  public function getGroupType() {
    return GroupType::load($this->group_type);
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function hasPermission($permission) {
    return in_array($permission, $this->permissions);
  }

  /**
   * {@inheritdoc}
   */
  public function grantPermission($permission) {
    return $this
      ->grantPermissions([
      $permission,
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function grantPermissions($permissions) {
    $this->permissions = array_unique(array_merge($this->permissions, $permissions));
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function grantAllPermissions() {
    $permissions = $this
      ->getPermissionHandler()
      ->getPermissionsByGroupType($this
      ->getGroupType());
    foreach ($permissions as $permission => $info) {
      if (!in_array($this->audience, $info['allowed for'])) {
        unset($permissions[$permission]);
      }
    }
    return $this
      ->grantPermissions(array_keys($permissions));
  }

  /**
   * {@inheritdoc}
   */
  public function revokePermission($permission) {
    return $this
      ->revokePermissions([
      $permission,
    ]);
  }

  /**
   * {@inheritdoc}
   */
  public function revokePermissions($permissions) {
    $this->permissions = array_diff($this->permissions, $permissions);
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function changePermissions(array $permissions = []) {

    // Grant new permissions to the role.
    $grant = array_filter($permissions);
    if (!empty($grant)) {
      $this
        ->grantPermissions(array_keys($grant));
    }

    // Revoke permissions from the role.
    $revoke = array_diff_assoc($permissions, $grant);
    if (!empty($revoke)) {
      $this
        ->revokePermissions(array_keys($revoke));
    }
    return $this;
  }

  /**
   * Returns the group permission handler.
   *
   * @return \Drupal\group\Access\GroupPermissionHandler
   *   The group permission handler.
   */
  protected function getPermissionHandler() {
    return \Drupal::service('group.permissions');
  }

  /**
   * {@inheritdoc}
   */
  protected function urlRouteParameters($rel) {
    $uri_route_parameters = parent::urlRouteParameters($rel);
    $uri_route_parameters['group_type'] = $this
      ->getGroupTypeId();
    return $uri_route_parameters;
  }

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    parent::calculateDependencies();
    $this
      ->addDependency('config', $this
      ->getGroupType()
      ->getConfigDependencyName());
  }

  /**
   * {@inheritdoc}
   */
  public static function postLoad(EntityStorageInterface $storage, array &$entities) {
    parent::postLoad($storage, $entities);

    // Sort the queried roles by their weight.
    // See \Drupal\Core\Config\Entity\ConfigEntityBase::sort().
    uasort($entities, 'static::sort');
  }

  /**
   * {@inheritdoc}
   */
  public function preSave(EntityStorageInterface $storage) {
    parent::preSave($storage);
    if (!isset($this->weight) && ($group_roles = $storage
      ->loadMultiple())) {

      // Set a role weight to make this new role last.
      $max = array_reduce($group_roles, function ($max, $group_role) {
        return $max > $group_role->weight ? $max : $group_role->weight;
      });
      $this->weight = $max + 1;
    }
    if (!$this
      ->isSyncing()) {

      // Permissions are always ordered alphabetically to avoid conflicts in the
      // exported configuration.
      sort($this->permissions);
    }
  }

}

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::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
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::postDelete public static function Acts on deleted entities before the delete hook is invoked. Overrides EntityInterface::postDelete 16
EntityBase::postSave public function Acts on a saved entity before the insert or update hook is invoked. Overrides EntityInterface::postSave 14
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::uuid public function Gets the entity UUID (Universally Unique Identifier). Overrides EntityInterface::uuid 1
EntityBase::uuidGenerator protected function Gets the UUID generator.
GroupRole::$audience protected property The audience the role is intended for.
GroupRole::$group_type protected property The ID of the group type this role belongs to.
GroupRole::$id protected property The machine name of the group role.
GroupRole::$internal protected property Whether the group role is used internally.
GroupRole::$label protected property The human-readable name of the group role.
GroupRole::$permissions protected property The permissions belonging to the group role.
GroupRole::$permissions_ui protected property Whether the role shows in the default permissions UI.
GroupRole::$weight protected property The weight of the group role in administrative listings.
GroupRole::calculateDependencies public function Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase::calculateDependencies
GroupRole::changePermissions public function Changes permissions for the role. Overrides GroupRoleInterface::changePermissions
GroupRole::getGroupType public function Returns the group type this role belongs to. Overrides GroupRoleInterface::getGroupType
GroupRole::getGroupTypeId public function Returns the ID of the group type this role belongs to. Overrides GroupRoleInterface::getGroupTypeId
GroupRole::getPermissionHandler protected function Returns the group permission handler.
GroupRole::getPermissions public function Returns a list of permissions assigned to the role. Overrides GroupRoleInterface::getPermissions
GroupRole::getWeight public function Returns the weight. Overrides GroupRoleInterface::getWeight
GroupRole::grantAllPermissions public function Grants all available permissions to the role. Overrides GroupRoleInterface::grantAllPermissions
GroupRole::grantPermission public function Grants a permission to the role. Overrides GroupRoleInterface::grantPermission
GroupRole::grantPermissions public function Grants multiple permissions to the role. Overrides GroupRoleInterface::grantPermissions
GroupRole::hasPermission public function Checks if the role has a permission. Overrides GroupRoleInterface::hasPermission
GroupRole::id public function Gets the identifier. Overrides EntityBase::id
GroupRole::inPermissionsUI public function Returns whether the role shows up in the default permissions UI. Overrides GroupRoleInterface::inPermissionsUI
GroupRole::isAnonymous public function Returns whether the role is for an anonymous user. Overrides GroupRoleInterface::isAnonymous
GroupRole::isInternal public function Returns whether the role is tied to a group type. Overrides GroupRoleInterface::isInternal
GroupRole::isMember public function Returns whether the role is for a member. Overrides GroupRoleInterface::isMember
GroupRole::isOutsider public function Returns whether the role is for an outsider. Overrides GroupRoleInterface::isOutsider
GroupRole::postLoad public static function Acts on loaded entities. Overrides EntityBase::postLoad
GroupRole::preSave public function Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBase::preSave
GroupRole::revokePermission public function Revokes a permission from the role. Overrides GroupRoleInterface::revokePermission
GroupRole::revokePermissions public function Revokes multiple permissions from the role. Overrides GroupRoleInterface::revokePermissions
GroupRole::setWeight public function Sets the weight to the given value. Overrides GroupRoleInterface::setWeight
GroupRole::urlRouteParameters protected function Gets an array of placeholders for this entity. Overrides EntityBase::urlRouteParameters
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