interface GroupRoleInterface in Group 8

Same name and namespace in other branches

2.0.x src/Entity/GroupRoleInterface.php \Drupal\group\Entity\GroupRoleInterface

Provides an interface defining a group role entity.

Hierarchy

interface \Drupal\Core\Entity\EntityInterface; interface \Drupal\Core\Config\Entity\ThirdPartySettingsInterface; interface \Drupal\Core\Entity\SynchronizableInterface
- interface \Drupal\Core\Config\Entity\ConfigEntityInterface
  - interface \Drupal\group\Entity\GroupRoleInterface

Expanded class hierarchy of GroupRoleInterface

All classes that implement GroupRoleInterface

2 files declare their use of GroupRoleInterface

GroupPermissionsRoleSpecificForm.php in src/Form/GroupPermissionsRoleSpecificForm.php
GroupRoleSynchronizerTest.php in tests/src/Unit/GroupRoleSynchronizerTest.php

File

src/Entity/GroupRoleInterface.php, line 10

Namespace

Drupal\group\Entity

View source

interface GroupRoleInterface extends ConfigEntityInterface {

  /**
   * Returns the weight.
   *
   * @return int
   *   The weight of this role.
   */
  public function getWeight();

  /**
   * Sets the weight to the given value.
   *
   * @param int $weight
   *   The desired weight.
   *
   * @return \Drupal\group\Entity\GroupRoleInterface
   *   The group role this was called on.
   */
  public function setWeight($weight);

  /**
   * Returns whether the role is tied to a group type.
   *
   * @return bool
   *   Whether the role is tied to a group type.
   */
  public function isInternal();

  /**
   * Returns whether the role is for an anonymous user.
   *
   * @return bool
   *   Whether the role is for an anonymous user.
   */
  public function isAnonymous();

  /**
   * Returns whether the role is for an outsider.
   *
   * @return bool
   *   Whether the role is for an outsider.
   */
  public function isOutsider();

  /**
   * Returns whether the role is for a member.
   *
   * @return bool
   *   Whether the role is for a member.
   */
  public function isMember();

  /**
   * Returns the group type this role belongs to.
   *
   * @return \Drupal\group\Entity\GroupTypeInterface
   *   The group type this role belongs to.
   */
  public function getGroupType();

  /**
   * Returns the ID of the group type this role belongs to.
   *
   * @return string
   *   The ID of the group type this role belongs to.
   */
  public function getGroupTypeId();

  /**
   * Returns whether the role shows up in the default permissions UI.
   *
   * @return bool
   *   Whether the role shows up in the default permissions UI.
   */
  public function inPermissionsUI();

  /**
   * Returns a list of permissions assigned to the role.
   *
   * @return array
   *   The permissions assigned to the role.
   */
  public function getPermissions();

  /**
   * Checks if the role has a permission.
   *
   * @param string $permission
   *   The permission to check for.
   *
   * @return bool
   *   TRUE if the role has the permission, FALSE if not.
   */
  public function hasPermission($permission);

  /**
   * Grants a permission to the role.
   *
   * @param string $permission
   *   The permission to grant.
   *
   * @return \Drupal\group\Entity\GroupRoleInterface
   *   The group role this was called on.
   */
  public function grantPermission($permission);

  /**
   * Grants multiple permissions to the role.
   *
   * @param string[] $permissions
   *   The permissions to grant.
   *
   * @return \Drupal\group\Entity\GroupRoleInterface
   *   The group role this was called on.
   */
  public function grantPermissions($permissions);

  /**
   * Grants all available permissions to the role.
   *
   * @return \Drupal\group\Entity\GroupRoleInterface
   *   The group role this was called on.
   */
  public function grantAllPermissions();

  /**
   * Revokes a permission from the role.
   *
   * @param string $permission
   *   The permission to revoke.
   *
   * @return \Drupal\group\Entity\GroupRoleInterface
   *   The group role this was called on.
   */
  public function revokePermission($permission);

  /**
   * Revokes multiple permissions from the role.
   *
   * @param string[] $permissions
   *   The permissions to revoke.
   *
   * @return \Drupal\group\Entity\GroupRoleInterface
   *   The group role this was called on.
   */
  public function revokePermissions($permissions);

  /**
   * Changes permissions for the role.
   *
   * This function may be used to grant and revoke multiple permissions at once.
   * For example, when a form exposes checkboxes to configure permissions for a
   * role, the form submit handler may directly pass the submitted values for the
   * checkboxes form element to this function.
   *
   * @param array $permissions
   *   (optional) An associative array, where the key holds the permission name
   *   and the value determines whether to grant or revoke that permission. Any
   *   value that evaluates to TRUE will cause the permission to be granted.
   *   Any value that evaluates to FALSE will cause the permission to be
   *   revoked.
   *   @code
   *     [
   *       'administer group' => 0,         // Revoke 'administer group'
   *       'edit group' => FALSE,           // Revoke 'edit group'
   *       'administer members' => 1,       // Grant 'administer members'
   *       'leave group' => TRUE,           // Grant 'leave group'
   *       'join group' => 'join group',    // Grant 'join group'
   *     ]
   *   @endcode
   *   Existing permissions are not changed, unless specified in $permissions.
   *
   * @return \Drupal\group\Entity\GroupRoleInterface
   *   The group role this was called on.
   */
  public function changePermissions(array $permissions = []);

}

Members

Name	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
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::link Deprecated	public	function	Deprecated way of generating a link to the entity. See toLink().	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::url Deprecated	public	function	Gets the public URL for this entity.	2
EntityInterface::urlInfo Deprecated	public	function	Gets the URL object for the entity.	2
EntityInterface::uuid	public	function	Gets the entity UUID (Universally Unique Identifier).	2
GroupRoleInterface::changePermissions	public	function	Changes permissions for the role.	1
GroupRoleInterface::getGroupType	public	function	Returns the group type this role belongs to.	1
GroupRoleInterface::getGroupTypeId	public	function	Returns the ID of the group type this role belongs to.	1
GroupRoleInterface::getPermissions	public	function	Returns a list of permissions assigned to the role.	1
GroupRoleInterface::getWeight	public	function	Returns the weight.	1
GroupRoleInterface::grantAllPermissions	public	function	Grants all available permissions to the role.	1
GroupRoleInterface::grantPermission	public	function	Grants a permission to the role.	1
GroupRoleInterface::grantPermissions	public	function	Grants multiple permissions to the role.	1
GroupRoleInterface::hasPermission	public	function	Checks if the role has a permission.	1
GroupRoleInterface::inPermissionsUI	public	function	Returns whether the role shows up in the default permissions UI.	1
GroupRoleInterface::isAnonymous	public	function	Returns whether the role is for an anonymous user.	1
GroupRoleInterface::isInternal	public	function	Returns whether the role is tied to a group type.	1
GroupRoleInterface::isMember	public	function	Returns whether the role is for a member.	1
GroupRoleInterface::isOutsider	public	function	Returns whether the role is for an outsider.	1
GroupRoleInterface::revokePermission	public	function	Revokes a permission from the role.	1
GroupRoleInterface::revokePermissions	public	function	Revokes multiple permissions from the role.	1
GroupRoleInterface::setWeight	public	function	Sets the weight to the given value.	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
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

You are here

interface GroupRoleInterface in Group 8

Hierarchy

File

Namespace

Members

API Navigation