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

Inheritance diagram for ilObjOrgUnit:

Collaboration diagram for ilObjOrgUnit:

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

	create ()

	update ()

	getOrgUnitTypeId ()

	getOrgUnitType ()

	setOrgUnitTypeId (int $a_id)

	assignUsersToEmployeeRole (array $user_ids)
	Adds the user ids to the position employee. More...

	assignUsersToSuperiorRole (array $user_ids)
	Adds the user ids to the position superior. More...

	deassignUserFromEmployeeRole (int $user_id)

	deassignUserFromSuperiorRole (int $user_id)

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

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

	getTitle ()

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

	getTranslations ()

	delete ()
	delete orgunit, childs and all related data More...

	removeTranslations ()
	remove all Translations of current OrgUnit More...

	deleteTranslation (string $a_lang)
	remove translations of current OrgUnit More...

	addTranslation (string $a_title, string $a_desc, string $a_lang, string $a_lang_default)
	add a new translation to current OrgUnit More...

	updateTranslation (string $title, string $desc, string $lang, string $lang_default)
	update a translation to current OrgUnit More...

	writePath ()

Public Member Functions inherited from ilContainer
	getTileSizes ()

	getObjectTranslation ()

	setObjectTranslation (?ilObjectTranslation $obj_trans)

	createContainerDirectory ()

	getContainerDirectory ()

	setHiddenFilesFound (bool $a_hiddenfilesfound)

	getHiddenFilesFound ()

	getStyleSheetId ()

	setStyleSheetId (int $a_style_id)

	setNewsTimeline (bool $a_val)

	getNewsTimeline ()

	setNewsTimelineAutoEntries (bool $a_val)

	getNewsTimelineAutoEntries ()

	setNewsTimelineLandingPage (bool $a_val)

	getNewsTimelineLandingPage ()

	isNewsTimelineEffective ()

	isNewsTimelineLandingPageEffective ()

	setNewsBlockActivated (bool $a_val)

	getNewsBlockActivated ()

	setUseNews (bool $a_val)

	getUseNews ()

	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies (container sorting) More...

	cloneAllObject (string $session_id, string $client_id, string $new_type, int $ref_id, int $clone_source, array $options, bool $soap_call=false, int $a_submode=1)

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

	getViewMode ()

	getOrderType ()

	setOrderType (int $a_value)

	isClassificationFilterActive ()

	filteredSubtree ()
	Note grp/crs currently allow to filter in their whole subtrees Catetories only their direct childs. More...

	getSubItems (bool $a_admin_panel_enabled=false, bool $a_include_side_block=false, int $a_get_single=0, ?ilContainerUserFilter $container_user_filter=null)

	gotItems ()

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

	getGroupedObjTypes ()

	enablePageEditing ()

	create ()

	putInTree (int $parent_ref_id)

	update ()

	read ()

	readContainerSettings ()

	removeTranslations ()

	deleteTranslation (string $a_lang)

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

