Class ilObjOrgUnitTree Implements a singleton pattern for caching. More...

Collaboration diagram for ilObjOrgUnitTree:

Public Member Functions
	getEmployees ($ref_id, $recursive=false)

	getAssignements ($ref_id, ilOrgUnitPosition $ilOrgUnitPosition)

	getSuperiors ($ref_id, $recursive=false)

	getAllChildren ($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 ($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 ($level)

	getEmployeesUnderUser ($user_id, $recursive=true)

	getSuperiorsOfUser ($user_id, $recursive=true)

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

	getOrgUnitOfUser ($user_id, $ref_id=0)
	getOrgUnitOfUser More...

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

	dropTempTable ($temporary_table_name)

	getTitles ($org_refs)

	getEmployeeRoles ()

	getSuperiorRoles ()

	flushCache ()

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

	getParent ($orgu_ref)

Static Public Member Functions
static	_getInstance ()

Static Protected Attributes
static	$temporary_table_name = null

Private Member Functions
	__construct ()

	loadStaff ($title, $ref_id)

	loadStaffRecursive ($title, $ref_id)

	loadArrayOfStaff ($title, $ref_ids)

	getChildren ($ref_id)

	loadChildren ($ref_id)

	loadRoles ($role)

	loadRolesQuery ($role)

	getRefIdFromRoleTitle ($role_title)

Private Attributes
	$roles

	$role_to_orgu

	$staff

	$tree_childs

	$parent

	$db

Static Private Attributes
static	$instance

Detailed Description

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 12 of file class.ilObjOrgUnitTree.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjOrgUnitTree::__construct ( )

private

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

References $DIC, $ilDB, and array.

     {
         global $DIC;
         $ilDB = $DIC['ilDB'];
         $tree = $DIC['tree'];
         $this->db = $ilDB;
         $this->tree = $tree;
         $this->roles = array();
         $this->staff = array();
     }

Member Function Documentation

◆ _getInstance()

static ilObjOrgUnitTree::_getInstance ( )

static

Returns

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

Referenced by ilLikeUserOrgUnitSearch\__construct(), ilOrgUnitExtension\__construct(), ilObjOrgUnitAccess\_checkAccessToUserLearningProgress(), ilOrgUnitStaffTableGUI\fillRow(), ilOrgUnitUserAssignmentQueries\getOrgUnitIdsOfUsersPosition(), ilOrgUnitPathStorage\getTextRepresentationOfOrgUnits(), ilParticipantTableGUI\initFilter(), ilMStListUsersTableGUI\initFilter(), ilGroupParticipantsTableGUI\parse(), ilCourseParticipantsTableGUI\parse(), ilOrgUnitStaffTableGUI\parseData(), ilOrgUnitUserAssignmentTableGUI\parseData(), ilOrgUnitStaffTableGUI\setRowForUser(), and ilOrgUnitPathStorage\store().

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

Here is the caller graph for this function:

◆ buildTempTableWithUsrAssignements()

ilObjOrgUnitTree::buildTempTableWithUsrAssignements ( $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

Exceptions

ilException

Parameters

string $temporary_table_name

Returns: bool

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

References $temporary_table_name, and dropTempTable().

     {
         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;
     }

Here is the call graph for this function:

◆ dropTempTable()

ilObjOrgUnitTree::dropTempTable ( $temporary_table_name )

Parameters

$temporary_table_name

Returns: bool

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

References $temporary_table_name.

Referenced by buildTempTableWithUsrAssignements().

     {
         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;
     }

Here is the caller graph for this function:

◆ flushCache()

ilObjOrgUnitTree::flushCache ( )

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

     {
         $this->roles = null;
     }

◆ getAllChildren()

ilObjOrgUnitTree::getAllChildren ( $ref_id )

Parameters

$ref_id

Returns: array

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

References array, and getChildren().

Referenced by getOrgUnitOfUser(), and loadStaffRecursive().

     {
         $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) && !in_array($child, $closed)) {
                     $open[] = $child;
                 }
             }
         }
 
         return $closed;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllOrgunitsOnLevelX()

ilObjOrgUnitTree::getAllOrgunitsOnLevelX ( $level )

Parameters

$level

Returns: array

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

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

     {
         $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];
     }

Here is the call graph for this function:

◆ getAssignements()

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

Parameters

int	$ref_id
\ilOrgUnitPosition	$ilOrgUnitPosition

Returns: array

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

References array, ilOrgUnitPosition\getId(), and ActiveRecord\where().

     {
         return ilOrgUnitUserAssignment::where(array( 'orgu_id'     => $ref_id,
                                                      'position_id' => $ilOrgUnitPosition->getId(),
         ))->getArray('id', 'user_id');
     }

