This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Collaboration diagram for ilObjOrgUnitTree:

Public Member Functions
	getAssignements (int $ref_id, ilOrgUnitPosition $ilOrgUnitPosition)

	getAssignedUsers (array $orgu_ids, int $position_id)

	getEmployees (int $ref_id, bool $recursive=false)

	getSuperiors (int $ref_id, bool $recursive=false)

	getAllChildren (int $ref_id)

	getOrgusWhereUserHasPermissionForOperation ($operation)
	If you want to have all orgunits where the current user has the write permission: use this with the parameter "write". More...

	getOrgusWhereUserHasPermissionForOperationId (string $operation_id)
	If you want to have all orgunits where the current user has the write permission: use this with the parameter 3 (3 is the "write" permission as in rbac_operations). More...

	getAllOrgunitsOnLevelX (int $level)

	getEmployeesUnderUser (int $user_id, bool $recursive=true)

	getSuperiorsOfUser (int $user_id, bool $recursive=true)

	getLevelXOfUser (int $user_id, int $level)
	for additional info see the other getLevelX method. More...

	getOrgUnitOfUser (int $user_id)

	buildTempTableWithUsrAssignements (string $temporary_table_name='orgu_usr_assignements')
	Creates a temporary table with all orgu/user assignements. More...

	dropTempTable (string $temporary_table_name)

	getTitles (array $org_refs)

	getEmployeeRoles ()

	getSuperiorRoles ()

	flushCache ()

	getLevelXOfTreenode (int $orgu_ref, int $level)
	Specify eg. More...

	getParent (int $orgu_ref)

Static Public Member Functions
static	_getInstance ()

Protected Member Functions
	getPositionRepo ()

	getAssignmentRepo ()

Protected Attributes
ilOrgUnitPositionDBRepository	$positionRepo

ilOrgUnitUserAssignmentDBRepository	$assignmentRepo

Static Protected Attributes
static string	$temporary_table_name_getOrgUnitOfUser = null

static string	$temporary_table_name = null

static ilObjOrgUnitTree	$instance = null

Private Member Functions
	__construct ()

	loadArrayOfStaff (string $title, array $ref_ids)

	getChildren (int $ref_id)

	loadChildren (int $ref_id)

	loadRoles (string $role)

	loadRolesQuery (string $role)

	getRefIdFromRoleTitle (string $role_title)

Private Attributes
array	$roles

array	$role_to_orgu

	$staff

array	$tree_childs = []

array	$parent = []

ilDBInterface	$db

ilObjUser	$ilUser

ilTree	$tree

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilObjOrgUnitTree Implements a singleton pattern for caching.

Author: : Oskar Truffer ot@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; : Martin Studer ms@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 25 of file class.ilObjOrgUnitTree.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjOrgUnitTree::__construct ( )

private

Definition at line 46 of file class.ilObjOrgUnitTree.php.

    {
        global $DIC;
        $this->db = $DIC->database();
        $this->tree = $DIC->repositoryTree();
        $this->roles = array();
        $this->staff = array();
        $this->ilUser = $DIC->user();
    }

References $DIC.

Member Function Documentation

◆ _getInstance()

static ilObjOrgUnitTree::_getInstance ( )

static

Definition at line 56 of file class.ilObjOrgUnitTree.php.

                                         : \ilObjOrgUnitTree
    {
        if (static::$instance === null) {
            static::$instance = new self();
        }
 
        return static::$instance;
    }

Referenced by ilLikeUserOrgUnitSearch\__construct(), ilOrgUnitExtension\__construct(), ilObjOrgUnitAccess\_checkAccessToUserLearningProgress(), ilOrgUnitUserAssignmentGUI\assignmentsRecursive(), ilMStListCoursesTableGUI\fillRow(), ilMStShowUserCoursesTableGUI\fillRow(), ilOrgUnitUserAssignmentDBRepository\getOrgUnitsByUserAndPosition(), ilStudyProgrammeMembershipSourceReaderFactory\getReaderFor(), ilCourseParticipantsTableGUI\parse(), and ilGroupParticipantsTableGUI\parse().

Here is the caller graph for this function:

◆ buildTempTableWithUsrAssignements()

