Inheritance diagram for ilObjOrgUnit:

Collaboration diagram for ilObjOrgUnit:

Public Member Functions
	__construct ($a_id=0, $a_call_by_reference=true)

	create ()

	update ()

	getOrgUnitTypeId ()

	getOrgUnitType ()

	setOrgUnitTypeId ($a_id)

	assignUsersToEmployeeRole ($user_ids)

	assignUsersToSuperiorRole ($user_ids)

	deassignUserFromEmployeeRole ($user_id)

	deassignUserFromSuperiorRole ($user_id)

	assignUserToLocalRole ($role_id, $user_id)
	Assign a given user to a given local role. More...

	deassignUserFromLocalRole ($role_id, $user_id)
	Deassign a given user to a given local role. More...

	setEmployeeRole ($employee_role)

	getEmployeeRole ()

	setSuperiorRole ($superior_role)

	getSuperiorRole ()

	initDefaultRoles ()

	getTitle ()
	Return title. More...

	getLongDescription ()
	get object long description (stored in object_description) More...

	getTranslations ()

	delete ()
	delete category and all related data More...

	removeTranslations ()

	deleteTranslation ($a_lang)

	addTranslation ($a_title, $a_desc, $a_lang, $a_lang_default)

	updateTranslation ($a_title, $a_desc, $a_lang, $a_lang_default)

Public Member Functions inherited from ilContainer
	ilContainer ($a_id=0, $a_call_by_reference=true)
	Constructor public. More...

	createContainerDirectory ()
	Create directory for the container. More...

	getContainerDirectory ()
	Get the container directory. More...

	_getContainerDirectory ($a_id)
	Get the container directory. More...

	getBigIconPath ()
	Get path for big icon. More...

	getSmallIconPath ()
	Get path for small icon. More...

	getTinyIconPath ()
	Get path for tiny icon. More...

	getCustomIconPath ()
	Get path for custom icon. More...

	setHiddenFilesFound ($a_hiddenfilesfound)
	Set Found hidden files (set by getSubItems). More...

	getHiddenFilesFound ()
	Get Found hidden files (set by getSubItems). More...

	getStyleSheetId ()
	get ID of assigned style sheet object More...

	setStyleSheetId ($a_style_id)
	set ID of assigned style sheet object More...

	_lookupContainerSetting ($a_id, $a_keyword, $a_default_value=NULL)
	Lookup a container setting. More...

	_writeContainerSetting ($a_id, $a_keyword, $a_value)

	_lookupIconPath ($a_id, $a_size="big")
	lookup icon path More...

	saveIcons ($a_custom_icon)
	save container icons More...

	removeCustomIcon ()
	remove small icon More...

	cloneObject ($a_target_id, $a_copy_id=0)
	Clone container settings. More...

	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies (container sorting) More...

	cloneAllObject ($session_id, $client_id, $new_type, $ref_id, $clone_source, $options, $soap_call=false, $a_submode=1)
	clone all objects according to this container More...

	getViewMode ()
	Get container view mode. More...

	getOrderType ()
	Get order type default implementation. More...

	setOrderType ($a_value)

	getSubItems ($a_admin_panel_enabled=false, $a_include_side_block=false, $a_get_single=0)
	Get subitems of container. More...

	gotItems ()
	Check whether we got any items. More...

	addAdditionalSubItemInformation (&$object)
	Add additional information to sub item, e.g. More...

	getGroupedObjTypes ()
	Get grouped repository object types. More...

	enablePageEditing ()
	Check whether page editing is allowed for container. More...

	create ()
	Create. More...

	update ()
	Update. More...

	read ()
	read More...