Here is the call graph for this function:

◆ getChildren()

ilObjOrgUnitTree::getChildren ( $ref_id )

private

Parameters

$ref_id

Returns: int[]

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

References loadChildren().

Referenced by getAllChildren(), and getAllOrgunitsOnLevelX().

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

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 543 of file class.ilObjOrgUnitTree.php.

References loadRoles().

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

Here is the call graph for this function:

◆ getEmployees()

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

Parameters

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

Returns: int[] array of user ids.

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

References loadStaff(), and loadStaffRecursive().

Referenced by ilOrgUnitExtension\getEmployees(), and getEmployeesUnderUser().

     {
         // return $this->getAssignements($ref_id, new ilOrgUnitPosition(1));
         return array_unique(($recursive ? $this->loadStaffRecursive("employee", $ref_id) : $this->loadStaff("employee", $ref_id)));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEmployeesUnderUser()

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

Parameters

$user_id	int
$recursive	bool 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 338 of file class.ilObjOrgUnitTree.php.

References $res, array, and getEmployees().

     {
         //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_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'];
         }
         $employees = array();
         foreach ($orgu_ref_ids as $orgu_ref_id) {
             $employees = array_merge($employees, $this->getEmployees($orgu_ref_id, $recursive));
         }
 
         return $employees;
     }

Here is the call graph for this function:

◆ getLevelXOfTreenode()

ilObjOrgUnitTree::getLevelXOfTreenode	(	$orgu_ref,
		$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;

Parameters

$orgu_ref
$level

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).

Returns: int|bool ref_id of the orgu or false if not found.

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

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

Referenced by getLevelXOfUser().

     {
         $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));
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLevelXOfUser()

ilObjOrgUnitTree::getLevelXOfUser	(	$user_id,
		$level
	)

for additional info see the other getLevelX method.

Parameters

$user_id
$level

Returns: int[]

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

References $res, array, and getLevelXOfTreenode().

     {
         $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);
     }

Here is the call graph for this function:

◆ getOrgUnitOfUser()

ilObjOrgUnitTree::getOrgUnitOfUser	(	$user_id,
		$ref_id = `0`
	)

getOrgUnitOfUser

Parameters

	$user_id
int	$ref_id	if given, only OrgUnits under this ID are returned (including $ref_id)

Returns: int[]

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

References $res, array, and getAllChildren().

     {
         $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'];
         }
         $orgu_ref_ids = array_unique($orgu_ref_ids);
         if ($ref_id) {
             $childernOrgIds = $this->getAllChildren($ref_id);
             foreach ($orgu_ref_ids as $k => $refId) {
                 if (!in_array($refId, $childernOrgIds)) {
                     unset($orgu_ref_ids[$k]);
                 }
             }
         }
 
         return $orgu_ref_ids;
     }

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".

Parameters

$operation string

Returns: int[] ids of the org units.

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