ilObjOrgUnitTree::buildTempTableWithUsrAssignements ( string $temporary_table_name = 'orgu_usr_assignements' )

Creates a temporary table with all orgu/user assignements.

there will be three columns in the table orgu_usr_assignements (or specified table-name): ref_id: Reference-IDs of OrgUnits user_id: Assigned User-IDs path: Path-representation of the OrgUnit Usage:

Run ilObjOrgUnitTree::getInstance()->buildTempTableWithUsrAssignements(); in your code
use the table orgu_usr_assignements for your JOINS ans SELECTS
Run ilObjOrgUnitTree::getInstance()->dropTempTable(); to throw away the table
Parameters

string $temporary_table_name

Returns
bool

Exceptions

ilException

Definition at line 411 of file class.ilObjOrgUnitTree.php.

                                                                                                             : bool
    {
        if (self::$temporary_table_name == $temporary_table_name) {
            return true;
        }
        if (self::$temporary_table_name === null) {
            $this->dropTempTable($temporary_table_name);
            self::$temporary_table_name = $temporary_table_name;
        } elseif ($temporary_table_name != self::$temporary_table_name) {
            throw new ilException('there is already a temporary table for org-unit assignement: ' . self::$temporary_table_name);
        }
 
        $q = "CREATE TEMPORARY TABLE IF NOT EXISTS " . $temporary_table_name . " AS (
                                SELECT DISTINCT object_reference.ref_id AS ref_id, il_orgu_ua.user_id AS user_id, orgu_path_storage.path AS path
                                        FROM il_orgu_ua
                    JOIN object_reference ON object_reference.ref_id = il_orgu_ua.orgu_id
                                        JOIN object_data ON object_data.obj_id = object_reference.obj_id
                                        JOIN orgu_path_storage ON orgu_path_storage.ref_id = object_reference.ref_id
                                WHERE object_data.type = 'orgu' AND object_reference.deleted IS NULL
                        );";
        $this->db->manipulate($q);
 
        return true;
    }

References $q, $temporary_table_name, and dropTempTable().

Here is the call graph for this function:

◆ dropTempTable()

ilObjOrgUnitTree::dropTempTable ( string $temporary_table_name )

Definition at line 436 of file class.ilObjOrgUnitTree.php.

                                                               : bool
    {
        if (self::$temporary_table_name === null
            || $temporary_table_name !== self::$temporary_table_name
        ) {
            return false;
        }
        $q = "DROP TABLE IF EXISTS " . $temporary_table_name;
        $this->db->manipulate($q);
 
        self::$temporary_table_name = null;
 
        return true;
    }

References $q, and $temporary_table_name.

Referenced by buildTempTableWithUsrAssignements().

Here is the caller graph for this function:

◆ flushCache()

ilObjOrgUnitTree::flushCache ( )

Definition at line 487 of file class.ilObjOrgUnitTree.php.

                                : void
    {
        $this->roles = null;
    }

◆ getAllChildren()

ilObjOrgUnitTree::getAllChildren ( int $ref_id )

Definition at line 186 of file class.ilObjOrgUnitTree.php.

                                               : array
    {
        $open = array($ref_id);
        $closed = array();
        while (count($open)) {
            $ref = array_pop($open);
            $closed[] = $ref;
            foreach ($this->getChildren($ref) as $child) {
                if (in_array($child, $open, true) === false && in_array($child, $closed, true) === false) {
                    $open[] = $child;
                }
            }
        }
 
        return $closed;
    }

References $ref_id, and getChildren().

Referenced by getEmployees(), and getSuperiors().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllOrgunitsOnLevelX()

ilObjOrgUnitTree::getAllOrgunitsOnLevelX ( int $level )

Definition at line 293 of file class.ilObjOrgUnitTree.php.

                                                      : array
    {
        $levels = array(0 => array(ilObjOrgUnit::getRootOrgRefId()));
        $current_level = 0;
        while ($current_level < $level) {
            $new_level = array();
            foreach ($levels[$current_level] as $orgu_ref) {
                $new_level = array_merge($this->getChildren($orgu_ref), $new_level);
            }
            $new_level = array_unique($new_level);
            $levels[$current_level + 1] = $new_level;
            $current_level++;
        }
 
        return $levels[$level];
    }

