ILIAS  release_8 Revision v8.23
Public Member Functions | Static Public Member Functions | Data Fields | Protected Attributes | Static Protected Attributes | Static Private Member Functions | Private Attributes
ilObjOrgUnit Class Reference

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
 __construct (int $id=0, bool $reference=true)
 
 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 $desc)
 
 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 _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

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
ILIAS Style Content DomainService $content_style_domain
 
ilNewsService $news
 
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
 
- 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
 
int $id
 
bool $referenced
 
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 = ""
 
bool $offline = false
 
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)
 Apply container user filter on objects. More...
 
 filterObjIdsByCopyright (array $obj_ids, string $copyright_id)
 
 filterObjIdsByDefaultCopyright (array $obj_ids, string $default_identifier)
 
 legacyOnlineFilter (array $obj_ids, array $objects, int $val)
 Legacy online filter. More...
 
- 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 50 of file class.ilObjOrgUnit.php.

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

51  {
52  global $DIC;
53 
54  $this->ilDb = $DIC->database();
55  $this->type = "orgu";
56  $this->ilAppEventHandler = $DIC->event();
57  $this->rbacreview = $DIC->rbac()->review();
58  $this->rbacadmin = $DIC->rbac()->admin();
59 
60  parent::__construct($a_id, $a_call_by_reference);
61  }
ilAppEventHandler
Global event handler.
Definition: class.ilAppEventHandler.php:51
$DIC
global $DIC
Definition: feed.php:28
ILIAS\GlobalScreen\Provider\__construct
__construct(Container $dic, ilPlugin $plugin)
Definition: PluginProviderHelper.php:37
+ 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 340 of file class.ilObjOrgUnit.php.

Referenced by ilOrgUnitImporter\buildRef().

340  : bool
341  {
342  return parent::_exists($id, $isReference, "orgu");
343  }
+ 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 469 of file class.ilObjOrgUnit.php.

References $query, and ilObject\getId().

Referenced by getTranslations().

469  : void
470  {
471  if (empty($a_title)) {
472  $a_title = "NO TITLE";
473  }
474 
475  $query = "INSERT INTO object_translation " . "(obj_id,title,description,lang_code,lang_default) " . "VALUES " . "("
476  . $this->ilDb->quote($this->getId(), 'integer') . "," . $this->ilDb->quote(
477  $a_title,
478  'text'
479  ) . "," . $this->ilDb->quote($a_desc, 'text') . ","
480  . $this->ilDb->quote($a_lang, 'text') . "," . $this->ilDb->quote($a_lang_default, 'integer') . ")";
481  $this->ilDb->manipulate($query);
482  }
$query
$query
Definition: proxy_ylocal.php:13
+ 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 228 of file class.ilObjOrgUnit.php.

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

228  : void
229  {
230  $position_id = ilOrgUnitPosition::getCorePositionId(ilOrgUnitPosition::CORE_POSITION_EMPLOYEE);
231 
232  foreach ($user_ids as $user_id) {
233  ilOrgUnitUserAssignment::findOrCreateAssignment($user_id, $position_id, $this->getRefId());
234 
235  $this->ilAppEventHandler->raise('Modules/OrgUnit', 'assignUsersToEmployeeRole', array(
236  'object' => $this,
237  'obj_id' => $this->getId(),
238  'ref_id' => $this->getRefId(),
239  'position_id' => $position_id,
240  'user_id' => $user_id,
241  ));
242  }
243  }
ilOrgUnitUserAssignment\findOrCreateAssignment
static findOrCreateAssignment(int $user_id, int $position_id, int $orgu_id)
Definition: class.ilOrgUnitUserAssignment.php:64
ilAppEventHandler
Global event handler.
Definition: class.ilAppEventHandler.php:51
ilOrgUnitPosition\getCorePositionId
static getCorePositionId(int $core_identifier)
Definition: class.ilOrgUnitPosition.php:49
ilAppEventHandler\raise
raise(string $a_component, string $a_event, array $a_parameter=[])
Raise an event.
Definition: class.ilAppEventHandler.php:102
+ 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 249 of file class.ilObjOrgUnit.php.

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