Public Member Functions inherited from ilObject
	ilObject ($a_id=0, $a_reference=true)
	Constructor public. More...

	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not) More...

	read ($a_force_db=false)
	read object data from db into object More...

	getId ()
	get object id public More...

	setId ($a_id)
	set object id public More...

	setRefId ($a_id)
	set reference id public More...

	getRefId ()
	get reference id public More...

	getType ()
	get object type public More...

	setType ($a_type)
	set object type public More...

	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions More...

	getTitle ()
	get object title public More...

	getUntranslatedTitle ()
	get untranslated object title public More...

	setTitle ($a_title)
	set object title More...

	getDescription ()
	get object description More...

	setDescription ($a_desc)
	set object description More...

	getLongDescription ()
	get object long description (stored in object_description) More...

	getImportId ()
	get import id More...

	setImportId ($a_import_id)
	set import id More...

	getOwner ()
	get object owner More...

	getOwnerName ()

	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...

	setOwner ($a_owner)
	set object owner More...

	getCreateDate ()
	get create date public More...

	getLastUpdateDate ()
	get last update date public More...

	getDiskUsage ()
	Gets the disk usage of the object in bytes. More...

	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class) More...

	create ()
	create More...

	update ()
	update object in db More...

	MDUpdateListener ($a_element)
	Meta data update listener. More...

	createMetaData ()
	create meta data entry More...

	updateMetaData ()
	update meta data entry More...

	deleteMetaData ()
	delete meta data entry More...

	updateOwner ()
	update owner of object in db More...

	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

	_lookupOwner ($a_id)
	lookup object owner More...

	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...

	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...

	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree More...

	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...

	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...

	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...

	_isInTrash ($a_ref_id)
	checks wether object is in trash More...

	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...

	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...

	putInTree ($a_parent_ref)
	maybe this method should be in tree object!? More...

	setPermissions ($a_parent_ref)
	set permissions of object More...

	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...

	createReference ()
	creates reference for object More...

	countReferences ()
	count references of object More...

	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...

	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) public More...

	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...

	notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
	notifys an object about an event occured Based on the event passed, each object may decide how it reacts. More...

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	getXMLZip ()

	getHTMLDirectory ()

	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	Clone object permissions, put in tree ... More...

	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...

	cloneMetaData ($target_obj)
	Copy meta data. More...

	_lookupCreationDate ($a_id)
	Lookup creation date. More...

	getPossibleSubObjects ($a_filter=true)
	get all possible subobjects of this type the object can decide which types of subobjects are possible jut in time overwrite if the decision distinguish from standard model More...

Static Public Member Functions
static	getRootOrgRefId ()

static	getRootOrgId ()

static	_exists ($a_id, $a_reference=false)

Static Public Member Functions inherited from ilContainer
static	_getContainerSettings ($a_id)

static	_deleteContainerSettings ($a_id, $a_keyword=null, $a_keyword_like=false)

static	_exportContainerSettings (ilXmlWriter $a_xml, $a_obj_id)

static	getCompleteDescriptions (array $objects)
	overwrites description fields to long or short description in an assoc array keys needed (obj_id and description) More...

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupImportId ($a_obj_id)

static	_getAllReferences ($a_id)
	get all reference ids of object More...

static	_lookupTitle ($a_id)
	lookup object title More...

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)
	lookup object description More...

static	_lookupObjId ($a_id)

static	setDeletedDates ($a_ref_ids)
	Set deleted date type $ilDB. More...

static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...

static	_lookupObjectId ($a_ref_id)
	lookup object id More...

static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...

static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection. More...

static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $a_obj_ids)
	Get long description data. More...

static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns. More...

static	fixMissingTitles ($a_type, array &$a_obj_title_map)
	Try to fix missing object titles. More...

static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

Data Fields
const	TABLE_NAME = 'orgu_data'

Data Fields inherited from ilContainer
const	VIEW_SESSIONS = 0

const	VIEW_OBJECTIVE = 1

const	VIEW_TIMING = 2

const	VIEW_ARCHIVE = 3

const	VIEW_SIMPLE = 4

const	VIEW_BY_TYPE = 5

const	VIEW_INHERIT = 6

const	VIEW_DEFAULT = self::VIEW_BY_TYPE

const	SORT_TITLE = 0

const	SORT_MANUAL = 1

const	SORT_ACTIVATION = 2

const	SORT_INHERIT = 3

const	SORT_CREATION = 4

const	SORT_DIRECTION_ASC = 0

const	SORT_DIRECTION_DESC = 1

const	SORT_NEW_ITEMS_POSITION_TOP = 0

const	SORT_NEW_ITEMS_POSITION_BOTTOM = 1

const	SORT_NEW_ITEMS_ORDER_TITLE = 0

const	SORT_NEW_ITEMS_ORDER_CREATION = 1

const	SORT_NEW_ITEMS_ORDER_ACTIVATION = 2

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...

const	DESC_LENGTH = 128

	$ilias

	$lng

	$id

	$ref_id

	$type

	$title

	$untranslatedTitle

	$desc

	$long_desc

	$owner

	$create_date

	$last_update

	$import_id

	$register = false

	$referenced

	$objectList

	$max_title

	$max_desc

	$add_dots

	$obj_data_record
	object_data record More...

Protected Attributes
	$employee_role

	$superior_role

	$orgu_type_id = 0

	$amd_data

Protected Attributes inherited from ilContainer
	$order_type = 0

	$hiddenfilesfound = false

Static Protected Attributes
static	$root_ref_id