Public Member Functions inherited from ilObject
	getObjectProperties ()

	flushObjectProperties ()

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

	processAutoRating ()

	read ()

	getId ()

	setId (int $id)

	setRefId (int $ref_id)

	getRefId ()

	getType ()

	setType (string $type)

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

	getTitle ()

	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...

	setTitle (string $title)

	getDescription ()

	setDescription (string $description)

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

	getImportId ()

	setImportId (string $import_id)

	setOfflineStatus (bool $status)

	getOfflineStatus ()

	supportsOfflineHandling ()

	getOwner ()

	getOwnerName ()
	get full name of object owner More...

	setOwner (int $usr_id)

	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...

	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...

	create ()
	note: title, description and type should be set when this function is called More...

	update ()

	MDUpdateListener (string $element)
	Metadata update listener. More...

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

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

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

	setPermissions (int $parent_ref_id)

	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...

	createReference ()
	creates reference for object More...

	countReferences ()

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

	applyDidacticTemplate (int $tpl_id)

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo (int $target_id, int $copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...

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

	selfOrParentWithRatingEnabled ()

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

Static Public Member Functions
static	getIconsCache ()
	Returns an array that maps from OrgUnit object IDs to its icon defined by the assigned OrgUnit type. More...

static	getRootOrgRefId ()

static	getRootOrgId ()

static	_exists (int $id, bool $isReference=false, ?string $type="orgu")

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

static	_lookupContainerSetting (int $a_id, string $a_keyword, ?string $a_default_value=null)

static	_hasContainerSetting (int $a_id, string $a_keyword)

static	_writeContainerSetting (int $a_id, string $a_keyword, string $a_value)

static	_getContainerSettings (int $a_id)

static	_deleteContainerSettings (int $a_id, string $a_keyword="", bool $a_keyword_like=false)

static	_exportContainerSettings (ilXmlWriter $a_xml, int $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 (string $import_id)
	Get (latest) object id for an import id. More...

static	_lookupImportId (int $obj_id)

static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...

static	_getIdForImportId (string $import_id)

static	_getAllReferences (int $id)
	get all reference ids for object ID More...

static	_lookupTitle (int $obj_id)

static	lookupOfflineStatus (int $obj_id)
	Lookup offline status using objectDataCache. More...

static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...

static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)

static	_lookupDescription (int $obj_id)

static	_lookupLastUpdate (int $obj_id, bool $formatted=false)

static	_getLastUpdateOfObjects (array $obj_ids)

static	_lookupObjId (int $ref_id)

static	_setDeletedDate (int $ref_id, int $deleted_by)

static	setDeletedDates (array $ref_ids, int $user_id)

static	_resetDeletedDate (int $ref_id)

static	_lookupDeletedDate (int $ref_id)

static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...

static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...

static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...

static	_lookupType (int $id, bool $reference=false)

static	_isInTrash (int $ref_id)

static	_hasUntrashedReference (int $obj_id)
	checks whether an object has at least one reference that is not in trash More...

static	_lookupObjectId (int $ref_id)

static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...

static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType (string $obj_type="", ?int $owner=null)

static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...

static	getIconForType (string $type)

static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $obj_ids)

static	getAllOwnedRepositoryObjects (int $user_id)

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

static	_lookupCreationDate (int $obj_id)

static	_getObjectTypeIdByTitle (string $type, ?\ilDBInterface $ilDB=null)

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

const	TILE_NORMAL = 0

const	TILE_SMALL = 1

const	TILE_LARGE = 2

const	TILE_EXTRA_LARGE = 3

const	TILE_FULL = 4

array	$items = []

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255

const	DESC_LENGTH = 128

const	LONG_DESC_LENGTH = 4000

const	TABLE_OBJECT_DATA = "object_data"

array	$objectList

string	$untranslatedTitle

Protected Attributes
ilOrgUnitPositionDBRepository	$positionRepo

ilOrgUnitUserAssignmentDBRepository	$assignmentRepo

int	$orgu_type_id = 0
	ID of assigned OrgUnit type. More...

array	$amd_data
	Advanced Metadata Values for this OrgUnit. More...

Protected Attributes inherited from ilContainer
News	$news

ILIAS Style Content DomainService	$content_style_domain

ILIAS Container InternalDomainService	$domain

ilAccessHandler	$access

ilRbacSystem	$rbacsystem

ilObjUser	$user

ilObjectDefinition	$obj_definition

int	$order_type = 0

bool	$hiddenfilesfound = false

bool	$news_timeline = false

bool	$news_timeline_auto_entries = false

ilSetting	$setting

ilObjectTranslation	$obj_trans = null

int	$style_id = 0

bool	$news_timeline_landing_page = false

bool	$news_block_activated = false

bool	$use_news = false

ilRecommendedContentManager	$recommended_content_manager

array	$type_grps = null

Protected Attributes inherited from ilObject
ilLogger	$obj_log

ILIAS	$ilias

ilObjectDefinition	$obj_definition

ilDBInterface	$db

ilLogger	$log

ilErrorHandling	$error

ilTree	$tree

ilAppEventHandler	$app_event_handler

ilRbacAdmin	$rbac_admin

ilRbacReview	$rbac_review

ilObjUser	$user

ilLanguage	$lng

LOMServices	$lom_services

bool	$call_by_reference