249  : void
250  {
251  $position_id = ilOrgUnitPosition::getCorePositionId(ilOrgUnitPosition::CORE_POSITION_SUPERIOR);
252 
253  foreach ($user_ids as $user_id) {
254  ilOrgUnitUserAssignment::findOrCreateAssignment($user_id, $position_id, $this->getRefId());
255 
256  $this->ilAppEventHandler->raise('Modules/OrgUnit', 'assignUsersToSuperiorRole', array(
257  'object' => $this,
258  'obj_id' => $this->getId(),
259  'ref_id' => $this->getRefId(),
260  'position_id' => $position_id,
261  'user_id' => $user_id,
262  ));
263  }
264  }
ilOrgUnitUserAssignment\findOrCreateAssignment
static findOrCreateAssignment(int $user_id, int $position_id, int $orgu_id)
Definition: class.ilOrgUnitUserAssignment.php:64
ilAppEventHandler
Global event handler.
Definition: class.ilAppEventHandler.php:51
ilOrgUnitPosition\getCorePositionId
static getCorePositionId(int $core_identifier)
Definition: class.ilOrgUnitPosition.php:49
ilAppEventHandler\raise
raise(string $a_component, string $a_event, array $a_parameter=[])
Raise an event.
Definition: class.ilAppEventHandler.php:102
+ 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 297 of file class.ilObjOrgUnit.php.

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

297  : bool
298  {
299  $arrLocalRoles = $this->rbacreview->getLocalRoles($this->getRefId());
300  if (!in_array($role_id, $arrLocalRoles)) {
301  return false;
302  }
303 
304  $return = $this->rbacadmin->assignUser($role_id, $user_id);
305 
306  $this->ilAppEventHandler->raise('Modules/OrgUnit', 'assignUserToLocalRole', array(
307  'object' => $this,
308  'obj_id' => $this->getId(),
309  'ref_id' => $this->getRefId(),
310  'role_id' => $role_id,
311  'user_id' => $user_id,
312  ));
313 
314  return $return;
315  }
ilAppEventHandler
Global event handler.
Definition: class.ilAppEventHandler.php:51
ilAppEventHandler\raise
raise(string $a_component, string $a_event, array $a_parameter=[])
Raise an event.
Definition: class.ilAppEventHandler.php:102
+ Here is the call graph for this function:

◆ create()

ilObjOrgUnit::create ( )

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

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

75  : int
76  {
77  $id = parent::create();
78  $this->ilDb->insert(self::TABLE_NAME, array(
79  'orgu_type_id' => array('integer', $this->getOrgUnitTypeId()),
80  'orgu_id' => array('integer', $this->getId()),
81  ));
82  return $id;
83  }
+ Here is the call graph for this function:

◆ deassignUserFromEmployeeRole()

ilObjOrgUnit::deassignUserFromEmployeeRole ( int  $user_id)

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

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

266  : void
267  {
268  $position_id = ilOrgUnitPosition::getCorePositionId(ilOrgUnitPosition::CORE_POSITION_EMPLOYEE);
269  ilOrgUnitUserAssignment::findOrCreateAssignment($user_id, $position_id, $this->getRefId())->delete();
270 
271  $this->ilAppEventHandler->raise('Modules/OrgUnit', 'deassignUserFromEmployeeRole', array(
272  'object' => $this,
273  'obj_id' => $this->getId(),
274  'ref_id' => $this->getRefId(),
275  'position_id' => $position_id,
276  'user_id' => $user_id,
277  ));
278  }
ilOrgUnitUserAssignment\findOrCreateAssignment
static findOrCreateAssignment(int $user_id, int $position_id, int $orgu_id)
Definition: class.ilOrgUnitUserAssignment.php:64
ilAppEventHandler
Global event handler.
Definition: class.ilAppEventHandler.php:51
ilOrgUnitPosition\getCorePositionId
static getCorePositionId(int $core_identifier)
Definition: class.ilOrgUnitPosition.php:49
ilAppEventHandler\raise
raise(string $a_component, string $a_event, array $a_parameter=[])
Raise an event.
Definition: class.ilAppEventHandler.php:102
+ 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 320 of file class.ilObjOrgUnit.php.

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