References getChildren(), and ilObjOrgUnit\getRootOrgRefId().

Here is the call graph for this function:

◆ getAssignedUsers()

ilObjOrgUnitTree::getAssignedUsers	(	array	$orgu_ids,
		int	$position_id
	)

Parameters

int[] $orgu_ids

Returns: int[]

Definition at line 97 of file class.ilObjOrgUnitTree.php.

                                                                       : array
    {
        return $this->getAssignmentRepo()->getUsersByOrgUnitsAndPosition($orgu_ids, $position_id);
    }

References getAssignmentRepo().

Referenced by getAssignements(), getEmployees(), getEmployeesUnderUser(), and getSuperiors().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAssignements()

ilObjOrgUnitTree::getAssignements	(	int	$ref_id,
		ilOrgUnitPosition	$ilOrgUnitPosition
	)

Deprecated:: Please use getAssignedUsers()

Definition at line 88 of file class.ilObjOrgUnitTree.php.

                                                                                      : array
    {
        return $this->getAssignedUsers([$ref_id], $ilOrgUnitPosition->getId());
    }

References getAssignedUsers(), and ilOrgUnitPosition\getId().

Here is the call graph for this function:

◆ getAssignmentRepo()

ilObjOrgUnitTree::getAssignmentRepo ( )

protected

Definition at line 75 of file class.ilObjOrgUnitTree.php.

                                          : \ilOrgUnitUserAssignmentDBRepository
    {
        if (!isset($this->assignmentRepo)) {
            $dic = \ilOrgUnitLocalDIC::dic();
            $this->assignmentRepo = $dic["repo.UserAssignments"];
        }
 
        return $this->assignmentRepo;
    }

References $assignmentRepo, $dic, and ilOrgUnitLocalDIC\dic().

Referenced by getAssignedUsers(), getEmployeesUnderUser(), and getOrgUnitOfUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getChildren()

ilObjOrgUnitTree::getChildren ( int $ref_id )

private

Definition at line 274 of file class.ilObjOrgUnitTree.php.

                                             : array
    {
        $this->loadChildren($ref_id);
        return $this->tree_childs[$ref_id];
    }

References $ref_id, and loadChildren().

Referenced by getAllChildren(), and getAllOrgunitsOnLevelX().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEmployeeRoles()

ilObjOrgUnitTree::getEmployeeRoles ( )

Returns: int[] returns an array of role_ids. orgu_ref => role_id

Definition at line 464 of file class.ilObjOrgUnitTree.php.

                                      : array
    {
        $this->loadRoles("employee");
        return $this->roles["employee"];
    }

References loadRoles().

Here is the call graph for this function:

◆ getEmployees()

ilObjOrgUnitTree::getEmployees	(	int	$ref_id,
		bool	$recursive = `false`
	)

Parameters

int	$ref_id	the reference id of the organisational unit.
bool	$recursive	if true you get the ids of the subsequent orgunits employees too

Definition at line 106 of file class.ilObjOrgUnitTree.php.

                                                                      : array
    {
        $employee_position = $this->getPositionRepo()
            ->getSingle(ilOrgUnitPosition::CORE_POSITION_EMPLOYEE, 'core_identifier')
            ->getId();
 
        if ($recursive === false) {
            return $this->getAssignedUsers(
                [$ref_id],
                $employee_position
            );
        }
 
        return $this->getAssignedUsers(
            $this->getAllChildren($ref_id),
            $employee_position
        );
    }

References ilOrgUnitPosition\CORE_POSITION_EMPLOYEE, getAllChildren(), getAssignedUsers(), and getPositionRepo().

Referenced by ilOrgUnitExtension\getEmployees().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEmployeesUnderUser()

ilObjOrgUnitTree::getEmployeesUnderUser	(	int	$user_id,
		bool	$recursive = `true`
	)

Parameters

bool $recursive if this is true subsequent orgunits of this users superior role get searched as well.

Returns: int[] returns an array of user_ids of the users which have an employee role in an orgunit of which this user's id has a superior role.

