interface OgRoleInterface in Organic groups 8

Provides an interface defining an OG user 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\user\RoleInterface
    interface \Drupal\og\OgRoleInterface

Expanded class hierarchy of OgRoleInterface

All classes that implement OgRoleInterface

26 files declare their use of OgRoleInterface

AccessByOgMembershipTest.php in tests/src/Kernel/Access/AccessByOgMembershipTest.php
ActionTestBase.php in tests/src/Kernel/Action/ActionTestBase.php
DefaultRoleEventIntegrationTest.php in tests/src/Kernel/DefaultRoleEventIntegrationTest.php
DefaultRoleEventTest.php in tests/src/Unit/DefaultRoleEventTest.php
GetUserGroupsTest.php in tests/src/Kernel/Entity/GetUserGroupsTest.php

... See full list

File

src/OgRoleInterface.php, line 13

Namespace

Drupal\og

View source

interface OgRoleInterface extends RoleInterface {

  /**
   * The role name of the group non-member.
   */
  const ANONYMOUS = 'non-member';

  /**
   * The role name of the group member.
   */
  const AUTHENTICATED = 'member';

  /**
   * The role name of the group administrator.
   */
  const ADMINISTRATOR = 'administrator';

  /**
   * Role type for required roles.
   *
   * This is intended for the 'non-member' and 'member' roles. These cannot be
   * changed or deleted.
   */
  const ROLE_TYPE_REQUIRED = 'required';

  /**
   * Role type for standard roles that are editable and deletable.
   */
  const ROLE_TYPE_STANDARD = 'standard';

  /**
   * Sets the ID of the role.
   *
   * @param string $id
   *   The machine name of the role.
   *
   * @return $this
   */
  public function setId($id);

  /**
   * Returns the label.
   *
   * @return string
   *   The label.
   */
  public function getLabel();

  /**
   * Sets the label.
   *
   * @param string $label
   *   The label to set.
   *
   * @return $this
   */
  public function setLabel($label);

  /**
   * Returns the group type.
   *
   * @return string
   *   The group type.
   */
  public function getGroupType();

  /**
   * Sets the group type.
   *
   * @param string $group_type
   *   The group type to set.
   *
   * @return $this
   */
  public function setGroupType($group_type);

  /**
   * Returns the group bundle.
   *
   * @return string
   *   The group bundle.
   */
  public function getGroupBundle();

  /**
   * Sets the group bundle.
   *
   * @param string $group_bundle
   *   The group bundle to set.
   *
   * @return $this
   */
  public function setGroupBundle($group_bundle);

  /**
   * Returns the role type.
   *
   * @return string
   *   The role type. One of OgRoleInterface::ROLE_TYPE_REQUIRED or
   *   OgRoleInterface::ROLE_TYPE_STANDARD.
   */
  public function getRoleType();

  /**
   * Sets the role type.
   *
   * @param string $role_type
   *   The role type to set. One of OgRoleInterface::ROLE_TYPE_REQUIRED or
   *   OgRoleInterface::ROLE_TYPE_STANDARD.
   *
   * @return $this
   *
   * @throws \InvalidArgumentException
   *   Thrown when an invalid role type is given.
   */
  public function setRoleType($role_type);

  /**
   * Returns the role name.
   *
   * A role's name consists of the portion of the ID after the group entity type
   * ID and the group bundle ID.
   *
   * @return string
   *   The role name.
   */
  public function getName();

  /**
   * Sets the role name.
   *
   * @param string $name
   *   The role name.
   *
   * @return $this
   */
  public function setName($name);

  /**
   * Returns the role represented by the given group and role name.
   *
   * @param \Drupal\Core\Entity\EntityInterface $group
   *   The group for which to return the role.
   * @param string $name
   *   The role name for which to return the role.
   *
   * @return \Drupal\og\OgRoleInterface
   *   The role.
   */
  public static function loadByGroupAndName(EntityInterface $group, $name);

  /**
   * Returns the roles that are associated with the given group type and bundle.
   *
   * @param string $group_entity_type_id
   *   The group entity type ID.
   * @param string $group_bundle_id_id
   *   The group bundle ID.
   *
   * @return \Drupal\og\OgRoleInterface[]
   *   The roles.
   */
  public static function loadByGroupType($group_entity_type_id, $group_bundle_id_id);

  /**
   * Get a role by the group's bundle and role name.
   *
   * @param string $entity_type_id
   *   The group entity type ID.
   * @param string $bundle
   *   The group bundle name.
   * @param string $role_name
   *   The role name.
   *
   * @return \Drupal\og\OgRoleInterface|null
   *   The OG role object, or NULL if a matching role was not found.
   */
  public static function getRole($entity_type_id, $bundle, $role_name);

  /**
   * Returns if this is a default role which is required and cannot be deleted.
   *
   * @return bool
   *   True if this is a default role. False otherwise.
   */
  public function isRequired();

}

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
OgRoleInterface::ADMINISTRATOR		constant	The role name of the group administrator.
OgRoleInterface::ANONYMOUS		constant	The role name of the group non-member.
OgRoleInterface::AUTHENTICATED		constant	The role name of the group member.
OgRoleInterface::getGroupBundle	public	function	Returns the group bundle.	1
OgRoleInterface::getGroupType	public	function	Returns the group type.	1
OgRoleInterface::getLabel	public	function	Returns the label.	1
OgRoleInterface::getName	public	function	Returns the role name.	1
OgRoleInterface::getRole	public static	function	Get a role by the group's bundle and role name.	1
OgRoleInterface::getRoleType	public	function	Returns the role type.	1
OgRoleInterface::isRequired	public	function	Returns if this is a default role which is required and cannot be deleted.	1
OgRoleInterface::loadByGroupAndName	public static	function	Returns the role represented by the given group and role name.	1
OgRoleInterface::loadByGroupType	public static	function	Returns the roles that are associated with the given group type and bundle.	1
OgRoleInterface::ROLE_TYPE_REQUIRED		constant	Role type for required roles.
OgRoleInterface::ROLE_TYPE_STANDARD		constant	Role type for standard roles that are editable and deletable.
OgRoleInterface::setGroupBundle	public	function	Sets the group bundle.	1
OgRoleInterface::setGroupType	public	function	Sets the group type.	1
OgRoleInterface::setId	public	function	Sets the ID of the role.	1
OgRoleInterface::setLabel	public	function	Sets the label.	1
OgRoleInterface::setName	public	function	Sets the role name.	1
OgRoleInterface::setRoleType	public	function	Sets the role type.	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
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.
RoleInterface::getPermissions	public	function	Returns a list of permissions assigned to the role.	1
RoleInterface::getWeight	public	function	Returns the weight.	1
RoleInterface::grantPermission	public	function	Grant permissions to the role.	1
RoleInterface::hasPermission	public	function	Checks if the role has a permission.	1
RoleInterface::isAdmin	public	function	Indicates that a role has all available permissions.	1
RoleInterface::revokePermission	public	function	Revokes a permissions from the user role.	1
RoleInterface::setIsAdmin	public	function	Sets the role to be an admin role.	1
RoleInterface::setWeight	public	function	Sets the weight to the given value.	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 OgRoleInterface in Organic groups 8

Hierarchy

File

Namespace

Members

API Navigation