static	$root_id

static	$icons_cache

Private Member Functions
	loadRoles ()

	doLoadRoles ()

Static Private Member Functions
static	loadRootOrgRefIdAndId ()

Additional Inherited Members
Static Public Attributes inherited from ilContainer
static	$data_preloaded = false

Detailed Description

Class ilObjOrgUnit.

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; : Stefan Wanzenried sw@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch; : Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

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

Constructor & Destructor Documentation

◆ __construct()

ilObjOrgUnit::__construct	(	$a_id = `0`,
		$a_call_by_reference = `true`
	)

Parameters

int	$a_id
bool	$a_call_by_reference

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

References $ilDB, ilObject\getId(), ilContainer\ilContainer(), ilContainer\read(), and setOrgUnitTypeId().

                                                                             {
                 $this->type = "orgu";
                 $this->ilContainer($a_id, $a_call_by_reference);
         }

Here is the call graph for this function:

Member Function Documentation

◆ _exists()

static ilObjOrgUnit::_exists	(	$a_id,
		$a_reference = `false`
	)

static

Definition at line 396 of file class.ilObjOrgUnit.php.

Referenced by ilOrgUnitImporter\buildRef().

                                                                     {
                 return parent::_exists($a_id, $a_reference, "orgu");
         }

Here is the caller graph for this function:

◆ addTranslation()

ilObjOrgUnit::addTranslation	(	$a_title,
		$a_desc,
		$a_lang,
		$a_lang_default
	)

Definition at line 585 of file class.ilObjOrgUnit.php.

References $ilDB, $query, $res, and ilObject\getId().