Definition at line 316 of file class.ilObjOrgUnitTree.php.

                                                                               : array
    {
        $superior_position = $this->getPositionRepo()
            ->getSingle(ilOrgUnitPosition::CORE_POSITION_SUPERIOR, 'core_identifier')
            ->getId();
        $employee_position = $this->getPositionRepo()
            ->getSingle(ilOrgUnitPosition::CORE_POSITION_EMPLOYEE, 'core_identifier')
            ->getId();
 
        $orgu_ids = $this->getAssignmentRepo()
            ->getOrgUnitsByUserAndPosition($user_id, $superior_position, $recursive);
 
        return $this->getAssignedUsers(
            $orgu_ids,
            $employee_position
        );
    }

References ilOrgUnitPosition\CORE_POSITION_EMPLOYEE, ilOrgUnitPosition\CORE_POSITION_SUPERIOR, getAssignedUsers(), getAssignmentRepo(), and getPositionRepo().

Here is the call graph for this function:

◆ getLevelXOfTreenode()

ilObjOrgUnitTree::getLevelXOfTreenode	(	int	$orgu_ref,
		int	$level
	)

Specify eg.

level 1 and it will return on which orgunit on the first level after the root node the specified orgu_ref is a subunit of. eg: 0

- 1 2
3 4 5
6 (6, 1) = 1; (4, 1) = 2; (6, 2) = 3;
Returns
int|bool ref_id of the orgu or false if not found.

Exceptions

Exception in case there's a thread of an infinite loop or if you try to fetch the third level but there are only two (e.g. you want to fetch lvl 1 but give the root node as reference).

Definition at line 527 of file class.ilObjOrgUnitTree.php.

    {
        $line = array($orgu_ref);
        $current_ref = $orgu_ref;
        while ($current_ref != ilObjOrgUnit::getRootOrgRefId()) {
            $current_ref = $this->getParent($current_ref);
            if ($current_ref) {
                $line[] = $current_ref;
            } else {
                break;
            }
            if (count($line) > 100) {
                throw new Exception("There's either a non valid call of the getLevelXOfTreenode in ilObjOrgUnitTree or your nesting of orgunits is higher than 100 units, which isn't encouraged");
            }
        }
        $line = array_reverse($line);
        if (count($line) > $level) {
            return $line[$level];
        } else {
            throw new Exception("you want to fetch level " . $level . " but the line to the length of the line is only " . count($line)
                . ". The line of the given org unit is: " . print_r($line, true));
        }
    }

References getParent(), and ilObjOrgUnit\getRootOrgRefId().

Referenced by getLevelXOfUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLevelXOfUser()

ilObjOrgUnitTree::getLevelXOfUser	(	int	$user_id,
		int	$level
	)

for additional info see the other getLevelX method.

Parameters

int $user_id

Returns: int[]

Definition at line 366 of file class.ilObjOrgUnitTree.php.

                                                             : array
    {
        $q = "SELECT object_reference.ref_id FROM rbac_ua
                                JOIN rbac_fa ON rbac_fa.rol_id = rbac_ua.rol_id
                                JOIN object_reference ON rbac_fa.parent = object_reference.ref_id
                                JOIN object_data ON object_data.obj_id = object_reference.obj_id
                        WHERE rbac_ua.usr_id = " . $this->db->quote($user_id, 'integer') . " AND object_data.type = 'orgu';";
 
        $set = $this->db->query($q);
        $orgu_ref_ids = array();
        while ($res = $this->db->fetchAssoc($set)) {
            $orgu_ref_ids[] = $res['ref_id'];
        }
        $orgus_on_level_x = array();
        foreach ($orgu_ref_ids as $orgu_ref_id) {
            try {
                $orgus_on_level_x[] = $this->getLevelXOfTreenode($orgu_ref_id, $level);
            } catch (Exception $e) {
                // this means the user is assigned to a orgu above the given level. just dont add it to the list.
            }
        }
 
        return array_unique($orgus_on_level_x);
    }

References Vendor\Package\$e, $q, $res, $user_id, and getLevelXOfTreenode().

Here is the call graph for this function:

◆ getOrgUnitOfUser()

ilObjOrgUnitTree::getOrgUnitOfUser ( int $user_id )

Returns: int[]

Definition at line 394 of file class.ilObjOrgUnitTree.php.

                                                  : array
    {
        return $this->getAssignmentRepo()->getOrgUnitsByUser($user_id);
    }

References getAssignmentRepo().

