contacts-8.x-1.x-dev/modules/crm_tools/src/AdvancedRoleStorageInterface.php

<?php

namespace Drupal\crm_tools;

use Drupal\user\RoleStorageInterface;

/**
 * Defines an interface for role entity storage classes.
 */
interface AdvancedRoleStorageInterface extends RoleStorageInterface {

  /**
   * Finds all parents of a given role ID.
   *
   * @param int $id
   *   Role ID to retrieve parents for.
   *
   * @return \Drupal\user\RoleInterface[]
   *   An array of roles which are the parents of the role $id.
   */
  public function loadParents($id);

  /**
   * Finds all ancestors of a given role ID.
   *
   * @param int $id
   *   Role ID to retrieve ancestors for.
   *
   * @return \Drupal\user\RoleInterface[]
   *   An array of role objects which are the ancestors of the role $id.
   */
  public function loadAllParents($id);

  /**
   * Finds all children of a role ID.
   *
   * @param int $id
   *   Role ID to retrieve children for.
   *
   * @return \Drupal\user\RoleInterface[]
   *   An array of role objects that are the children of the role $id.
   */
  public function loadChildren($id);

  /**
   * Finds all descendants of a given role ID.
   *
   * @param int $id
   *   Role ID to retrieve descendants for.
   *
   * @return \Drupal\user\RoleInterface[]
   *   An array of role objects which are the descendants of the role $id.
   */
  public function loadAllChildren($id);

  /**
   * Finds all roles and orders tree.
   *
   * @param int $parent
   *   The role ID under which to generate the tree. If 0, generate the tree
   *   for the all roles.
   * @param int $max_depth
   *   The number of levels of the tree to return. Leave NULL to return all
   *   levels.
   * @param bool $keyed
   *   Whether to key returned array by role ids. Defaults to false.
   *
   * @return \Drupal\user\RoleInterface[]
   *   An array of role objects that are the children the parent role.
   */
  public function loadTree($parent = 0, $max_depth = NULL, $keyed = FALSE);

}