Referenced by getTranslations().

                                                                              {
                 global $ilDB;
 
                 if (empty($a_title)) {
                         $a_title = "NO TITLE";
                 }
 
                 $query = "INSERT INTO object_translation "
                          . "(obj_id,title,description,lang_code,lang_default) " . "VALUES " . "("
                          . $ilDB->quote($this->getId(), 'integer') . "," . $ilDB->quote($a_title, 'text')
                          . "," . $ilDB->quote($a_desc, 'text') . "," . $ilDB->quote($a_lang, 'text') . ","
                          . $ilDB->quote($a_lang_default, 'integer') . ")";
                 $res = $ilDB->manipulate($query);
 
                 return true;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ assignUsersToEmployeeRole()

ilObjOrgUnit::assignUsersToEmployeeRole ( $user_ids )

Definition at line 270 of file class.ilObjOrgUnit.php.

References getEmployeeRole(), ilObject\getId(), and ilObject\getRefId().

                                                              {
                 global $rbacadmin, $ilAppEventHandler;
                 foreach ($user_ids as $user_id) {
                         $rbacadmin->assignUser($this->getEmployeeRole(), $user_id);
 
                         $ilAppEventHandler->raise('Modules/OrgUnit', 'assignUsersToEmployeeRole', array(
                                 'object'  => $this,
                                 'obj_id'  => $this->getId(),
                                 'ref_id'  => $this->getRefId(),
                                 'role_id' => $this->getEmployeeRole(),
                                 'user_id' => $user_id,
                         ));
                 }
         }

Here is the call graph for this function:

◆ assignUsersToSuperiorRole()

ilObjOrgUnit::assignUsersToSuperiorRole ( $user_ids )

Definition at line 286 of file class.ilObjOrgUnit.php.

References ilObject\getId(), ilObject\getRefId(), and getSuperiorRole().

                                                              {
                 global $rbacadmin, $ilAppEventHandler;
                 foreach ($user_ids as $user_id) {
                         $rbacadmin->assignUser($this->getSuperiorRole(), $user_id);
 
                         $ilAppEventHandler->raise('Modules/OrgUnit', 'assignUsersToSuperiorRole', array(
                                 'object'  => $this,
                                 'obj_id'  => $this->getId(),
                                 'ref_id'  => $this->getRefId(),
                                 'role_id' => $this->getSuperiorRole(),
                                 'user_id' => $user_id,
                         ));
                 }
         }

Here is the call graph for this function:

◆ assignUserToLocalRole()

ilObjOrgUnit::assignUserToLocalRole	(	$role_id,
		$user_id
	)

Assign a given user to a given local role.

Parameters

int	$role_id
int	$user_id

Returns: bool

Definition at line 337 of file class.ilObjOrgUnit.php.

References ilObject\getId(), and ilObject\getRefId().

                                                                   {
                 global $rbacreview, $rbacadmin, $ilAppEventHandler;
 
                 $arrLocalRoles = $rbacreview->getLocalRoles($this->getRefId());
                 if (!in_array($role_id, $arrLocalRoles)) {
                         return false;
                 }
 
                 $return = $rbacadmin->assignUser($role_id, $user_id);
 
                 $ilAppEventHandler->raise('Modules/OrgUnit', 'assignUserToLocalRole', array(
                                 'object'  => $this,
                                 'obj_id'  => $this->getId(),
                                 'ref_id'  => $this->getRefId(),
                                 'role_id' => $role_id,
                                 'user_id' => $user_id,
                         ));
 
                 return $return;
         }

Here is the call graph for this function:

◆ create()

ilObjOrgUnit::create ( )

Definition at line 69 of file class.ilObjOrgUnit.php.

References $ilDB, ilObject\getId(), and getOrgUnitTypeId().

                                  {
                 global $ilDB;
                 parent::create();
                 $ilDB->insert(self::TABLE_NAME, array(
                         'orgu_type_id' => array( 'integer', $this->getOrgUnitTypeId() ),
                         'orgu_id'      => array( 'integer', $this->getId() ),
                 ));
         }

Here is the call graph for this function:

◆ deassignUserFromEmployeeRole()

ilObjOrgUnit::deassignUserFromEmployeeRole ( $user_id )

Definition at line 302 of file class.ilObjOrgUnit.php.

References getEmployeeRole(), ilObject\getId(), and ilObject\getRefId().

                                                                {
                 global $rbacadmin, $ilAppEventHandler;
                 $rbacadmin->deassignUser($this->getEmployeeRole(), $user_id);
 
                 $ilAppEventHandler->raise('Modules/OrgUnit', 'deassignUserFromEmployeeRole', array(
                         'object'  => $this,
                         'obj_id'  => $this->getId(),
                         'ref_id'  => $this->getRefId(),
                         'role_id' => $this->getEmployeeRole(),
                         'user_id' => $user_id,
                 ));
         }

Here is the call graph for this function:

◆ deassignUserFromLocalRole()

ilObjOrgUnit::deassignUserFromLocalRole	(	$role_id,
		$user_id
	)

Deassign a given user to a given local role.

Parameters

int	$role_id
int	$user_id

Returns: bool

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

References ilObject\getId(), and ilObject\getRefId().

                                                                       {
                 global $rbacreview, $rbacadmin, $ilAppEventHandler;
 
                 $arrLocalRoles = $rbacreview->getLocalRoles($this->getRefId());
                 if (!in_array($role_id, $arrLocalRoles)) {
                         return false;
                 }
 
                 $return = $rbacadmin->deassignUser($role_id, $user_id);
 
                 $ilAppEventHandler->raise('Modules/OrgUnit', 'deassignUserFromLocalRole', array(
                                 'object'  => $this,
                                 'obj_id'  => $this->getId(),
                                 'ref_id'  => $this->getRefId(),
                                 'role_id' => $role_id,
                                 'user_id' => $user_id,
                         ));
 
                 return $return;
         }

Here is the call graph for this function:

◆ deassignUserFromSuperiorRole()

ilObjOrgUnit::deassignUserFromSuperiorRole ( $user_id )

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

References ilObject\getId(), ilObject\getRefId(), and getSuperiorRole().

                                                                {
                 global $rbacadmin, $ilAppEventHandler;
                 $rbacadmin->deassignUser($this->getSuperiorRole(), $user_id);
 
                 $ilAppEventHandler->raise('Modules/OrgUnit', 'deassignUserFromSuperiorRole', array(
                         'object'  => $this,
                         'obj_id'  => $this->getId(),
                         'ref_id'  => $this->getRefId(),
                         'role_id' => $this->getSuperiorRole(),
                         'user_id' => $user_id,
                 ));
         }

Here is the call graph for this function:

◆ delete()

ilObjOrgUnit::delete ( )

delete category and all related data

public

Returns: boolean true if all object data were removed; false if only a references were removed

Definition at line 524 of file class.ilObjOrgUnit.php.

References $ilDB, $query, ilObjUserFolder\_updateUserFolderAssignment(), doLoadRoles(), ilObject\getId(), ilObject\getRefId(), and USER_FOLDER_ID.

                                  {
                 global $ilDB, $ilAppEventHandler;
 
                 // always call parent delete function first!!
                 if (!parent::delete()) {
                         return false;
                 }
 
                 // put here category specific stuff
                 include_once('./Services/User/classes/class.ilObjUserFolder.php');
                 ilObjUserFolder::_updateUserFolderAssignment($this->ref_id, USER_FOLDER_ID);
 
                 $query = "DELETE FROM object_translation WHERE obj_id = "
                          . $ilDB->quote($this->getId(), 'integer');
                 $ilDB->manipulate($query);
 
                 $ilAppEventHandler->raise('Modules/OrgUnit', 'delete', array(
                         'object' => $this,
                         'obj_id' => $this->getId(),
                 ));
 
                 $sql = 'DELETE FROM ' . self::TABLE_NAME . ' WHERE orgu_id = '
                        . $ilDB->quote($this->getId(), 'integer');
                 $ilDB->manipulate($sql);
 
                 if (!$this->employee_role || !$this->superior_role) {
                         $this->doLoadRoles();
                 }
                 $emp = new ilObjRole($this->employee_role);
                 $emp->setParent($this->getRefId());
                 $emp->delete();
                 $sup = new ilObjRole($this->superior_role);
                 $sup->setParent($this->getRefId());
                 $sup->delete();
 
                 return true;
         }

Here is the call graph for this function:

◆ deleteTranslation()

ilObjOrgUnit::deleteTranslation ( $a_lang )

Definition at line 574 of file class.ilObjOrgUnit.php.

References $ilDB, $query, $res, and ilObject\getId().

                                             {
                 global $ilDB;
 
                 $query = "DELETE FROM object_translation WHERE obj_id= "
                          . $ilDB->quote($this->getId(), 'integer') . " AND lang_code = "
                          . $ilDB->quote($a_lang, 'text');
                 $res = $ilDB->manipulate($query);
         }

Here is the call graph for this function:

◆ doLoadRoles()

ilObjOrgUnit::doLoadRoles ( )

private

Definition at line 247 of file class.ilObjOrgUnit.php.

References $ilDB, $res, ilObject\getId(), and ilObject\getRefId().

Referenced by delete(), and loadRoles().

                                        {
                 global $ilDB;
                 if (!$this->employee_role || !$this->superior_role) {
                         $q = "SELECT obj_id, title FROM object_data WHERE title LIKE 'il_orgu_employee_"
                              . $ilDB->quote($this->getRefId(), "integer") . "' OR title LIKE 'il_orgu_superior_"
                              . $ilDB->quote($this->getRefId(), "integer") . "'";
                         $set = $ilDB->query($q);
                         while ($res = $ilDB->fetchAssoc($set)) {
                                 if ($res["title"] == "il_orgu_employee_" . $this->getRefId()) {
                                         $this->employee_role = $res["obj_id"];
                                 } elseif ($res["title"] == "il_orgu_superior_" . $this->getRefId()) {
                                         $this->superior_role = $res["obj_id"];
                                 }
                         }
 
                         if (!$this->employee_role || !$this->superior_role) {
                                 throw new Exception("The standard roles the orgu object with id: " . $this->getId()
                                                     . " aren't initialized or have been deleted!");
                         }
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getEmployeeRole()

ilObjOrgUnit::getEmployeeRole ( )

Returns: int

Definition at line 404 of file class.ilObjOrgUnit.php.

References $employee_role, and loadRoles().

Referenced by assignUsersToEmployeeRole(), and deassignUserFromEmployeeRole().

                                           {
                 $this->loadRoles();
 
                 return $this->employee_role;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLongDescription()

ilObjOrgUnit::getLongDescription ( )

get object long description (stored in object_description)

public

Returns: string object description

Definition at line 471 of file class.ilObjOrgUnit.php.

                                              {
                 if (parent::getTitle() == "__OrgUnitAdministration") {
                         return $this->lng->txt("obj_orgu_description");
                 } else {
                         return parent::getLongDescription();
                 }
         }

◆ getOrgUnitType()

ilObjOrgUnit::getOrgUnitType ( )

Returns: ilOrgUnitType|null

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

References ilOrgUnitType\getInstance(), and getOrgUnitTypeId().

Referenced by update().

                                          {
                 return ilOrgUnitType::getInstance($this->getOrgUnitTypeId());
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOrgUnitTypeId()

ilObjOrgUnit::getOrgUnitTypeId ( )

Returns: int

Definition at line 111 of file class.ilObjOrgUnit.php.

References $orgu_type_id.

Referenced by create(), getOrgUnitType(), setOrgUnitTypeId(), and update().

                                            {
                 return $this->orgu_type_id;
         }

Here is the caller graph for this function:

◆ getRootOrgId()

static ilObjOrgUnit::getRootOrgId ( )

static

Definition at line 205 of file class.ilObjOrgUnit.php.

Referenced by ilOrgUnitExporter\sendAndCreateSimpleExportFile().

                                               {
                 self::loadRootOrgRefIdAndId();
 
                 return self::$root_id;
         }

Here is the caller graph for this function:

◆ getRootOrgRefId()

static ilObjOrgUnit::getRootOrgRefId ( )

static

Definition at line 198 of file class.ilObjOrgUnit.php.

Referenced by ilOrgUnitExportGUI\__construct(), ilObjOrgUnitGUI\addAdminLocatorItems(), ilOrgUnitExporter\buildExternalId(), ilOrgUnitSimpleImportGUI\chooseImport(), ilObjOrgUnitTree\getAllOrgunitsOnLevelX(), ilOrgUnitExporter\getAttributesForOrgu(), ilObjOrgUnitTree\getLevelXOfTreenode(), ilOrgUnitExplorerGUI\getRootNode(), ilObjOrgUnitGUI\getTabs(), ilOrgUnitExportGUI\listExportFiles(), ilOrgUnitExporter\sendAndCreateSimpleExportFile(), ilObjOrgUnitGUI\setContentSubTabs(), ilOrgUnitExporter\simpleExport(), ilOrgUnitExportGUI\simpleExportExcel(), and ilOrgUnitSimpleImport\simpleImportElement().

                                                  {
                 self::loadRootOrgRefIdAndId();
 
                 return self::$root_ref_id;
         }

Here is the caller graph for this function:

◆ getSuperiorRole()

ilObjOrgUnit::getSuperiorRole ( )

Returns: int

Definition at line 422 of file class.ilObjOrgUnit.php.

References $superior_role, and loadRoles().

Referenced by assignUsersToSuperiorRole(), and deassignUserFromSuperiorRole().

                                           {
                 $this->loadRoles();
 
                 return $this->superior_role;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTitle()

ilObjOrgUnit::getTitle ( )

Return title.

Returns: string

Definition at line 456 of file class.ilObjOrgUnit.php.

Referenced by getTranslations().

                                    {
                 if (parent::getTitle() != "__OrgUnitAdministration") {
                         return parent::getTitle();
                 } else {
                         return $this->lng->txt("objs_orgu");
                 }
         }

Here is the caller graph for this function:

◆ getTranslations()

ilObjOrgUnit::getTranslations ( )

Returns: array This catches if by some means there is no translation.

Definition at line 483 of file class.ilObjOrgUnit.php.

References $data, $ilDB, ilObject\$lng, $r, $row, addTranslation(), DB_FETCHMODE_OBJECT, ilObject\getId(), and getTitle().

                                           {
                 global $lng, $ilDB;
 
                 $q = "SELECT * FROM object_translation WHERE obj_id = "
                      . $ilDB->quote($this->getId(), 'integer') . " ORDER BY lang_default DESC";
                 $r = $this->ilias->db->query($q);
 
                 $num = 0;
                 $data = array();
                 while ($row = $r->fetchRow(DB_FETCHMODE_OBJECT)) {
                         $data["Fobject"][$num] = array(
                                 "title"        => $row->title,
                                 "desc"         => $row->description,
                                 "lang"         => $row->lang_code,
                                 'lang_default' => $row->lang_default,
                         );
                         $num ++;
                 }
 
                 $translations = $data;
 
                 if (!count($translations["Fobject"])) {
                         $this->addTranslation($this->getTitle(), "", $lng->getDefaultLanguage(), true);
                         $translations["Fobject"][] = array(
                                 "title" => $this->getTitle(),
                                 "desc"  => "",
                                 "lang"  => $lng->getDefaultLanguage(),
                         );
                 }
 
                 return $translations;
         }

Here is the call graph for this function:

◆ initDefaultRoles()

ilObjOrgUnit::initDefaultRoles ( )

Definition at line 429 of file class.ilObjOrgUnit.php.

References ilObjRole\createDefaultRole(), ilObject\getId(), and ilObject\getRefId().

Referenced by loadRoles().

                                            {
                 global $ilAppEventHandler;
 
                 include_once './Services/AccessControl/classes/class.ilObjRole.php';
                 $role_emp = ilObjRole::createDefaultRole('il_orgu_employee_'
                                                          . $this->getRefId(), "Emplyee of org unit obj_no."
                                                                               . $this->getId(), 'il_orgu_employee', $this->getRefId());
 
                 $role_sup = ilObjRole::createDefaultRole('il_orgu_superior_'
                                                          . $this->getRefId(), "Superior of org unit obj_no."
                                                                               . $this->getId(), 'il_orgu_superior', $this->getRefId());
 
                 $ilAppEventHandler->raise('Modules/OrgUnit', 'initDefaultRoles', array(
                         'object'           => $this,
                         'obj_id'           => $this->getId(),
                         'ref_id'           => $this->getRefId(),
                         'role_superior_id' => $role_sup->getId(),
                         'role_employee_id' => $role_emp->getId(),
                 ));
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadRoles()

ilObjOrgUnit::loadRoles ( )

private

Definition at line 226 of file class.ilObjOrgUnit.php.

References $ilLog, doLoadRoles(), ilObject\getId(), and initDefaultRoles().

Referenced by getEmployeeRole(), and getSuperiorRole().

                                      {
                 global $ilLog;
                 if (!$this->employee_role || !$this->superior_role) {
                         $this->doLoadRoles();
                 }
 
                 if (!$this->employee_role || !$this->superior_role) {
                         $this->initDefaultRoles();
                         $this->doLoadRoles();
                         if (!$this->employee_role || !$this->superior_role) {
                                 throw new Exception("The standard roles the orgu object with id: " . $this->getId()
                                                     . " aren't initialized or have been deleted, newly creating them didn't work!");
                         } else {
                                 $ilLog->write("[" . __FILE__ . ":" . __LINE__
                                               . "] The standard roles for the orgu obj with id: " . $this->getId()
                                               . " were newly created as they couldnt be found.");
                         }
                 }
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ loadRootOrgRefIdAndId()

static ilObjOrgUnit::loadRootOrgRefIdAndId ( )

staticprivate

Definition at line 212 of file class.ilObjOrgUnit.php.

References $ilDB, and $res.

                                                         {
                 if (self::$root_ref_id === null || self::$root_id === null) {
                         global $ilDB;
                         $q = "SELECT o.obj_id, r.ref_id FROM object_data o
                         INNER JOIN object_reference r ON r.obj_id = o.obj_id
                         WHERE title = " . $ilDB->quote('__OrgUnitAdministration', 'text') . "";
                         $set = $ilDB->query($q);
                         $res = $ilDB->fetchAssoc($set);
                         self::$root_id = $res["obj_id"];
                         self::$root_ref_id = $res["ref_id"];
                 }
         }

◆ removeTranslations()

ilObjOrgUnit::removeTranslations ( )

Definition at line 564 of file class.ilObjOrgUnit.php.

References $ilDB, $query, $res, and ilObject\getId().

                                       {
                 global $ilDB;
 
                 $query = "DELETE FROM object_translation WHERE obj_id= "
                          . $ilDB->quote($this->getId(), 'integer');
                 $res = $ilDB->manipulate($query);
         }

Here is the call graph for this function:

◆ setEmployeeRole()

ilObjOrgUnit::setEmployeeRole ( $employee_role )

Parameters

int $employee_role

Definition at line 391 of file class.ilObjOrgUnit.php.

References $employee_role.

                                                         {
                 $this->employee_role = $employee_role;
         }

◆ setOrgUnitTypeId()

ilObjOrgUnit::setOrgUnitTypeId ( $a_id )

Parameters

$a_id

Definition at line 127 of file class.ilObjOrgUnit.php.

References $amd_data, $icons_cache, $ilDB, $row, ilObject\$type, ilObject\getId(), ilOrgUnitType\getInstance(), ilAdvancedMDValues\getInstancesForObjectId(), and getOrgUnitTypeId().

Referenced by __construct().

                                                 {
                 $this->orgu_type_id = $a_id;
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setSuperiorRole()

ilObjOrgUnit::setSuperiorRole ( $superior_role )

Parameters

int $superior_role

Definition at line 414 of file class.ilObjOrgUnit.php.

References $superior_role.

                                                         {
                 $this->superior_role = $superior_role;
         }

◆ update()

ilObjOrgUnit::update ( )

Definition at line 79 of file class.ilObjOrgUnit.php.

References $ilDB, ilObject\getId(), getOrgUnitType(), getOrgUnitTypeId(), and ilAdvancedMDRecord\saveObjRecSelection().

                                  {
                 global $ilDB;
                 parent::update();
                 $sql = 'SELECT * FROM ' . self::TABLE_NAME . ' WHERE orgu_id = '
                        . $ilDB->quote($this->getId(), 'integer');
                 $set = $ilDB->query($sql);
                 if ($ilDB->numRows($set)) {
                         $ilDB->update(self::TABLE_NAME, array(
                                 'orgu_type_id' => array( 'integer', $this->getOrgUnitTypeId() ),
                         ), array(
                                 'orgu_id' => array( 'integer', $this->getId() ),
                         ));
                 } else {
                         $ilDB->insert(self::TABLE_NAME, array(
                                 'orgu_type_id' => array( 'integer', $this->getOrgUnitTypeId() ),
                                 'orgu_id'      => array( 'integer', $this->getId() ),
                         ));
                 }
                 // Update selection for advanced meta data of the type
                 if ($this->getOrgUnitTypeId()) {
                         ilAdvancedMDRecord::saveObjRecSelection($this->getId(), 'orgu_type', $this->getOrgUnitType()
                                                                                                   ->getAssignedAdvancedMDRecordIds());
                 } else {
                         // If no type is assigned, delete relations by passing an empty array
                         ilAdvancedMDRecord::saveObjRecSelection($this->getId(), 'orgu_type', array());
                 }
         }

Here is the call graph for this function:

◆ updateTranslation()

ilObjOrgUnit::updateTranslation	(	$a_title,
		$a_desc,
		$a_lang,
		$a_lang_default
	)

Definition at line 604 of file class.ilObjOrgUnit.php.

References $ilDB, $ilLog, $query, $res, and ilObject\getId().

                                                                                 {
                 global $ilDB, $ilLog;
 
                 if (empty($a_title)) {
                         $a_title = "NO TITLE";
                 }
 
                 $query = "UPDATE object_translation SET ";
 
                 $query .= " title = " . $ilDB->quote($a_title, 'text');
 
                 if ($a_desc != "") {
                         $query .= ", description = " . $ilDB->quote($a_desc, 'text') . " ";
                 }
 
                 if ($a_lang_default) {
                         $query .= ", lang_default = " . $ilDB->quote($a_lang_default, 'integer') . " ";
                 }
 
                 $query .= " WHERE obj_id = " . $ilDB->quote($this->getId(), 'integer') . " AND lang_code = "
                           . $ilDB->quote($a_lang, 'text');
                 $res = $ilDB->manipulate($query);
 
                 return true;
         }

Here is the call graph for this function:

Field Documentation

◆ $amd_data

ilObjOrgUnit::$amd_data

protected

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

Referenced by setOrgUnitTypeId().

◆ $employee_role

ilObjOrgUnit::$employee_role

protected

Definition at line 23 of file class.ilObjOrgUnit.php.

Referenced by getEmployeeRole(), and setEmployeeRole().

◆ $icons_cache

ilObjOrgUnit::$icons_cache

staticprotected

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

Referenced by setOrgUnitTypeId().

◆ $orgu_type_id

ilObjOrgUnit::$orgu_type_id = 0

protected

Definition at line 36 of file class.ilObjOrgUnit.php.

Referenced by getOrgUnitTypeId().

◆ $root_id

ilObjOrgUnit::$root_id

staticprotected

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

◆ $root_ref_id

ilObjOrgUnit::$root_ref_id

staticprotected

Definition at line 21 of file class.ilObjOrgUnit.php.

◆ $superior_role

ilObjOrgUnit::$superior_role

protected

Definition at line 24 of file class.ilObjOrgUnit.php.

Referenced by getSuperiorRole(), and setSuperiorRole().

◆ TABLE_NAME

const ilObjOrgUnit::TABLE_NAME = 'orgu_data'

Definition at line 20 of file class.ilObjOrgUnit.php.

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

Modules/OrgUnit/classes/class.ilObjOrgUnit.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Static Protected Attributes

Private Member Functions

Static Private Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _exists()

◆ addTranslation()

◆ assignUsersToEmployeeRole()

◆ assignUsersToSuperiorRole()

◆ assignUserToLocalRole()

◆ create()

◆ deassignUserFromEmployeeRole()

◆ deassignUserFromLocalRole()

◆ deassignUserFromSuperiorRole()

◆ delete()

◆ deleteTranslation()

◆ doLoadRoles()

◆ getEmployeeRole()

◆ getLongDescription()

◆ getOrgUnitType()

◆ getOrgUnitTypeId()

◆ getRootOrgId()

◆ getRootOrgRefId()

◆ getSuperiorRole()

◆ getTitle()

◆ getTranslations()

◆ initDefaultRoles()

◆ loadRoles()

◆ loadRootOrgRefIdAndId()

◆ removeTranslations()

◆ setEmployeeRole()

◆ setOrgUnitTypeId()

◆ setSuperiorRole()

◆ update()

◆ updateTranslation()

Field Documentation

◆ $amd_data

◆ $employee_role

◆ $icons_cache

◆ $orgu_type_id

◆ $root_id

◆ $root_ref_id

◆ $superior_role

◆ TABLE_NAME