Here is the call graph for this function:

◆ getOrgusWhereUserHasPermissionForOperation()

ilObjOrgUnitTree::getOrgusWhereUserHasPermissionForOperation ( $operation )

If you want to have all orgunits where the current user has the write permission: use this with the parameter "write".

Returns: int[] ids of the org units.

Definition at line 208 of file class.ilObjOrgUnitTree.php.

                                                                          : array
    {
        /*$q = "SELECT object_data.obj_id, object_reference.ref_id, object_data.title, object_data.type, rbac_pa.ops_id, rbac_operations.ops_id as op_id FROM object_data
        INNER JOIN rbac_operations ON rbac_operations.operation = ".$this->db->quote($operation, "text")."
        INNER JOIN rbac_ua ON rbac_ua.usr_id = ".$this->db->quote($ilUser->getId(), "integer")."
        INNER JOIN rbac_pa ON rbac_pa.rol_id = rbac_ua.rol_id AND rbac_pa.ops_id LIKE CONCAT('%', rbac_operations.ops_id, '%')
        INNER JOIN rbac_fa ON rbac_fa.rol_id = rbac_ua.rol_id
        INNER JOIN tree ON tree.child = rbac_fa.parent
        INNER JOIN object_reference ON object_reference.ref_id = tree.parent
        WHERE object_data.obj_id = object_reference.obj_id AND object_data.type = 'orgu'";*/
 
        $q = "SELECT object_data.obj_id, object_reference.ref_id, object_data.title, object_data.type, rbac_pa.ops_id, rbac_operations.ops_id as op_id FROM object_data
                INNER JOIN rbac_operations ON rbac_operations.operation = " . $this->db->quote($operation, "text") . "
                INNER JOIN rbac_ua ON rbac_ua.usr_id = " . $this->db->quote($this->ilUser->getId(), "integer") . "
                INNER JOIN rbac_pa ON rbac_pa.rol_id = rbac_ua.rol_id AND rbac_pa.ops_id LIKE CONCAT('%', rbac_operations.ops_id, '%')
                INNER JOIN object_reference ON object_reference.ref_id = rbac_pa.ref_id
                WHERE object_data.obj_id = object_reference.obj_id AND object_data.type = 'orgu'";
 
        $set = $this->db->query($q);
        $orgus = [];
        while ($res = $this->db->fetchAssoc($set)) {
            //this is needed as the table rbac_operations is not in the first normal form, thus this needs some additional checkings.
            $perm_check = unserialize($res['ops_id'], ['allowed_classes' => true]);
            if (in_array($res["op_id"], $perm_check, true) === false) {
                continue;
            }
 
            $orgus[] = $res["ref_id"];
        }
 
        return $orgus;
    }

References $q, and $res.

◆ getOrgusWhereUserHasPermissionForOperationId()

ilObjOrgUnitTree::getOrgusWhereUserHasPermissionForOperationId ( string $operation_id )

If you want to have all orgunits where the current user has the write permission: use this with the parameter 3 (3 is the "write" permission as in rbac_operations).

Returns: int[] ids of the org units.

Definition at line 246 of file class.ilObjOrgUnitTree.php.

                                                                                      : array
    {
        $q = "SELECT object_data.obj_id, object_data.title, object_data.type, rbac_pa.ops_id FROM object_data
                INNER JOIN rbac_ua ON rbac_ua.usr_id = " . $this->db->quote($this->ilUser->getId(), "integer") . "
                INNER JOIN rbac_pa ON rbac_pa.rol_id = rbac_ua.rol_id AND rbac_pa.ops_id LIKE CONCAT('%', " . $this->db->quote(
            $operation_id,
            "integer"
        ) . ", '%')
                INNER JOIN rbac_fa ON rbac_fa.rol_id = rbac_ua.rol_id
                INNER JOIN tree ON tree.child = rbac_fa.parent
                INNER JOIN object_reference ON object_reference.ref_id = tree.parent
                WHERE object_data.obj_id = object_reference.obj_id AND object_data.type = 'orgu'";
 
        $set = $this->db->query($q);
        $orgus = array();
        while ($res = $this->db->fetchAssoc($set)) {
            //this is needed as the table rbac_operations is not in the first normal form, thus this needs some additional checkings.
            $perm_check = unserialize($res['ops_id'], ['allowed_classes' => true]);
            if (in_array($res["ops_id"], $perm_check, true) === false) {
                continue;
            }
 
            $orgus[] = $res["obj_id"];
        }
 
        return $orgus;
    }

