interface OgRoleManagerInterface in Organic groups 8

Defines an interface for OG role manager.

Hierarchy

• interface \Drupal\og\OgRoleManagerInterface

1 file declares its use of OgRoleManagerInterface

GroupTypeManagerTest.php in tests/src/Unit/GroupTypeManagerTest.php

File

src/OgRoleManagerInterface.php, line 10

Namespace

Drupal\og

interface OgRoleManagerInterface {

  /**
   * Creates the roles for the given group type, based on the default roles.
   *
   * This is intended to be called after a new group type has been created.
   *
   * @param string $entity_type_id
   *   The entity type ID of the group for which to create default roles.
   * @param string $bundle_id
   *   The bundle ID of the group for which to create default roles.
   *
   * @return \Drupal\og\Entity\OgRole[]
   *   Array with the saved OG roles that were created
   */
  public function createPerBundleRoles($entity_type_id, $bundle_id);

  /**
   * Returns the default roles.
   *
   * @return \Drupal\og\Entity\OgRole[]
   *   An associative array of (unsaved) OgRole entities, keyed by role name.
   *   These are populated with the basic properties: name, label, role_type and
   *   is_admin.
   */
  public function getDefaultRoles();

  /**
   * Returns the roles which every group type requires.
   *
   * This provides the 'member' and 'non-member' roles. These are hard coded
   * because they are strictly required and should not be altered.
   *
   * @return \Drupal\og\Entity\OgRole[]
   *   An associative array of (unsaved) required OgRole entities, keyed by role
   *   name. These are populated with the basic properties: name, label and
   *   role_type.
   */
  public function getRequiredDefaultRoles();

  /**
   * Returns all the roles of a provided group.
   *
   * @param string $entity_type_id
   *   The entity type ID of the group.
   * @param string $bundle
   *   The bundle of the group.
   *
   * @return \Drupal\og\OgRoleInterface[]
   *   An array of roles indexed by their IDs.
   */
  public function getRolesByBundle($entity_type_id, $bundle);

  /**
   * Returns all the roles that have a specific permission.
   *
   * Optionally filter the roles by entity type ID and bundle.
   *
   * @param array $permissions
   *   An array of permissions that the roles must have.
   * @param string $entity_type_id
   *   (optional) The entity type ID of the group.
   * @param string $bundle
   *   (optional) The bundle of the group.
   * @param bool $require_all
   *   (optional) Whether all given permissions are required. When set to FALSE
   *   all roles that include one or more of the given permissions will be
   *   returned. Defaults to TRUE.
   *
   * @return \Drupal\og\OgRoleInterface[]
   *   An array of roles indexed by their IDs.
   */
  public function getRolesByPermissions(array $permissions, $entity_type_id = NULL, $bundle = NULL, $require_all = TRUE) : array;

  /**
   * Deletes the roles associated with a group type.
   *
   * @param string $entity_type_id
   *   The entity type ID of the group for which to delete the roles.
   * @param string $bundle_id
   *   The bundle ID of the group for which to delete the roles.
   */
  public function removeRoles($entity_type_id, $bundle_id);

}

Members

Name	Modifiers	Type	Description	Overrides
OgRoleManagerInterface::createPerBundleRoles	public	function	Creates the roles for the given group type, based on the default roles.	1
OgRoleManagerInterface::getDefaultRoles	public	function	Returns the default roles.	1
OgRoleManagerInterface::getRequiredDefaultRoles	public	function	Returns the roles which every group type requires.	1
OgRoleManagerInterface::getRolesByBundle	public	function	Returns all the roles of a provided group.	1
OgRoleManagerInterface::getRolesByPermissions	public	function	Returns all the roles that have a specific permission.	1
OgRoleManagerInterface::removeRoles	public	function	Deletes the roles associated with a group type.	1