References $DIC, $ilUser, $res, and array.

     {
         global $DIC;
         $ilUser = $DIC['ilUser'];
         /*$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($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 = 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']);
             if (!in_array($res["op_id"], $perm_check)) {
                 continue;
             }
 
             $orgus[] = $res["ref_id"];
         }
 
         return $orgus;
     }

◆ getOrgusWhereUserHasPermissionForOperationId()

ilObjOrgUnitTree::getOrgusWhereUserHasPermissionForOperationId ( $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).

Parameters

$operation_id

Returns: int[] ids of the org units.

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

References $DIC, $ilUser, $res, and array.

     {
         global $DIC;
         $ilUser = $DIC['ilUser'];
         $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($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']);
             if (!in_array($res["ops_id"], $perm_check)) {
                 continue;
             }
 
             $orgus[] = $res["obj_id"];
         }
 
         return $orgus;
     }

◆ getParent()

ilObjOrgUnitTree::getParent ( $orgu_ref )

Parameters

$orgu_ref int

Returns: int

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

Referenced by getLevelXOfTreenode().

     {
         if (!$this->parent[$orgu_ref]) {
             $this->parent[$orgu_ref] = $this->tree->getParentId($orgu_ref);
         }
 
         return $this->parent[$orgu_ref];
     }

Here is the caller graph for this function:

◆ getRefIdFromRoleTitle()

ilObjOrgUnitTree::getRefIdFromRoleTitle ( $role_title )

private

Parameters

$role_title

Returns: int

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

Referenced by loadRolesQuery().

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

Here is the caller graph for this function:

◆ getSuperiorRoles()

ilObjOrgUnitTree::getSuperiorRoles ( )

Returns: []

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

References loadRoles().

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

Here is the call graph for this function:

◆ getSuperiors()

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

Parameters

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

Returns: int[] array of user ids.

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

References loadStaff(), and loadStaffRecursive().

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

     {
         return array_unique(($recursive ? $this->loadStaffRecursive("superior", $ref_id) : $this->loadStaff("superior", $ref_id)));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSuperiorsOfUser()

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

Parameters

$user_id	int
$recursive	bool 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 368 of file class.ilObjOrgUnitTree.php.

References $res, array, and getSuperiors().

     {
         //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;
     }

Here is the call graph for this function:

◆ getTitles()

ilObjOrgUnitTree::getTitles ( $org_refs )

Parameters

$org_refs

Returns: array

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

References $names, ilObject\_lookupObjId(), ilObject\_lookupTitle(), and array.

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

Here is the call graph for this function:

◆ loadArrayOfStaff()

ilObjOrgUnitTree::loadArrayOfStaff	(	$title,
		$ref_ids
	)

private

Parameters

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

Returns: int[] user_ids

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

References $id, $res, $title, array, and loadRoles().

Referenced by loadStaff(), and loadStaffRecursive().

     {
         $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 = array();
         foreach ($all_refs as $ref) {
             $all_users = array_merge($all_users, $this->staff[$title][$ref]);
         }
 
         return $all_users;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadChildren()

ilObjOrgUnitTree::loadChildren ( $ref_id )

private

Parameters

$ref_id

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

References array.

Referenced by getChildren().

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

Here is the caller graph for this function:

◆ loadRoles()

ilObjOrgUnitTree::loadRoles ( $role )

private

Parameters

$role

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

References loadRolesQuery().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadRolesQuery()

ilObjOrgUnitTree::loadRolesQuery ( $role )

private

Parameters

$role

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

References $res, array, and getRefIdFromRoleTitle().

Referenced by loadRoles().

     {
         $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;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadStaff()

ilObjOrgUnitTree::loadStaff	(	$title,
		$ref_id
	)

private

Parameters

$title	string "employee" or "superior"
$ref_id	int ref id of org unit.

Returns: int[] array of user_obj ids

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

References $title, array, and loadArrayOfStaff().

Referenced by getEmployees(), and getSuperiors().

     {
         return $this->loadArrayOfStaff($title, array( $ref_id ));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadStaffRecursive()

ilObjOrgUnitTree::loadStaffRecursive	(	$title,
		$ref_id
	)

private

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

References $title, getAllChildren(), and loadArrayOfStaff().

Referenced by getEmployees(), and getSuperiors().

     {
         return $this->loadArrayOfStaff($title, $this->getAllChildren($ref_id));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

◆ $db

ilObjOrgUnitTree::$db

private

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

◆ $instance

ilObjOrgUnitTree::$instance

staticprivate

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

◆ $parent

ilObjOrgUnitTree::$parent

private

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

◆ $role_to_orgu

ilObjOrgUnitTree::$role_to_orgu

private

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

◆ $roles

ilObjOrgUnitTree::$roles

private

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

◆ $staff

ilObjOrgUnitTree::$staff

private

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

◆ $temporary_table_name

ilObjOrgUnitTree::$temporary_table_name = null

staticprotected

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

Referenced by buildTempTableWithUsrAssignements(), and dropTempTable().

◆ $tree_childs

ilObjOrgUnitTree::$tree_childs

private

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

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

Modules/OrgUnit/classes/class.ilObjOrgUnitTree.php

Public Member Functions

Static Public Member Functions

Static Protected Attributes

Private Member Functions

Private Attributes

Static Private Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _getInstance()

◆ buildTempTableWithUsrAssignements()

◆ dropTempTable()

◆ flushCache()

◆ getAllChildren()

◆ getAllOrgunitsOnLevelX()

◆ getAssignements()

◆ getChildren()

◆ getEmployeeRoles()

◆ getEmployees()

◆ getEmployeesUnderUser()

◆ getLevelXOfTreenode()

◆ getLevelXOfUser()

◆ getOrgUnitOfUser()

◆ getOrgusWhereUserHasPermissionForOperation()

◆ getOrgusWhereUserHasPermissionForOperationId()

◆ getParent()

◆ getRefIdFromRoleTitle()

◆ getSuperiorRoles()

◆ getSuperiors()

◆ getSuperiorsOfUser()

◆ getTitles()

◆ loadArrayOfStaff()

◆ loadChildren()

◆ loadRoles()

◆ loadRolesQuery()

◆ loadStaff()

◆ loadStaffRecursive()

Field Documentation

◆ $db

◆ $instance

◆ $parent

◆ $role_to_orgu

◆ $roles

◆ $staff

◆ $temporary_table_name

◆ $tree_childs