References $q, and $res.

◆ getParent()

ilObjOrgUnitTree::getParent ( int $orgu_ref )

Definition at line 551 of file class.ilObjOrgUnitTree.php.

                                            : int
    {
        if (array_key_exists($orgu_ref, $this->parent) === false) {
            $this->parent[$orgu_ref] = $this->tree->getParentId($orgu_ref);
        }
 
        return $this->parent[$orgu_ref];
    }

Referenced by getLevelXOfTreenode().

Here is the caller graph for this function:

◆ getPositionRepo()

ilObjOrgUnitTree::getPositionRepo ( )

protected

Definition at line 65 of file class.ilObjOrgUnitTree.php.

                                        : \ilOrgUnitPositionDBRepository
    {
        if (!isset($this->positionRepo)) {
            $dic = \ilOrgUnitLocalDIC::dic();
            $this->positionRepo = $dic["repo.Positions"];
        }
 
        return $this->positionRepo;
    }

References $dic, $positionRepo, and ilOrgUnitLocalDIC\dic().

Referenced by getEmployees(), getEmployeesUnderUser(), and getSuperiors().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRefIdFromRoleTitle()

ilObjOrgUnitTree::getRefIdFromRoleTitle ( string $role_title )

private

Definition at line 504 of file class.ilObjOrgUnitTree.php.

                                                              : int
    {
        $array = explode("_", $role_title);
 
        return $array[count($array) - 1];
    }

Referenced by loadRolesQuery().

Here is the caller graph for this function:

◆ getSuperiorRoles()

ilObjOrgUnitTree::getSuperiorRoles ( )

Returns: int[]

Definition at line 473 of file class.ilObjOrgUnitTree.php.

                                      : array
    {
        $this->loadRoles("superior");
 
        return $this->roles["superior"];
    }

References loadRoles().

Here is the call graph for this function:

◆ getSuperiors()

ilObjOrgUnitTree::getSuperiors	(	int	$ref_id,
		bool	$recursive = `false`
	)

Parameters

int	$ref_id	the reference id of the organisational unit.
bool	$recursive	if true you get the ids of the subsequent orgunits superiors too

Returns: int[] array of user ids.

Definition at line 130 of file class.ilObjOrgUnitTree.php.

                                                                      : array
    {
        $superior_position = $this->getPositionRepo()
            ->getSingle(ilOrgUnitPosition::CORE_POSITION_SUPERIOR, 'core_identifier')
            ->getId();
 
        if ($recursive === false) {
            return $this->getAssignedUsers(
                [$ref_id],
                $superior_position
            );
        }
 
        return $this->getAssignedUsers(
            $this->getAllChildren($ref_id),
            $superior_position
        );
    }

References ilOrgUnitPosition\CORE_POSITION_SUPERIOR, getAllChildren(), getAssignedUsers(), and getPositionRepo().

Referenced by ilOrgUnitExtension\getSuperiors(), and getSuperiorsOfUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSuperiorsOfUser()

ilObjOrgUnitTree::getSuperiorsOfUser	(	int	$user_id,
		bool	$recursive = `true`
	)

Parameters

bool $recursive if this is true subsequent orgunits of this users superior role get searched as well.

Returns: int[] returns an array of user_ids of the users which have an employee role in an orgunit of which this user's id has a superior role.

Definition at line 340 of file class.ilObjOrgUnitTree.php.

                                                                            : array
    {
        //querry for all orgu where user_id is superior.
        $q = "SELECT orgu.obj_id, refr.ref_id FROM object_data orgu
                INNER JOIN object_reference refr ON refr.obj_id = orgu.obj_id
                                INNER JOIN object_data roles ON roles.title LIKE CONCAT('il_orgu_employee_',refr.ref_id) OR roles.title LIKE CONCAT('il_orgu_superior_',refr.ref_id)
                                INNER JOIN rbac_ua rbac ON rbac.usr_id = " . $this->db->quote($user_id, "integer") . " AND roles.obj_id = rbac.rol_id
                                WHERE orgu.type = 'orgu'";
        $set = $this->db->query($q);
        $orgu_ref_ids = array();
        while ($res = $this->db->fetchAssoc($set)) {
            $orgu_ref_ids[] = $res['ref_id'];
        }
        $superiors = array();
        foreach ($orgu_ref_ids as $orgu_ref_id) {
            $superiors = array_merge($superiors, $this->getSuperiors($orgu_ref_id, $recursive));
        }
 
        return $superiors;
    }