320  : bool
321  {
322  $arrLocalRoles = $this->rbacreview->getLocalRoles($this->getRefId());
323  if (!in_array($role_id, $arrLocalRoles)) {
324  return false;
325  }
326 
327  $return = $this->rbacadmin->deassignUser($role_id, $user_id);
328 
329  $this->ilAppEventHandler->raise('Modules/OrgUnit', 'deassignUserFromLocalRole', array(
330  'object' => $this,
331  'obj_id' => $this->getId(),
332  'ref_id' => $this->getRefId(),
333  'role_id' => $role_id,
334  'user_id' => $user_id,
335  ));
336 
337  return $return;
338  }
ilAppEventHandler
Global event handler.
Definition: class.ilAppEventHandler.php:51
ilAppEventHandler\raise
raise(string $a_component, string $a_event, array $a_parameter=[])
Raise an event.
Definition: class.ilAppEventHandler.php:102
+ Here is the call graph for this function:

◆ deassignUserFromSuperiorRole()

ilObjOrgUnit::deassignUserFromSuperiorRole ( int  $user_id)

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

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

280  : void
281  {
282  $position_id = ilOrgUnitPosition::getCorePositionId(ilOrgUnitPosition::CORE_POSITION_SUPERIOR);
283  ilOrgUnitUserAssignment::findOrCreateAssignment($user_id, $position_id, $this->getRefId())->delete();
284 
285  $this->ilAppEventHandler->raise('Modules/OrgUnit', 'deassignUserFromSuperiorRole', array(
286  'object' => $this,
287  'obj_id' => $this->getId(),
288  'ref_id' => $this->getRefId(),
289  'position_id' => $position_id,
290  'user_id' => $user_id,
291  ));
292  }
ilOrgUnitUserAssignment\findOrCreateAssignment
static findOrCreateAssignment(int $user_id, int $position_id, int $orgu_id)
Definition: class.ilOrgUnitUserAssignment.php:64
ilAppEventHandler
Global event handler.
Definition: class.ilAppEventHandler.php:51
ilOrgUnitPosition\getCorePositionId
static getCorePositionId(int $core_identifier)
Definition: class.ilOrgUnitPosition.php:49
ilAppEventHandler\raise
raise(string $a_component, string $a_event, array $a_parameter=[])
Raise an event.
Definition: class.ilAppEventHandler.php:102
+ 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 406 of file class.ilObjOrgUnit.php.

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

406  : bool
407  {
408  // always call parent delete function first!!
409  if (!parent::delete()) {
410  return false;
411  }
412 
413  // put here category specific stuff
414  ilObjUserFolder::_updateUserFolderAssignment($this->ref_id, USER_FOLDER_ID);
415 
416  $query = "DELETE FROM object_translation WHERE obj_id = " . $this->ilDb->quote($this->getId(), 'integer');
417  $this->ilDb->manipulate($query);
418 
419  $this->ilAppEventHandler->raise('Modules/OrgUnit', 'delete', array(
420  'object' => $this,
421  'obj_id' => $this->getId(),
422  ));
423 
424  $sql = 'DELETE FROM ' . self::TABLE_NAME . ' WHERE orgu_id = ' . $this->ilDb->quote($this->getId(), 'integer');
425  $this->ilDb->manipulate($sql);
426 
427  $path = ilOrgUnitPathStorage::find($this->getRefId());
428  if ($path instanceof ilOrgUnitPathStorage) {
429  $path->delete();
430  }
431 
432  // Delete all position assignments to this object.
433  $assignments = ilOrgUnitUserAssignment::where(array(
434  'orgu_id' => $this->getRefId(),
435  ))->get();
436  foreach ($assignments as $assignment) {
437  $assignment->delete();
438  }
439 
440  return true;
441  }
ilAppEventHandler
Global event handler.
Definition: class.ilAppEventHandler.php:51
USER_FOLDER_ID
const USER_FOLDER_ID
Definition: constants.php:33
ilObjUserFolder\_updateUserFolderAssignment
static _updateUserFolderAssignment(int $a_old_id, int $a_new_id)
Update user folder assignment Typically called after deleting a category with local user accounts...
Definition: class.ilObjUserFolder.php:596
ActiveRecord\where
static where($where, $operator=null)
Definition: class.ActiveRecord.php:480
$path
$path
Definition: ltiservices.php:32
$query
$query
Definition: proxy_ylocal.php:13
ilAppEventHandler\raise
raise(string $a_component, string $a_event, array $a_parameter=[])
Raise an event.
Definition: class.ilAppEventHandler.php:102
+ Here is the call graph for this function:

◆ deleteTranslation()

ilObjOrgUnit::deleteTranslation ( string  $a_lang)

remove translations of current OrgUnit

Parameters
$a_langstring en|de|...

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

References $query, and ilObject\getId().

456  : void
457  {
458  $query = "DELETE FROM object_translation WHERE obj_id= " . $this->quote(
459  $this->getId(),
460  'integer'
461  ) . " AND lang_code = "
462  . $this->quote($a_lang, 'text');
463  $this->ilDb->manipulate($query);
464  }
$query
$query
Definition: proxy_ylocal.php:13
+ 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 172 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().

172  : array
173  {
174  if (is_array(self::$icons_cache)) {
175  return self::$icons_cache;
176  }
177  global $DIC;
178  $ilDb = $DIC->database();
179  $sql = 'SELECT orgu_id, ot.id AS type_id FROM orgu_data
180  INNER JOIN orgu_types AS ot ON (ot.id = orgu_data.orgu_type_id)
181  WHERE ot.icon IS NOT NULL';
182  $set = $ilDb->query($sql);
183  $icons_cache = array();
184  while ($row = $ilDb->fetchObject($set)) {
185  $type = ilOrgUnitType::getInstance($row->type_id);
186  if ($type && is_file($type->getIconPath(true))) {
187  $icons_cache[$row->orgu_id] = $type->getIconPath(true);
188  }
189  }
190  self::$icons_cache = $icons_cache;
191 
192  return $icons_cache;
193  }
ilObject\$type
string $type
Definition: class.ilObject.php:56
ilObjOrgUnit\$icons_cache
static array $icons_cache
Cache storing OrgUnit objects that have OrgUnit types with custom icons assigned. ...
Definition: class.ilObjOrgUnit.php:40
ilObjOrgUnit\$ilDb
ilDBInterface $ilDb
Definition: class.ilObjOrgUnit.php:32
$DIC
global $DIC
Definition: feed.php:28
ilDBInterface\fetchObject
fetchObject(ilDBStatement $query_result)
ilDBInterface\query
query(string $query)
Run a (read-only) Query on the database.
ilOrgUnitType\getInstance
static getInstance(int $a_id)
Get instance of an ilOrgUnitType object Returns object from cache or from database, returns null if no object was found.
Definition: class.ilOrgUnitType.php:75
+ 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 357 of file class.ilObjOrgUnit.php.

References ILIAS\Repository\lng().

357  : string
358  {
359  if (parent::getTitle() === "__OrgUnitAdministration") {
360  return $this->lng->txt("obj_orgu_description");
361  } else {
362  return parent::getLongDescription();
363  }
364  }
+ Here is the call graph for this function:

◆ getOrgUnitType()

ilObjOrgUnit::getOrgUnitType ( )

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

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

Referenced by update().

125  : ?ilOrgUnitType
126  {
127  return ilOrgUnitType::getInstance($this->getOrgUnitTypeId());
128  }
ilOrgUnitType
This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Le...
Definition: class.ilOrgUnitType.php:24
ilOrgUnitType\getInstance
static getInstance(int $a_id)
Get instance of an ilOrgUnitType object Returns object from cache or from database, returns null if no object was found.
Definition: class.ilOrgUnitType.php:75
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getOrgUnitTypeId()

ilObjOrgUnit::getOrgUnitTypeId ( )

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

References $orgu_type_id.

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

120  : int
121  {
122  return $this->orgu_type_id;
123  }
ilObjOrgUnit\$orgu_type_id
int $orgu_type_id
ID of assigned OrgUnit type.
Definition: class.ilObjOrgUnit.php:44
+ Here is the caller graph for this function:

◆ getRootOrgId()

static ilObjOrgUnit::getRootOrgId ( )
static

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

Referenced by ilOrgUnitExporter\sendAndCreateSimpleExportFile().

