class Role in Drupal 10

Defines the user role entity class.

Plugin annotation

@ConfigEntityType(
  id = "user_role",
  label = @Translation("Role"),
  label_collection = @Translation("Roles"),
  label_singular = @Translation("role"),
  label_plural = @Translation("roles"),
  label_count = @PluralTranslation(
    singular = "@count role",
    plural = "@count roles",
  ),
  handlers = {
    "storage" = "Drupal\user\RoleStorage",
    "access" = "Drupal\user\RoleAccessControlHandler",
    "list_builder" = "Drupal\user\RoleListBuilder",
    "form" = {
      "default" = "Drupal\user\RoleForm",
      "delete" = "Drupal\Core\Entity\EntityDeleteForm"
    }
  },
  admin_permission = "administer permissions",
  config_prefix = "role",
  static_cache = TRUE,
  entity_keys = {
    "id" = "id",
    "weight" = "weight",
    "label" = "label"
  },
  links = {
    "delete-form" = "/admin/people/roles/manage/{user_role}/delete",
    "edit-form" = "/admin/people/roles/manage/{user_role}",
    "edit-permissions-form" = "/admin/people/permissions/{user_role}",
    "collection" = "/admin/people/roles",
  },
  config_export = {
    "id",
    "label",
    "weight",
    "is_admin",
    "permissions",
  }
)

Hierarchy

• class \Drupal\Core\Entity\EntityBase implements EntityInterface uses RefinableCacheableDependencyTrait, DependencySerializationTrait
  • class \Drupal\Core\Config\Entity\ConfigEntityBase implements ConfigEntityInterface uses SynchronizableEntityTrait, PluginDependencyTrait
    • class \Drupal\user\Entity\Role implements RoleInterface

88 files declare their use of Role

BasicAuthTest.php in core/modules/basic_auth/tests/src/Functional/BasicAuthTest.php

BlockContentAccessHandlerTest.php in core/modules/block_content/tests/src/Kernel/BlockContentAccessHandlerTest.php

BlockTest.php in core/modules/block/tests/src/Functional/BlockTest.php

BrowserTestBaseTest.php in core/tests/Drupal/FunctionalTests/BrowserTestBaseTest.php

CacheContextOptimizationTest.php in core/tests/Drupal/KernelTests/Core/Cache/CacheContextOptimizationTest.php

... See full list

9 string references to 'Role'

ChangeUserRoleBase::buildConfigurationForm in core/modules/user/src/Plugin/Action/ChangeUserRoleBase.php

filter.schema.yml in core/modules/filter/config/schema/filter.schema.yml

core/modules/filter/config/schema/filter.schema.yml

Role::buildOptionsForm in core/modules/user/src/Plugin/views/access/Role.php

Provide a form to edit options for this plugin.

user.schema.yml in core/modules/user/config/schema/user.schema.yml

core/modules/user/config/schema/user.schema.yml

user.views.schema.yml in core/modules/user/config/schema/user.views.schema.yml

core/modules/user/config/schema/user.views.schema.yml

... See full list

File

core/modules/user/src/Entity/Role.php, line 54

Namespace

Drupal\user\Entity

class Role extends ConfigEntityBase implements RoleInterface {

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

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

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

  /**
   * The permissions belonging to this role.
   *
   * @var array
   */
  protected $permissions = [];

  /**
   * An indicator whether the role has all permissions.
   *
   * @var bool
   */
  protected $is_admin;

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

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

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

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