References $q, $res, $user_id, and getSuperiors().

Here is the call graph for this function:

◆ getTitles()

ilObjOrgUnitTree::getTitles ( array $org_refs )

Definition at line 451 of file class.ilObjOrgUnitTree.php.

                                              : array
    {
        $names = array();
        foreach ($org_refs as $org_unit) {
            $names[$org_unit] = ilObject::_lookupTitle(ilObject::_lookupObjId($org_unit));
        }
 
        return $names;
    }

References ilObject\_lookupObjId(), and ilObject\_lookupTitle().

Here is the call graph for this function:

◆ loadArrayOfStaff()

ilObjOrgUnitTree::loadArrayOfStaff	(	string	$title,
		array	$ref_ids
	)

private

Parameters

string	$title	"employee" or "superior"
int[]	$ref_ids	array of orgu object ref ids.

Returns: int[] user_ids

Definition at line 154 of file class.ilObjOrgUnitTree.php.

                                                                    : array
    {
        $this->loadRoles($title);
        $all_refs = $ref_ids;
        //take away ref_ids that are already loaded.
        foreach ($ref_ids as $id => $ref_id) {
            if (isset($this->staff[$title][$ref_id])) {
                unset($ref_ids[$id]);
            } else {
                $this->staff[$title][$ref_id] = array();
                $ref_ids[$id] = $this->roles[$title][$ref_id];
            }
        }
 
        //if there are still refs that need to be loaded, then do so.
        if (count($ref_ids)) {
            $q = "SELECT usr_id, rol_id FROM rbac_ua WHERE " . $this->db->in("rol_id", $ref_ids, false, "integer");
            $set = $this->db->query($q);
            while ($res = $this->db->fetchAssoc($set)) {
                $orgu_ref = $this->role_to_orgu[$title][$res["rol_id"]];
                $this->staff[$title][$orgu_ref][] = $res["usr_id"];
            }
        }
 
        //collect * users.
        $all_users = [];
        foreach ($all_refs as $ref) {
            $all_users = array_merge($all_users, $this->staff[$title][$ref]);
        }
        return $all_users;
    }

References $id, $q, $ref_id, $res, and loadRoles().

Here is the call graph for this function:

◆ loadChildren()

ilObjOrgUnitTree::loadChildren ( int $ref_id )

private

Definition at line 280 of file class.ilObjOrgUnitTree.php.

                                              : void
    {
        if (!array_key_exists($ref_id, $this->tree_childs)) {
            $children = [];
            foreach ($this->tree->getChilds($ref_id) as $child) {
                if ($child["type"] == "orgu") {
                    $children[] = $child["child"];
                }
            }
            $this->tree_childs[$ref_id] = $children;
        }
    }

References $ref_id.

Referenced by getChildren().

Here is the caller graph for this function:

◆ loadRoles()

ilObjOrgUnitTree::loadRoles ( string $role )

private

Definition at line 480 of file class.ilObjOrgUnitTree.php.

    {
        if ($this->roles[$role] == null) {
            $this->loadRolesQuery($role);
        }
    }

References loadRolesQuery().

Referenced by getEmployeeRoles(), getSuperiorRoles(), and loadArrayOfStaff().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadRolesQuery()

ilObjOrgUnitTree::loadRolesQuery ( string $role )

private

Definition at line 492 of file class.ilObjOrgUnitTree.php.

                                                 : void
    {
        $this->roles[$role] = array();
        $q = "SELECT obj_id, title FROM object_data WHERE type = 'role' AND title LIKE 'il_orgu_" . $role . "%'";
        $set = $this->db->query($q);
        while ($res = $this->db->fetchAssoc($set)) {
            $orgu_ref = $this->getRefIdFromRoleTitle($res["title"]);
            $this->roles[$role][$orgu_ref] = $res["obj_id"];
            $this->role_to_orgu[$role][$res["obj_id"]] = $orgu_ref;
        }
    }

References $q, $res, and getRefIdFromRoleTitle().

Referenced by loadRoles().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $assignmentRepo

ilOrgUnitUserAssignmentDBRepository ilObjOrgUnitTree::$assignmentRepo

protected

Definition at line 44 of file class.ilObjOrgUnitTree.php.

Referenced by getAssignmentRepo().

◆ $db

ilDBInterface ilObjOrgUnitTree::$db

private

Definition at line 40 of file class.ilObjOrgUnitTree.php.

◆ $ilUser

ilObjUser ilObjOrgUnitTree::$ilUser

private

Definition at line 41 of file class.ilObjOrgUnitTree.php.

◆ $instance

ilObjOrgUnitTree ilObjOrgUnitTree::$instance = null

staticprotected

Definition at line 29 of file class.ilObjOrgUnitTree.php.

◆ $parent

array ilObjOrgUnitTree::$parent = []

private

Definition at line 39 of file class.ilObjOrgUnitTree.php.

◆ $positionRepo

ilOrgUnitPositionDBRepository ilObjOrgUnitTree::$positionRepo

protected

Definition at line 43 of file class.ilObjOrgUnitTree.php.

Referenced by getPositionRepo().

◆ $role_to_orgu

array ilObjOrgUnitTree::$role_to_orgu

private

Definition at line 33 of file class.ilObjOrgUnitTree.php.

◆ $roles

array ilObjOrgUnitTree::$roles

private

Definition at line 31 of file class.ilObjOrgUnitTree.php.

◆ $staff

ilObjOrgUnitTree::$staff

private

Definition at line 35 of file class.ilObjOrgUnitTree.php.

◆ $temporary_table_name

string ilObjOrgUnitTree::$temporary_table_name = null

staticprotected

Definition at line 28 of file class.ilObjOrgUnitTree.php.

Referenced by buildTempTableWithUsrAssignements(), and dropTempTable().

◆ $temporary_table_name_getOrgUnitOfUser

string ilObjOrgUnitTree::$temporary_table_name_getOrgUnitOfUser = null

staticprotected

Definition at line 27 of file class.ilObjOrgUnitTree.php.

◆ $tree

ilTree ilObjOrgUnitTree::$tree

private

Definition at line 42 of file class.ilObjOrgUnitTree.php.

◆ $tree_childs

array ilObjOrgUnitTree::$tree_childs = []

private

Definition at line 37 of file class.ilObjOrgUnitTree.php.

The documentation for this class was generated from the following file:

components/ILIAS/OrgUnit/classes/class.ilObjOrgUnitTree.php

Public Member Functions

Static Public Member Functions

Protected Member Functions

Protected Attributes

Static Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getInstance()

◆ buildTempTableWithUsrAssignements()

◆ dropTempTable()

◆ flushCache()

◆ getAllChildren()

◆ getAllOrgunitsOnLevelX()

◆ getAssignedUsers()

◆ getAssignements()

◆ getAssignmentRepo()

◆ getChildren()

◆ getEmployeeRoles()

◆ getEmployees()

◆ getEmployeesUnderUser()

◆ getLevelXOfTreenode()

◆ getLevelXOfUser()

◆ getOrgUnitOfUser()

◆ getOrgusWhereUserHasPermissionForOperation()

◆ getOrgusWhereUserHasPermissionForOperationId()

◆ getParent()

◆ getPositionRepo()

◆ getRefIdFromRoleTitle()

◆ getSuperiorRoles()

◆ getSuperiors()

◆ getSuperiorsOfUser()

◆ getTitles()

◆ loadArrayOfStaff()

◆ loadChildren()

◆ loadRoles()

◆ loadRolesQuery()

Field Documentation

◆ $assignmentRepo

◆ $db

◆ $ilUser

◆ $instance

◆ $parent

◆ $positionRepo

◆ $role_to_orgu

◆ $roles

◆ $staff

◆ $temporary_table_name

◆ $temporary_table_name_getOrgUnitOfUser

◆ $tree

◆ $tree_childs