202  : int
203  {
204  self::loadRootOrgRefIdAndId();
205 
206  return self::$root_id;
207  }
+ Here is the caller graph for this function:

◆ getRootOrgRefId()

static ilObjOrgUnit::getRootOrgRefId ( )
static

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

Referenced by ilOrgUnitExportGUI\__construct(), ilOrgUnitSimpleImportGUI\__construct(), ilObjOrgUnitGUI\addAdminLocatorItems(), 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(), ilOrgUnitRecursiveUserAssignmentTableGUI\loadData(), ilOrgUnitRecursiveUserAssignmentTableGUI\mayViewLPIn(), ilOrgUnitExporter\sendAndCreateSimpleExportFile(), ilObjOrgUnitGUI\setContentSubTabs(), ilOrgUnitExtensionGUI\setLocator(), ilOrgUnitExporter\simpleExport(), ilOrgUnitExporter\simpleExportExcel(), ilOrgUnitExportGUI\simpleExportExcel(), and ilOrgUnitSimpleImport\simpleImportElement().

195  : int
196  {
197  self::loadRootOrgRefIdAndId();
198 
199  return self::$root_ref_id;
200  }
+ Here is the caller graph for this function:

◆ getTitle()

ilObjOrgUnit::getTitle ( )

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

References ILIAS\Repository\lng().

Referenced by getTranslations().

345  : string
346  {
347  if (parent::getTitle() !== "__OrgUnitAdministration") {
348  return parent::getTitle();
349  } else {
350  return $this->lng->txt("objs_orgu");
351  }
352  }
+ 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 369 of file class.ilObjOrgUnit.php.

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

370  {
371  $q = "SELECT * FROM object_translation WHERE obj_id = " . $this->ilDb->quote(
372  $this->getId(),
373  'integer'
374  ) . " ORDER BY lang_default DESC";
375  $r = $this->db->query($q);
376 
377  $data = [];
378  while ($row = $r->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
379  $data[$row->lang_code] = array(
380  "title" => $row->title,
381  "desc" => $row->description,
382  "lang" => $row->lang_code,
383  'default' => $row->lang_default,
384  );
385  }
386 
387  $translations = $data;
388 
389  if (!count($translations)) {
390  $this->addTranslation($this->getTitle(), "", $this->lng->getDefaultLanguage(), true);
391  $translations[$this->lng->getDefaultLanguage()] = array(
392  "title" => $this->getTitle(),
393  "desc" => "",
394  "lang" => $this->lng->getDefaultLanguage(),
395  );
396  }
397 
398  return $translations;
399  }
ilObjOrgUnit\addTranslation
addTranslation(string $a_title, string $a_desc, string $a_lang, string $a_lang_default)
add a new translation to current OrgUnit
Definition: class.ilObjOrgUnit.php:469
+ Here is the call graph for this function:

◆ loadRootOrgRefIdAndId()

static ilObjOrgUnit::loadRootOrgRefIdAndId ( )
staticprivate

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

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

209  : void
210  {
211  if (self::$root_ref_id === 0 || self::$root_id === 0) {
212  global $DIC;
213  $ilDb = $DIC['ilDB'];
214  $q = "SELECT o.obj_id, r.ref_id FROM object_data o
215  INNER JOIN object_reference r ON r.obj_id = o.obj_id
216  WHERE title = " . $ilDb->quote('__OrgUnitAdministration', 'text') . "";
217  $set = $ilDb->query($q);
218  $res = $ilDb->fetchAssoc($set);
219  self::$root_id = (int) $res["obj_id"];
220  self::$root_ref_id = (int) $res["ref_id"];
221  }
222  }
$res
$res
Definition: ltiservices.php:69
ilDBInterface\fetchAssoc
fetchAssoc(ilDBStatement $statement)
ilDBInterface\quote
quote($value, string $type)
ilObjOrgUnit\$ilDb
ilDBInterface $ilDb
Definition: class.ilObjOrgUnit.php:32
$DIC
global $DIC
Definition: feed.php:28
ilDBInterface\query
query(string $query)
Run a (read-only) Query on the database.
+ Here is the call graph for this function:

◆ removeTranslations()

ilObjOrgUnit::removeTranslations ( )