  /**
   * {@inheritdoc}
   */
  public function grantPermission($permission) {
    if ($this
      ->isAdmin()) {
      return $this;
    }
    if (!$this
      ->hasPermission($permission)) {
      $this->permissions[] = $permission;
    }
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function revokePermission($permission) {
    if ($this
      ->isAdmin()) {
      return $this;
    }
    $this->permissions = array_diff($this->permissions, [
      $permission,
    ]);
    return $this;
  }

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

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

  /**
   * {@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::class,
      'sort',
    ]);
  }

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

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

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

  /**
   * {@inheritdoc}
   */
  public function calculateDependencies() {
    parent::calculateDependencies();

    // Load all permission definitions.
    $permission_definitions = \Drupal::service('user.permissions')
      ->getPermissions();
    $valid_permissions = array_intersect($this->permissions, array_keys($permission_definitions));
    $invalid_permissions = array_diff($this->permissions, $valid_permissions);
    if (!empty($invalid_permissions) && !$this
      ->get('skip_missing_permission_deprecation')) {
      throw new \RuntimeException('Adding non-existent permissions to a role is not allowed. The incorrect permissions are "' . implode('", "', $invalid_permissions) . '".');
    }
    foreach ($valid_permissions as $permission) {

      // Depend on the module that is providing this permissions.
      $this
        ->addDependency('module', $permission_definitions[$permission]['provider']);

      // Depend on any other dependencies defined by permissions granted to
      // this role.
      if (!empty($permission_definitions[$permission]['dependencies'])) {
        $this
          ->addDependencies($permission_definitions[$permission]['dependencies']);
      }
    }
    return $this;
  }

  /**
   * {@inheritdoc}
   */
  public function onDependencyRemoval(array $dependencies) {
    $changed = parent::onDependencyRemoval($dependencies);

    // Load all permission definitions.
    $permission_definitions = \Drupal::service('user.permissions')
      ->getPermissions();

    // Convert config and content entity dependencies to a list of names to make
    // it easier to check.
    foreach ([
      'content',
      'config',
    ] as $type) {
      $dependencies[$type] = array_keys($dependencies[$type]);
    }

    // Remove any permissions from the role that are dependent on anything being
    // deleted or uninstalled.
    foreach ($this->permissions as $key => $permission) {
      if (!isset($permission_definitions[$permission])) {

        // If the permission is not defined then there's nothing we can do.
        continue;
      }
      if (in_array($permission_definitions[$permission]['provider'], $dependencies['module'], TRUE)) {
        unset($this->permissions[$key]);
        $changed = TRUE;

        // Process the next permission.
        continue;
      }
      if (isset($permission_definitions[$permission]['dependencies'])) {
        foreach ($permission_definitions[$permission]['dependencies'] as $type => $list) {
          if (array_intersect($list, $dependencies[$type])) {
            unset($this->permissions[$key]);
            $changed = TRUE;

            // Process the next permission.
            continue 2;
          }
        }
      }
    }
    return $changed;
  }

}

Members

Name	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
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::preDelete	public static	function	Acts on entities before they are deleted and before hooks are invoked. Overrides EntityBase::preDelete	6
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::__construct	public	function	Constructs an Entity object. Overrides EntityBase::__construct	6
ConfigEntityBase::__sleep	public	function	Overrides EntityBase::__sleep	3
DependencySerializationTrait::$_entityStorages	protected	property
DependencySerializationTrait::$_serviceIds	protected	property
DependencySerializationTrait::__sleep	public	function	Aliased as: traitSleep	2
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		1
EntityBase::bundle	public	function		1
EntityBase::create	public static	function		1
EntityBase::delete	public	function		2
EntityBase::enforceIsNew	public	function
EntityBase::entityTypeBundleInfo	protected	function	Gets the entity type bundle info service.
EntityBase::entityTypeManager	protected	function	Gets the entity type manager.
EntityBase::getCacheContexts	public	function
EntityBase::getCacheMaxAge	public	function
EntityBase::getCacheTags	public	function
EntityBase::getConfigDependencyKey	public	function
EntityBase::getEntityType	public	function
EntityBase::getEntityTypeId	public	function
EntityBase::getListCacheTagsToInvalidate	protected	function	The list cache tags to invalidate for this entity.
EntityBase::getTypedData	public	function
EntityBase::getTypedDataClass	private	function	Returns the typed data class name for this entity.
EntityBase::hasLinkTemplate	public	function
EntityBase::id	public	function		10
EntityBase::label	public	function		5
EntityBase::language	public	function		1
EntityBase::languageManager	protected	function	Gets the language manager.
EntityBase::linkTemplates	protected	function	Gets an array link templates.
EntityBase::load	public static	function
EntityBase::loadMultiple	public static	function
EntityBase::postCreate	public	function		4
EntityBase::postDelete	public static	function		12
EntityBase::postSave	public	function		13
EntityBase::preCreate	public static	function		5
EntityBase::referencedEntities	public	function		1
EntityBase::toLink	public	function
EntityBase::uriRelationships	public	function
EntityBase::urlRouteParameters	protected	function	Gets an array of placeholders for this entity.	1
EntityBase::uuid	public	function		1
EntityBase::uuidGenerator	protected	function	Gets the UUID generator.
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
RefinableCacheableDependencyTrait::addCacheContexts	public	function
RefinableCacheableDependencyTrait::addCacheTags	public	function
RefinableCacheableDependencyTrait::mergeCacheMaxAge	public	function
Role::$id	protected	property	The machine name of this role.
Role::$is_admin	protected	property	An indicator whether the role has all permissions.
Role::$label	protected	property	The human-readable label of this role.
Role::$permissions	protected	property	The permissions belonging to this role.
Role::$weight	protected	property	The weight of this role in administrative listings.
Role::calculateDependencies	public	function	Calculates dependencies and stores them in the dependency property. Overrides ConfigEntityBase::calculateDependencies
Role::getPermissions	public	function	Returns a list of permissions assigned to the role. Overrides RoleInterface::getPermissions
Role::getWeight	public	function	Returns the weight. Overrides RoleInterface::getWeight
Role::grantPermission	public	function	Grant permissions to the role. Overrides RoleInterface::grantPermission
Role::hasPermission	public	function	Checks if the role has a permission. Overrides RoleInterface::hasPermission
Role::isAdmin	public	function	Indicates that a role has all available permissions. Overrides RoleInterface::isAdmin
Role::onDependencyRemoval	public	function	Informs the entity that entities it depends on will be deleted. Overrides ConfigEntityBase::onDependencyRemoval
Role::postLoad	public static	function	Acts on loaded entities. Overrides EntityBase::postLoad
Role::preSave	public	function	Acts on an entity before the presave hook is invoked. Overrides ConfigEntityBase::preSave
Role::revokePermission	public	function	Revokes a permissions from the user role. Overrides RoleInterface::revokePermission
Role::setIsAdmin	public	function	Sets the role to be an admin role. Overrides RoleInterface::setIsAdmin
Role::setWeight	public	function	Sets the weight to the given value. Overrides RoleInterface::setWeight
RoleInterface::ANONYMOUS_ID		constant	Role ID for anonymous users; should match the 'role' entity ID.
RoleInterface::AUTHENTICATED_ID		constant	Role ID for authenticated users; should match the 'role' entity ID.
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