int	$max_title = self::TITLE_LENGTH

int	$max_desc = self::DESC_LENGTH

bool	$add_dots = true

int	$ref_id = null

string	$type = ""

string	$title = ""

string	$desc = ""

string	$long_desc = ""

int	$owner = 0

string	$create_date = ""

string	$last_update = ""

string	$import_id = ""

bool	$register = false

Static Protected Attributes
static int	$root_ref_id = 0

static int	$root_id = 0

static array	$icons_cache = null
	Cache storing OrgUnit objects that have OrgUnit types with custom icons assigned. More...

Static Private Member Functions
static	loadRootOrgRefIdAndId ()

Private Attributes
ilDBInterface	$ilDb

ilAppEventHandler	$ilAppEventHandler

ilRbacReview	$rbacreview

ilRbacAdmin	$rbacadmin

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

Protected Member Functions inherited from ilContainer
	getInitialSubitems ()

	applyContainerUserFilter (array $objects, ?ilContainerUserFilter $container_user_filter=null)

Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)

	beforeMDUpdateListener (string $a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDeleteMetaData ()

	beforeDeleteMetaData ()

	handleAutoRating ()

	hasAutoRating ()

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 ilObjOrgUnit Based on methods of ilObjCategoryGUI

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 27 of file class.ilObjOrgUnit.php.

Constructor & Destructor Documentation

◆ __construct()

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

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

References $DIC, $dic, ILIAS\GlobalScreen\Provider\__construct(), ilOrgUnitLocalDIC\dic(), ilObject\getId(), ilContainer\read(), and setOrgUnitTypeId().

     {
         global $DIC;
 
         $this->ilDb = $DIC->database();
         $this->type = "orgu";
         $this->ilAppEventHandler = $DIC->event();
         $this->rbacreview = $DIC->rbac()->review();
         $this->rbacadmin = $DIC->rbac()->admin();
 
         $dic = ilOrgUnitLocalDIC::dic();
         $this->positionRepo = $dic["repo.Positions"];
         $this->assignmentRepo = $dic["repo.UserAssignments"];
 
         parent::__construct($a_id, $a_call_by_reference);
     }

Here is the call graph for this function:

Member Function Documentation

◆ _exists()

static ilObjOrgUnit::_exists	(	int	$id,
		bool	$isReference = `false`,
		?string	$type = `"orgu"`
	)

static

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

Referenced by ilOrgUnitImporter\buildRef().

                                                                                               : bool
     {
         return parent::_exists($id, $isReference, "orgu");
     }

Here is the caller graph for this function:

◆ addTranslation()

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

add a new translation to current OrgUnit

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

References ilObject\getId().

Referenced by getTranslations().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ assignUsersToEmployeeRole()

ilObjOrgUnit::assignUsersToEmployeeRole ( array $user_ids )

Adds the user ids to the position employee.

Parameters

int[] $user_ids

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

References $user_id, ilOrgUnitPosition\CORE_POSITION_EMPLOYEE, ilObject\getId(), ilObject\getRefId(), and ilAppEventHandler\raise().

                                                               : void
     {
         $position_id = $this->positionRepo
             ->getSingle(ilOrgUnitPosition::CORE_POSITION_EMPLOYEE, 'core_identifier')
             ->getId();
 
         foreach ($user_ids as $user_id) {
             $assignment = $this->assignmentRepo->get($user_id, $position_id, $this->getRefId());
 
             $this->ilAppEventHandler->raise('components/ILIAS/OrgUnit', 'assignUsersToEmployeeRole', array(
                 'object' => $this,
                 'obj_id' => $this->getId(),
                 'ref_id' => $this->getRefId(),
                 'position_id' => $position_id,
                 'user_id' => $user_id
             ));
         }
     }

Here is the call graph for this function:

◆ assignUsersToSuperiorRole()

ilObjOrgUnit::assignUsersToSuperiorRole ( array $user_ids )

Adds the user ids to the position superior.

Parameters

int[] $user_ids

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

References $user_id, ilOrgUnitPosition\CORE_POSITION_SUPERIOR, ilObject\getId(), ilObject\getRefId(), and ilAppEventHandler\raise().

                                                               : void
     {
         $position_id = $this->positionRepo
             ->getSingle(ilOrgUnitPosition::CORE_POSITION_SUPERIOR, 'core_identifier')
             ->getId();
 
         foreach ($user_ids as $user_id) {
             $assignment = $this->assignmentRepo->get($user_id, $position_id, $this->getRefId());
 
             $this->ilAppEventHandler->raise('components/ILIAS/OrgUnit', 'assignUsersToSuperiorRole', array(
                 'object' => $this,
                 'obj_id' => $this->getId(),
                 'ref_id' => $this->getRefId(),
                 'position_id' => $position_id,
                 'user_id' => $user_id
             ));
         }
     }

Here is the call graph for this function:

◆ assignUserToLocalRole()

ilObjOrgUnit::assignUserToLocalRole	(	int	$role_id,
		int	$user_id
	)

Assign a given user to a given local role.

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

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

                                                                      : bool
     {
         $arrLocalRoles = $this->rbacreview->getLocalRoles($this->getRefId());
         if (!in_array($role_id, $arrLocalRoles)) {
             return false;
         }
 
         $return = $this->rbacadmin->assignUser($role_id, $user_id);
 
         $this->ilAppEventHandler->raise('components/ILIAS/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 81 of file class.ilObjOrgUnit.php.

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

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

Here is the call graph for this function:

◆ deassignUserFromEmployeeRole()

ilObjOrgUnit::deassignUserFromEmployeeRole ( int $user_id )

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

References ilOrgUnitPosition\CORE_POSITION_EMPLOYEE, ilObject\getId(), ilObject\getRefId(), and ilAppEventHandler\raise().

                                                               : void
     {
         $position_id = $this->positionRepo
             ->getSingle(ilOrgUnitPosition::CORE_POSITION_EMPLOYEE, 'core_identifier')
             ->getId();
 
         $assignment = $this->assignmentRepo->find($user_id, $position_id, $this->getRefId());
         if ($assignment) {
             $this->assignmentRepo->delete($assignment);
         }
 
         $this->ilAppEventHandler->raise('components/ILIAS/OrgUnit', 'deassignUserFromEmployeeRole', array(
             'object' => $this,
             'obj_id' => $this->getId(),
             'ref_id' => $this->getRefId(),
             'position_id' => $position_id,
             'user_id' => $user_id,
         ));
     }

Here is the call graph for this function:

◆ deassignUserFromLocalRole()

ilObjOrgUnit::deassignUserFromLocalRole	(	int	$role_id,
		int	$user_id
	)

Deassign a given user to a given local role.

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

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

                                                                          : bool
     {
         $arrLocalRoles = $this->rbacreview->getLocalRoles($this->getRefId());
         if (!in_array($role_id, $arrLocalRoles)) {
             return false;
         }
 
         $return = $this->rbacadmin->deassignUser($role_id, $user_id);
 
         $this->ilAppEventHandler->raise('components/ILIAS/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 ( int $user_id )

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

References ilOrgUnitPosition\CORE_POSITION_SUPERIOR, ilObject\getId(), ilObject\getRefId(), and ilAppEventHandler\raise().

                                                               : void
     {
         $position_id = $this->positionRepo
             ->getSingle(ilOrgUnitPosition::CORE_POSITION_SUPERIOR, 'core_identifier')
             ->getId();
 
         $assignment = $this->assignmentRepo->find($user_id, $position_id, $this->getRefId());
         if ($assignment) {
             $this->assignmentRepo->delete($assignment);
         }
 
         $this->ilAppEventHandler->raise('components/ILIAS/OrgUnit', 'deassignUserFromSuperiorRole', array(
             'object' => $this,
             'obj_id' => $this->getId(),
             'ref_id' => $this->getRefId(),
             'position_id' => $position_id,
             'user_id' => $user_id,
         ));
     }

Here is the call graph for this function:

◆ delete()

ilObjOrgUnit::delete ( )

delete orgunit, childs and all related data

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

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

References $path, ilObjUserFolder\_updateUserFolderAssignment(), ilObject\getId(), ilObject\getRefId(), ilAppEventHandler\raise(), and USER_FOLDER_ID.

                             : bool
     {
         // always call parent delete function first!!
         if (!parent::delete()) {
             return false;
         }
 
         // put here category specific stuff
         ilObjUserFolder::_updateUserFolderAssignment($this->ref_id, USER_FOLDER_ID);
 
         $query = "DELETE FROM object_translation WHERE obj_id = " . $this->ilDb->quote($this->getId(), 'integer');
         $this->ilDb->manipulate($query);
 
         $this->ilAppEventHandler->raise('components/ILIAS/OrgUnit', 'delete', array(
             'object' => $this,
             'obj_id' => $this->getId(),
         ));
 
         $sql = 'DELETE FROM ' . self::TABLE_NAME . ' WHERE orgu_id = ' . $this->ilDb->quote($this->getId(), 'integer');
         $this->ilDb->manipulate($sql);
 
         $path = ilOrgUnitPathStorage::find($this->getRefId());
         if ($path instanceof ilOrgUnitPathStorage) {
             $path->delete();
         }
 
         // Delete all position assignments to this object.
         $assignments = $this->assignmentRepo->getByOrgUnit($this->getRefId());
         foreach ($assignments as $assignment) {
             $this->assignmentRepo->delete($assignment);
         }
 
         return true;
     }

Here is the call graph for this function:

◆ deleteTranslation()

ilObjOrgUnit::deleteTranslation ( string $a_lang )

remove translations of current OrgUnit

Parameters

$a_lang string en|de|...

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

References ilObject\getId().

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

Here is the call graph for this function:

◆ getIconsCache()

static ilObjOrgUnit::getIconsCache ( )

static

Returns an array that maps from OrgUnit object IDs to its icon defined by the assigned OrgUnit type.

Keys = OrgUnit object IDs, values = Path to the icon This allows to get the Icons of OrgUnits without loading the object (e.g. used in the tree explorer)

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

References $DIC, $icons_cache, ilObject\$type, ilDBInterface\fetchObject(), ilOrgUnitType\getInstance(), and ilDBInterface\query().

Referenced by ilOrgUnitExplorerGUI\getNodeIcon(), ilObjOrgUnitListGUI\getTypeIcon(), and ilObjOrgUnitGUI\setTitleAndDescription().

                                           : array
     {
         if (is_array(self::$icons_cache)) {
             return self::$icons_cache;
         }
         global $DIC;
         $ilDb = $DIC->database();
         $sql = 'SELECT orgu_id, ot.id AS type_id FROM orgu_data
                 INNER JOIN orgu_types AS ot ON (ot.id = orgu_data.orgu_type_id)
                 WHERE ot.icon IS NOT NULL';
         $set = $ilDb->query($sql);
         $icons_cache = array();
 
         $irss = $DIC['resource_storage'];
         while ($row = $ilDb->fetchObject($set)) {
             $type = ilOrgUnitType::getInstance($row->type_id);
             if ($type && $icon_id = $irss->manage()->find($type->getIconIdentifier())) {
                 $icons_cache[$row->orgu_id] = $irss->consume()->src($icon_id)->getSrc();
             }
         }
         self::$icons_cache = $icons_cache;
 
         return $icons_cache;
     }

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)

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

References ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle(), and ILIAS\Repository\lng().

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

Here is the call graph for this function:

◆ getOrgUnitType()

ilObjOrgUnit::getOrgUnitType ( )

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

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

Referenced by update().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOrgUnitTypeId()

ilObjOrgUnit::getOrgUnitTypeId ( )

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

References $orgu_type_id.

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

                                       : int
     {
         return $this->orgu_type_id;
     }

Here is the caller graph for this function:

◆ getRootOrgId()

static ilObjOrgUnit::getRootOrgId ( )

static

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

Referenced by ilOrgUnitExportOptionXML\isObjectSupported(), ilOrgUnitExportOptionXLS\isObjectSupported(), and ilOrgUnitExporter\sendAndCreateSimpleExportFile().

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

Here is the caller graph for this function:

◆ getRootOrgRefId()

static ilObjOrgUnit::getRootOrgRefId ( )

static

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

Referenced by ilOrgUnitSimpleImportGUI\__construct(), ilObjOrgUnitGUI\addAdminLocatorItems(), ilOrgUnitUserAssignmentGUI\assignmentsRecursive(), ILIAS\OrgUnit\Webservices\SOAP\Base\execute(), ilObjOrgUnitTree\getAllOrgunitsOnLevelX(), ilOrgUnitExporter\getAttributesForOrgu(), ilObjStudyProgrammeAutoMembershipsGUI\getForm(), ilObjOrgUnitTree\getLevelXOfTreenode(), ilOrgUnitExtension\getOrgUnitPath(), ilOrgUnitExplorerGUI\getRootNode(), ILIAS\EmployeeTalk\Provider\MyStaffListEntryProvider\getStaticSubItems(), ILIAS\OrgUnit\Provider\OrgUnitMainBarProvider\getStaticSubItems(), ilObjOrgUnitGUI\getTabs(), ilOrgUnitPathStorage\getTextRepresentationOfOrgUnits(), ILIAS\OrgUnit\Provider\OrgUnitToolProvider\getTree(), ILIAS\OrgUnit\Provider\OrgUnitToolProvider\getTreeRecursion(), ilRepositorySearchGUI\initFormSearch(), ilOrgUnitExportGUI\listExportFiles(), ilOrgUnitExporter\sendAndCreateSimpleExportFile(), ilObjOrgUnitGUI\setContentSubTabs(), ilOrgUnitExtensionGUI\setLocator(), ilOrgUnitExporter\simpleExport(), ilOrgUnitExporter\simpleExportExcel(), ilOrgUnitExportGUI\simpleExportExcel(), and ilOrgUnitSimpleImport\simpleImportElement().

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

Here is the caller graph for this function:

◆ getTitle()

ilObjOrgUnit::getTitle ( )

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

References ILIAS\GlobalScreen\Scope\Footer\Factory\getTitle(), and ILIAS\Repository\lng().

Referenced by getTranslations().

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

Here is the call graph for this function:

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 393 of file class.ilObjOrgUnit.php.

References $data, $q, $r, addTranslation(), ilDBConstants\FETCHMODE_OBJECT, ilObject\getId(), getTitle(), and ILIAS\Repository\lng().

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

Here is the call graph for this function:

◆ loadRootOrgRefIdAndId()

static ilObjOrgUnit::loadRootOrgRefIdAndId ( )

staticprivate

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

References $DIC, $q, $res, ilDBInterface\fetchAssoc(), ILIAS\Repository\int(), ilDBInterface\query(), and ilDBInterface\quote().

                                                    : void
     {
         if (self::$root_ref_id === 0 || self::$root_id === 0) {
             global $DIC;
             $ilDb = $DIC['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 = (int) $res["obj_id"];
             self::$root_ref_id = (int) $res["ref_id"];
         }
     }

Here is the call graph for this function:

◆ removeTranslations()

ilObjOrgUnit::removeTranslations ( )

remove all Translations of current OrgUnit

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

References $res, and ilObject\getId().

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

Here is the call graph for this function:

◆ setOrgUnitTypeId()

ilObjOrgUnit::setOrgUnitTypeId ( int $a_id )

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

References $amd_data, ilObject\getId(), ilAdvancedMDValues\getInstancesForObjectId(), and getOrgUnitTypeId().

Referenced by __construct().

                                                : void
     {
         $this->orgu_type_id = $a_id;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

ilObjOrgUnit::update ( )

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

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

                             : bool
     {
         parent::update();
         $sql = 'SELECT * FROM ' . self::TABLE_NAME . ' WHERE orgu_id = ' . $this->ilDb->quote(
             $this->getId(),
             'integer'
         );
         $set = $this->ilDb->query($sql);
         if ($this->ilDb->numRows($set)) {
             $this->ilDb->update(self::TABLE_NAME, array(
                 'orgu_type_id' => array('integer', $this->getOrgUnitTypeId()),
             ), array(
                 'orgu_id' => array('integer', $this->getId()),
             ));
         } else {
             $this->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());
         }
 
         return true;
     }

Here is the call graph for this function:

◆ updateTranslation()

ilObjOrgUnit::updateTranslation	(	string	$title,
		string	$desc,
		string	$lang,
		string	$lang_default
	)

update a translation to current OrgUnit

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

References ilObject\getId().

                                                                                                       : void
     {
         if (empty($title)) {
             $a_title = "NO TITLE";
         }
 
         $query = "UPDATE object_translation SET ";
 
         $query .= " title = " . $this->ilDb->quote($title, 'text');
 
         if ($desc !== "") {
             $query .= ", description = " . $this->ilDb->quote($desc, 'text') . " ";
         }
 
         $query .= ", lang_default = " . $this->ilDb->quote($lang_default, 'integer') . " ";
 
         $query .= " WHERE obj_id = " . $this->ilDb->quote(
             $this->getId(),
             'integer'
         ) . " AND lang_code = " . $this->ilDb->quote($lang, 'text');
         $this->ilDb->manipulate($query);
     }

Here is the call graph for this function:

◆ writePath()

ilObjOrgUnit::writePath ( )

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

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

                                : void
     {
         if ($this->getRefId()) {
             ilOrgUnitPathStorage::writePathByRefId($this->getRefId());
         } else {
             throw new \LogicException('No ref_id on OrgU with id ' . $this->getId(), 1);
         }
     }

Here is the call graph for this function:

Field Documentation

◆ $amd_data

array ilObjOrgUnit::$amd_data

protected

Advanced Metadata Values for this OrgUnit.

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

Referenced by setOrgUnitTypeId().

◆ $assignmentRepo

ilOrgUnitUserAssignmentDBRepository ilObjOrgUnit::$assignmentRepo

protected

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

◆ $icons_cache

array ilObjOrgUnit::$icons_cache = null

staticprotected

Cache storing OrgUnit objects that have OrgUnit types with custom icons assigned.

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

Referenced by getIconsCache().

◆ $ilAppEventHandler

ilAppEventHandler ilObjOrgUnit::$ilAppEventHandler

private

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

◆ $ilDb

ilDBInterface ilObjOrgUnit::$ilDb

private

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

◆ $orgu_type_id

int ilObjOrgUnit::$orgu_type_id = 0

protected

ID of assigned OrgUnit type.

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

Referenced by getOrgUnitTypeId().

◆ $positionRepo

ilOrgUnitPositionDBRepository ilObjOrgUnit::$positionRepo

protected

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

◆ $rbacadmin

ilRbacAdmin ilObjOrgUnit::$rbacadmin

private

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

◆ $rbacreview

ilRbacReview ilObjOrgUnit::$rbacreview

private

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

◆ $root_id

int ilObjOrgUnit::$root_id = 0

staticprotected

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

◆ $root_ref_id

int ilObjOrgUnit::$root_ref_id = 0

staticprotected

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

◆ TABLE_NAME

const ilObjOrgUnit::TABLE_NAME = 'orgu_data'

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

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

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

Public Member Functions

Static Public Member Functions

Data Fields

Protected Attributes

Static Protected Attributes

Static Private Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _exists()

◆ addTranslation()

◆ assignUsersToEmployeeRole()

◆ assignUsersToSuperiorRole()

◆ assignUserToLocalRole()

◆ create()

◆ deassignUserFromEmployeeRole()

◆ deassignUserFromLocalRole()

◆ deassignUserFromSuperiorRole()

◆ delete()

◆ deleteTranslation()

◆ getIconsCache()

◆ getLongDescription()

◆ getOrgUnitType()

◆ getOrgUnitTypeId()

◆ getRootOrgId()

◆ getRootOrgRefId()

◆ getTitle()

◆ getTranslations()

◆ loadRootOrgRefIdAndId()

◆ removeTranslations()

◆ setOrgUnitTypeId()

◆ update()

◆ updateTranslation()

◆ writePath()

Field Documentation

◆ $amd_data

◆ $assignmentRepo

◆ $icons_cache

◆ $ilAppEventHandler

◆ $ilDb

◆ $orgu_type_id

◆ $positionRepo

◆ $rbacadmin

◆ $rbacreview

◆ $root_id

◆ $root_ref_id

◆ TABLE_NAME