remove all Translations of current OrgUnit

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

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

446  : void
447  {
448  $query = "DELETE FROM object_translation WHERE obj_id= " . $this->ilDb->quote($this->getId(), 'integer');
449  $res = $this->ilDb->manipulate($query);
450  }
$res
$res
Definition: ltiservices.php:69
$query
$query
Definition: proxy_ylocal.php:13
+ Here is the call graph for this function:

◆ setOrgUnitTypeId()

ilObjOrgUnit::setOrgUnitTypeId ( int  $a_id)

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

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

Referenced by __construct().

130  : void
131  {
132  $this->orgu_type_id = $a_id;
133  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ update()

ilObjOrgUnit::update ( )

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

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

85  : bool
86  {
87  parent::update();
88  $sql = 'SELECT * FROM ' . self::TABLE_NAME . ' WHERE orgu_id = ' . $this->ilDb->quote(
89  $this->getId(),
90  'integer'
91  );
92  $set = $this->ilDb->query($sql);
93  if ($this->ilDb->numRows($set)) {
94  $this->ilDb->update(self::TABLE_NAME, array(
95  'orgu_type_id' => array('integer', $this->getOrgUnitTypeId()),
96  ), array(
97  'orgu_id' => array('integer', $this->getId()),
98  ));
99  } else {
100  $this->ilDb->insert(self::TABLE_NAME, array(
101  'orgu_type_id' => array('integer', $this->getOrgUnitTypeId()),
102  'orgu_id' => array('integer', $this->getId()),
103  ));
104  }
105  // Update selection for advanced meta data of the type
106  if ($this->getOrgUnitTypeId()) {
107  ilAdvancedMDRecord::saveObjRecSelection(
108  $this->getId(),
109  'orgu_type',
110  $this->getOrgUnitType()->getAssignedAdvancedMDRecordIds()
111  );
112  } else {
113  // If no type is assigned, delete relations by passing an empty array
114  ilAdvancedMDRecord::saveObjRecSelection($this->getId(), 'orgu_type', array());
115  }
116 
117  return true;
118  }
ilAdvancedMDRecord\saveObjRecSelection
static saveObjRecSelection(int $a_obj_id, string $a_sub_type="", array $a_records=null, bool $a_delete_before=true)
Save repository object record selection.
Definition: class.ilAdvancedMDRecord.php:759
+ 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 487 of file class.ilObjOrgUnit.php.

References $query, and ilObject\getId().

487  : void
488  {
489  if (empty($title)) {
490  $a_title = "NO TITLE";
491  }
492 
493  $query = "UPDATE object_translation SET ";
494 
495  $query .= " title = " . $this->ilDb->quote($title, 'text');
496 
497  if ($desc !== "") {
498  $query .= ", description = " . $this->ilDb->quote($desc, 'text') . " ";
499  }
500 
501  $query .= ", lang_default = " . $this->ilDb->quote($lang_default, 'integer') . " ";
502 
503  $query .= " WHERE obj_id = " . $this->ilDb->quote(
504  $this->getId(),
505  'integer'
506  ) . " AND lang_code = " . $this->ilDb->quote($lang, 'text');
507  $this->ilDb->manipulate($query);
508  }
ilObject\$title
string $title
Definition: class.ilObject.php:57
ilObject\$desc
string $desc
Definition: class.ilObject.php:59
$query
$query
Definition: proxy_ylocal.php:13
$lang
$lang
Definition: xapiexit.php:26
+ Here is the call graph for this function:

◆ writePath()

ilObjOrgUnit::writePath ( )

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

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

510  : void
511  {
512  if ($this->getRefId()) {
513  ilOrgUnitPathStorage::writePathByRefId($this->getRefId());
514  } else {
515  throw new \LogicException('No ref_id on OrgU with id ' . $this->getId(), 1);
516  }
517  }
+ 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 48 of file class.ilObjOrgUnit.php.

Referenced by setOrgUnitTypeId().

◆ $icons_cache

array ilObjOrgUnit::$icons_cache = null
staticprotected

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

Definition at line 40 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 44 of file class.ilObjOrgUnit.php.

Referenced by getOrgUnitTypeId().

◆ $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: