ILIAS  release_5-4 Revision v5.4.26-12-gabc799a52e6
ilObjOrgUnit Class Reference

Class ilObjOrgUnit. More...

+ 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)
 Adds the user ids to the position employee. More...
 
 assignUsersToSuperiorRole ($user_ids)
 Adds the user ids to the position superior. More...
 
 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...
 
 getTitle ()
 Return title. More...
 
 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 ($a_lang)
 remove translations of current OrgUnit More...
 
 addTranslation ($a_title, $a_desc, $a_lang, $a_lang_default)
 add a new translation to current OrgUnit More...
 
 updateTranslation ($a_title, $a_desc, $a_lang, $a_lang_default)
 update a translation to current OrgUnit More...
 
 writePath ()
 
- Public Member Functions inherited from ilContainer
 __construct ($a_id=0, $a_reference=true)
 
 getObjectTranslation ()
 Get object translation. More...
 
 setObjectTranslation (ilObjectTranslation $obj_trans)
 Get object translation. More...
 
 createContainerDirectory ()
 Create directory for the container. More...
 
 getContainerDirectory ()
 Get the container directory. 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...
 
 setNewsTimeline ($a_val)
 Set news timeline. More...
 
 getNewsTimeline ()
 Get news timeline. More...
 
 setNewsTimelineAutoEntries ($a_val)
 Set news timeline auto entries. More...
 
 getNewsTimelineAutoEntries ()
 Get news timeline auto entries. More...
 
 setNewsTimelineLandingPage ($a_val)
 Set news timline is landing page. More...
 
 getNewsTimelineLandingPage ()
 Get news timline is landing page. More...
 
 isNewsTimelineEffective ()
 Is news timeline effective? More...
 
 isNewsTimelineLandingPageEffective ()
 Is news timeline landing page effective? More...
 
 setNewsBlockActivated ($a_val)
 Set news block activated. More...
 
 getNewsBlockActivated ()
 Get news block activated. More...
 
 setUseNews ($a_val)
 Set use news. More...
 
 getUseNews ()
 Get use news. 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...
 
 delete ()
 delete category and all related data 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...
 
 putInTree ($a_parent_ref)
 
 update ()
 Update. More...
 
 read ()
 read More...
 
 readContainerSettings ()
 Read container settings. More...
 
 removeTranslations ()
 Remove all translations of container. More...
 
 deleteTranslation ($a_lang)
 Delete translation. More...
 
 addTranslation ($a_title, $a_desc, $a_lang, $a_lang_default)
 Add translation. More...
 
- Public Member Functions inherited from ilObject
 __construct ($a_id=0, $a_reference=true)
 Constructor public. More...
 
 withReferences ()
 determines wehter objects are referenced or not (got ref ids or not) More...
 
 read ()
 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...
 
 setOfflineStatus ($a_status)
 Set offline status. More...
 
 getOfflineStatus ()
 Get offline status. More...
 
 supportsOfflineHandling ()
 Check whether object supports offline handling. More...
 
 getOwner ()
 get object owner More...
 
 getOwnerName ()
 
 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...
 
 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...
 
 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...
 
 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...
 
 setRegisterMode ($a_bool)
 
 isUserRegistered ($a_user_id=0)
 
 requireRegistration ()
 
 getXMLZip ()
 
 getHTMLDirectory ()
 
 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...
 
 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, $type="orgu")
 
- Static Public Member Functions inherited from ilContainer
static _getContainerDirectory ($a_id)
 Get the container directory. More...
 
static _lookupContainerSetting ($a_id, $a_keyword, $a_default_value=null)
 Lookup a container setting. More...
 
static _writeContainerSetting ($a_id, $a_keyword, $a_value)
 
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 _lookupOwnerName ($a_owner_id)
 lookup owner name for owner id More...
 
static _getIdForImportId ($a_import_id)
 get current object id for import id (static) More...
 
static _getAllReferences ($a_id)
 get all reference ids of object More...
 
static _lookupTitle ($a_id)
 lookup object title More...
 
static lookupOfflineStatus ($a_obj_id)
 Lookup offline status using objectDataCache. More...
 
static _lookupOwner ($a_id)
 lookup object owner More...
 
static _getIdsForTitle ($title, $type='', $partialmatch=false)
 
static _lookupDescription ($a_id)
 lookup object description More...
 
static _lookupLastUpdate ($a_id, $a_as_string=false)
 lookup last update More...
 
static _getLastUpdateOfObjects ($a_objs)
 Get last update for a set of media objects. More...
 
static _lookupObjId ($a_id)
 
static _setDeletedDate ($a_ref_id)
 only called in ilTree::saveSubTree More...
 
static setDeletedDates ($a_ref_ids)
 Set deleted date. More...
 
static _resetDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes More...
 
static _lookupDeletedDate ($a_ref_id)
 only called in ilObjectGUI::insertSavedNodes More...
 
static _writeTitle ($a_obj_id, $a_title)
 write title to db (static) More...
 
static _writeDescription ($a_obj_id, $a_desc)
 write description to db (static) More...
 
static _writeImportId ($a_obj_id, $a_import_id)
 write import id to db (static) More...
 
static _lookupType ($a_id, $a_reference=false)
 lookup object type More...
 
static _isInTrash ($a_ref_id)
 checks wether object is in trash More...
 
static _hasUntrashedReference ($a_obj_id)
 checks wether an object has at least one reference that is not in trash More...
 
static _lookupObjectId ($a_ref_id)
 lookup object id More...
 
static _getObjectsDataForType ($a_type, $a_omit_trash=false)
 get all objects of a certain type 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 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 _lookupCreationDate ($a_id)
 Lookup creation date. 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
 
 $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
 

Protected Attributes

 $orgu_type_id = 0
 
 $amd_data
 
- Protected Attributes inherited from ilContainer
 $db
 
 $log
 
 $access
 
 $error
 
 $rbacsystem
 
 $tree
 
 $user
 
 $obj_definition
 
 $order_type = 0
 
 $hiddenfilesfound = false
 
 $news_timeline = false
 
 $news_timeline_auto_entries = false
 
 $setting
 
 $obj_trans = null
 
- Protected Attributes inherited from ilObject
 $objDefinition
 
 $db
 
 $log
 
 $error
 
 $tree
 
 $app_event_handler
 
 $rbacadmin
 
 $rbacreview
 

Static Protected Attributes

static $root_ref_id
 
static $root_id
 
static $icons_cache
 

Static Private Member Functions

static loadRootOrgRefIdAndId ()
 

Additional Inherited Members

- Static Public Attributes inherited from ilContainer
static $data_preloaded = false
 

Detailed Description

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

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

51  {
52  $this->type = "orgu";
53  parent::__construct($a_id, $a_call_by_reference);
54  }
+ Here is the call graph for this function:

Member Function Documentation

◆ _exists()

static ilObjOrgUnit::_exists (   $a_id,
  $a_reference = false,
  $type = "orgu" 
)
static
Parameters
$a_id
bool$a_reference
string$type
Returns
bool

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

Referenced by ilOrgUnitImporter\buildRef().

409  {
410  return parent::_exists($a_id, $a_reference, "orgu");
411  }
+ Here is the caller graph for this function:

◆ addTranslation()

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

add a new translation to current OrgUnit

Parameters
$a_title
$a_desc
$a_lang
$a_lang_default
Returns
bool

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

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

Referenced by getTranslations().

572  {
573  global $DIC;
574  $ilDB = $DIC['ilDB'];
575 
576  if (empty($a_title)) {
577  $a_title = "NO TITLE";
578  }
579 
580  $query = "INSERT INTO object_translation " . "(obj_id,title,description,lang_code,lang_default) " . "VALUES " . "("
581  . $ilDB->quote($this->getId(), 'integer') . "," . $ilDB->quote($a_title, 'text') . "," . $ilDB->quote($a_desc, 'text') . ","
582  . $ilDB->quote($a_lang, 'text') . "," . $ilDB->quote($a_lang_default, 'integer') . ")";
583  $res = $ilDB->manipulate($query);
584 
585  return true;
586  }
global $DIC
Definition: saml.php:7
foreach($_POST as $key=> $value) $res
getId()
get object id public
$query
global $ilDB
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ assignUsersToEmployeeRole()

ilObjOrgUnit::assignUsersToEmployeeRole (   $user_ids)

Adds the user ids to the position employee.

Parameters
$user_ids

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

References $DIC, ilOrgUnitPosition\CORE_POSITION_EMPLOYEE, ilOrgUnitUserAssignment\findOrCreateAssignment(), ilOrgUnitPosition\getCorePositionId(), ilObject\getId(), and ilObject\getRefId().

253  {
254  global $DIC;
255  $ilAppEventHandler = $DIC['ilAppEventHandler'];
257 
258  foreach ($user_ids as $user_id) {
259  ilOrgUnitUserAssignment::findOrCreateAssignment($user_id, $position_id, $this->getRefId());
260 
261  $ilAppEventHandler->raise('Modules/OrgUnit', 'assignUsersToEmployeeRole', array(
262  'object' => $this,
263  'obj_id' => $this->getId(),
264  'ref_id' => $this->getRefId(),
265  'position_id' => $position_id,
266  'user_id' => $user_id,
267  ));
268  }
269  }
global $DIC
Definition: saml.php:7
static findOrCreateAssignment($user_id, $position_id, $orgu_id)
static getCorePositionId($core_identifier)
getId()
get object id public
getRefId()
get reference id public
+ Here is the call graph for this function:

◆ assignUsersToSuperiorRole()

ilObjOrgUnit::assignUsersToSuperiorRole (   $user_ids)

Adds the user ids to the position superior.

Parameters
$user_ids

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

References $DIC, ilOrgUnitPosition\CORE_POSITION_SUPERIOR, ilOrgUnitUserAssignment\findOrCreateAssignment(), ilOrgUnitPosition\getCorePositionId(), ilObject\getId(), and ilObject\getRefId().

278  {
279  global $DIC;
280  $ilAppEventHandler = $DIC['ilAppEventHandler'];
282 
283  foreach ($user_ids as $user_id) {
284  ilOrgUnitUserAssignment::findOrCreateAssignment($user_id, $position_id, $this->getRefId());
285 
286  $ilAppEventHandler->raise('Modules/OrgUnit', 'assignUsersToSuperiorRole', array(
287  'object' => $this,
288  'obj_id' => $this->getId(),
289  'ref_id' => $this->getRefId(),
290  'position_id' => $position_id,
291  'user_id' => $user_id,
292  ));
293  }
294  }
global $DIC
Definition: saml.php:7
static findOrCreateAssignment($user_id, $position_id, $orgu_id)
static getCorePositionId($core_identifier)
getId()
get object id public
getRefId()
get reference id public
+ 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 341 of file class.ilObjOrgUnit.php.

References $DIC, ilObject\$rbacadmin, ilObject\$rbacreview, ilObject\getId(), and ilObject\getRefId().

342  {
343  global $DIC;
344  $rbacreview = $DIC['rbacreview'];
345  $rbacadmin = $DIC['rbacadmin'];
346  $ilAppEventHandler = $DIC['ilAppEventHandler'];
347 
348  $arrLocalRoles = $rbacreview->getLocalRoles($this->getRefId());
349  if (!in_array($role_id, $arrLocalRoles)) {
350  return false;
351  }
352 
353  $return = $rbacadmin->assignUser($role_id, $user_id);
354 
355  $ilAppEventHandler->raise('Modules/OrgUnit', 'assignUserToLocalRole', array(
356  'object' => $this,
357  'obj_id' => $this->getId(),
358  'ref_id' => $this->getRefId(),
359  'role_id' => $role_id,
360  'user_id' => $user_id,
361  ));
362 
363  return $return;
364  }
global $DIC
Definition: saml.php:7
getId()
get object id public
getRefId()
get reference id public
+ Here is the call graph for this function:

◆ create()

ilObjOrgUnit::create ( )

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

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

73  {
74  global $DIC;
75  $ilDB = $DIC['ilDB'];
76  parent::create();
77  $ilDB->insert(self::TABLE_NAME, array(
78  'orgu_type_id' => array( 'integer', $this->getOrgUnitTypeId() ),
79  'orgu_id' => array( 'integer', $this->getId() ),
80  ));
81  }
global $DIC
Definition: saml.php:7
getId()
get object id public
global $ilDB
+ Here is the call graph for this function:

◆ deassignUserFromEmployeeRole()

ilObjOrgUnit::deassignUserFromEmployeeRole (   $user_id)

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

References $DIC, ilOrgUnitPosition\CORE_POSITION_EMPLOYEE, ilOrgUnitUserAssignment\findOrCreateAssignment(), ilOrgUnitPosition\getCorePositionId(), ilObject\getId(), and ilObject\getRefId().

298  {
299  global $DIC;
301 
302  $ilAppEventHandler = $DIC['ilAppEventHandler'];
303  ilOrgUnitUserAssignment::findOrCreateAssignment($user_id, $position_id, $this->getRefId())->delete();
304 
305  $ilAppEventHandler->raise('Modules/OrgUnit', 'deassignUserFromEmployeeRole', array(
306  'object' => $this,
307  'obj_id' => $this->getId(),
308  'ref_id' => $this->getRefId(),
309  'position_id' => $position_id,
310  'user_id' => $user_id,
311  ));
312  }
global $DIC
Definition: saml.php:7
static findOrCreateAssignment($user_id, $position_id, $orgu_id)
static getCorePositionId($core_identifier)
getId()
get object id public
getRefId()
get reference id public
+ 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 375 of file class.ilObjOrgUnit.php.

References $DIC, ilObject\$rbacadmin, ilObject\$rbacreview, ilObject\getId(), and ilObject\getRefId().

376  {
377  global $DIC;
378  $rbacreview = $DIC['rbacreview'];
379  $rbacadmin = $DIC['rbacadmin'];
380  $ilAppEventHandler = $DIC['ilAppEventHandler'];
381 
382  $arrLocalRoles = $rbacreview->getLocalRoles($this->getRefId());
383  if (!in_array($role_id, $arrLocalRoles)) {
384  return false;
385  }
386 
387  $return = $rbacadmin->deassignUser($role_id, $user_id);
388 
389  $ilAppEventHandler->raise('Modules/OrgUnit', 'deassignUserFromLocalRole', array(
390  'object' => $this,
391  'obj_id' => $this->getId(),
392  'ref_id' => $this->getRefId(),
393  'role_id' => $role_id,
394  'user_id' => $user_id,
395  ));
396 
397  return $return;
398  }
global $DIC
Definition: saml.php:7
getId()
get object id public
getRefId()
get reference id public
+ Here is the call graph for this function:

◆ deassignUserFromSuperiorRole()

ilObjOrgUnit::deassignUserFromSuperiorRole (   $user_id)

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

References $DIC, ilOrgUnitPosition\CORE_POSITION_SUPERIOR, ilOrgUnitUserAssignment\findOrCreateAssignment(), ilOrgUnitPosition\getCorePositionId(), ilObject\getId(), and ilObject\getRefId().

316  {
317  global $DIC;
319 
320  $ilAppEventHandler = $DIC['ilAppEventHandler'];
321  ilOrgUnitUserAssignment::findOrCreateAssignment($user_id, $position_id, $this->getRefId())->delete();
322 
323  $ilAppEventHandler->raise('Modules/OrgUnit', 'deassignUserFromSuperiorRole', array(
324  'object' => $this,
325  'obj_id' => $this->getId(),
326  'ref_id' => $this->getRefId(),
327  'position_id' => $position_id,
328  'user_id' => $user_id,
329  ));
330  }
global $DIC
Definition: saml.php:7
static findOrCreateAssignment($user_id, $position_id, $orgu_id)
static getCorePositionId($core_identifier)
getId()
get object id public
getRefId()
get reference id public
+ Here is the call graph for this function:

◆ delete()

ilObjOrgUnit::delete ( )

delete orgunit, childs and all related data

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

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

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

491  {
492  global $DIC;
493  $ilDB = $DIC['ilDB'];
494  $ilAppEventHandler = $DIC['ilAppEventHandler'];
495 
496  // always call parent delete function first!!
497  if (!parent::delete()) {
498  return false;
499  }
500 
501  // put here category specific stuff
503 
504  $query = "DELETE FROM object_translation WHERE obj_id = " . $ilDB->quote($this->getId(), 'integer');
505  $ilDB->manipulate($query);
506 
507  $ilAppEventHandler->raise('Modules/OrgUnit', 'delete', array(
508  'object' => $this,
509  'obj_id' => $this->getId(),
510  ));
511 
512  $sql = 'DELETE FROM ' . self::TABLE_NAME . ' WHERE orgu_id = ' . $ilDB->quote($this->getId(), 'integer');
513  $ilDB->manipulate($sql);
514 
515  $path = ilOrgUnitPathStorage::find($this->getRefId());
516  if ($path instanceof ilOrgUnitPathStorage) {
517  $path->delete();
518  }
519 
520  // Delete all position assignments to this object.
521  $assignments = ilOrgUnitUserAssignment::where(array(
522  'orgu_id' => $this->getRefId(),
523  ))->get();
524  foreach ($assignments as $assignment) {
525  $assignment->delete();
526  }
527 
528  return true;
529  }
static _updateUserFolderAssignment($a_old_id, $a_new_id)
Update user folder assignment Typically called after deleting a category with local user accounts...
$path
Definition: aliased.php:25
global $DIC
Definition: saml.php:7
Class ilOrgUnitPathStorage.
static where($where, $operator=null)
getId()
get object id public
$query
global $ilDB
getRefId()
get reference id public
const USER_FOLDER_ID
Class ilObjUserFolder.
+ Here is the call graph for this function:

◆ deleteTranslation()

ilObjOrgUnit::deleteTranslation (   $a_lang)

remove translations of current OrgUnit

Parameters
$a_langstring en|de|...

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

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

551  {
552  global $DIC;
553  $ilDB = $DIC['ilDB'];
554 
555  $query = "DELETE FROM object_translation WHERE obj_id= " . $ilDB->quote($this->getId(), 'integer') . " AND lang_code = "
556  . $ilDB->quote($a_lang, 'text');
557  $res = $ilDB->manipulate($query);
558  }
global $DIC
Definition: saml.php:7
foreach($_POST as $key=> $value) $res
getId()
get object id public
$query
global $ilDB
+ Here is the call graph for this function:

◆ getLongDescription()

ilObjOrgUnit::getLongDescription ( )

get object long description (stored in object_description)

public

Returns
string object description

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

436  {
437  if (parent::getTitle() == "__OrgUnitAdministration") {
438  return $this->lng->txt("obj_orgu_description");
439  } else {
440  return parent::getLongDescription();
441  }
442  }

◆ getOrgUnitType()

ilObjOrgUnit::getOrgUnitType ( )
Returns
ilOrgUnitType|null

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

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

Referenced by update().

126  {
128  }
static getInstance($a_id)
Public.
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ getOrgUnitTypeId()

ilObjOrgUnit::getOrgUnitTypeId ( )
Returns
int

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

References $orgu_type_id.

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

117  {
118  return $this->orgu_type_id;
119  }
+ Here is the caller graph for this function:

◆ getRootOrgId()

static ilObjOrgUnit::getRootOrgId ( )
static
Returns
int

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

Referenced by ilOrgUnitExporter\sendAndCreateSimpleExportFile().

224  {
225  self::loadRootOrgRefIdAndId();
226 
227  return self::$root_id;
228  }
+ Here is the caller graph for this function:

◆ getRootOrgRefId()

◆ getTitle()

ilObjOrgUnit::getTitle ( )

Return title.

Returns
string

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

Referenced by getTranslations().

420  {
421  if (parent::getTitle() != "__OrgUnitAdministration") {
422  return parent::getTitle();
423  } else {
424  return $this->lng->txt("objs_orgu");
425  }
426  }
+ 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 448 of file class.ilObjOrgUnit.php.

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

449  {
450  global $DIC;
451  $lng = $DIC['lng'];
452  $ilDB = $DIC['ilDB'];
453 
454  $q = "SELECT * FROM object_translation WHERE obj_id = " . $ilDB->quote($this->getId(), 'integer') . " ORDER BY lang_default DESC";
455  $r = $this->db->query($q);
456 
457  $num = 0;
458  $data = [ "Fobject" => [] ];
459  while ($row = $r->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
460  $data["Fobject"][$num] = array(
461  "title" => $row->title,
462  "desc" => $row->description,
463  "lang" => $row->lang_code,
464  'lang_default' => $row->lang_default,
465  );
466  $num++;
467  }
468 
469  $translations = $data;
470 
471  if (!count($translations["Fobject"])) {
472  $this->addTranslation($this->getTitle(), "", $lng->getDefaultLanguage(), true);
473  $translations["Fobject"][] = array(
474  "title" => $this->getTitle(),
475  "desc" => "",
476  "lang" => $lng->getDefaultLanguage(),
477  );
478  }
479 
480  return $translations;
481  }
global $DIC
Definition: saml.php:7
$r
Definition: example_031.php:79
addTranslation($a_title, $a_desc, $a_lang, $a_lang_default)
add a new translation to current OrgUnit
getId()
get object id public
getTitle()
Return title.
$row
global $ilDB
$data
Definition: bench.php:6
+ Here is the call graph for this function:

◆ loadRootOrgRefIdAndId()

static ilObjOrgUnit::loadRootOrgRefIdAndId ( )
staticprivate

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

References $DIC, $ilDB, and $res.

232  {
233  if (self::$root_ref_id === null || self::$root_id === null) {
234  global $DIC;
235  $ilDB = $DIC['ilDB'];
236  $q = "SELECT o.obj_id, r.ref_id FROM object_data o
237  INNER JOIN object_reference r ON r.obj_id = o.obj_id
238  WHERE title = " . $ilDB->quote('__OrgUnitAdministration', 'text') . "";
239  $set = $ilDB->query($q);
240  $res = $ilDB->fetchAssoc($set);
241  self::$root_id = $res["obj_id"];
242  self::$root_ref_id = $res["ref_id"];
243  }
244  }
global $DIC
Definition: saml.php:7
foreach($_POST as $key=> $value) $res
global $ilDB

◆ removeTranslations()

ilObjOrgUnit::removeTranslations ( )

remove all Translations of current OrgUnit

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

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

536  {
537  global $DIC;
538  $ilDB = $DIC['ilDB'];
539 
540  $query = "DELETE FROM object_translation WHERE obj_id= " . $ilDB->quote($this->getId(), 'integer');
541  $res = $ilDB->manipulate($query);
542  }
global $DIC
Definition: saml.php:7
foreach($_POST as $key=> $value) $res
getId()
get object id public
$query
global $ilDB
+ Here is the call graph for this function:

◆ setOrgUnitTypeId()

ilObjOrgUnit::setOrgUnitTypeId (   $a_id)
Parameters
$a_id

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

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

Referenced by __construct().

135  {
136  $this->orgu_type_id = $a_id;
137  }
+ Here is the call graph for this function:
+ Here is the caller graph for this function:

◆ update()

ilObjOrgUnit::update ( )

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

References $DIC, $ilDB, ilObject\getId(), getOrgUnitType(), getOrgUnitTypeId(), ilAdvancedMDRecord\saveObjRecSelection(), and League\Flysystem\Adapter\Polyfill\update().

85  {
86  global $DIC;
87  $ilDB = $DIC['ilDB'];
89  $sql = 'SELECT * FROM ' . self::TABLE_NAME . ' WHERE orgu_id = ' . $ilDB->quote($this->getId(), 'integer');
90  $set = $ilDB->query($sql);
91  if ($ilDB->numRows($set)) {
92  $ilDB->update(self::TABLE_NAME, array(
93  'orgu_type_id' => array( 'integer', $this->getOrgUnitTypeId() ),
94  ), array(
95  'orgu_id' => array( 'integer', $this->getId() ),
96  ));
97  } else {
98  $ilDB->insert(self::TABLE_NAME, array(
99  'orgu_type_id' => array( 'integer', $this->getOrgUnitTypeId() ),
100  'orgu_id' => array( 'integer', $this->getId() ),
101  ));
102  }
103  // Update selection for advanced meta data of the type
104  if ($this->getOrgUnitTypeId()) {
105  ilAdvancedMDRecord::saveObjRecSelection($this->getId(), 'orgu_type', $this->getOrgUnitType()->getAssignedAdvancedMDRecordIds());
106  } else {
107  // If no type is assigned, delete relations by passing an empty array
108  ilAdvancedMDRecord::saveObjRecSelection($this->getId(), 'orgu_type', array());
109  }
110  }
global $DIC
Definition: saml.php:7
static saveObjRecSelection($a_obj_id, $a_sub_type="", array $a_records=null, $a_delete_before=true)
Save repository object record selection.
getId()
get object id public
update($pash, $contents, Config $config)
global $ilDB
+ Here is the call graph for this function:

◆ updateTranslation()

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

update a translation to current OrgUnit

Parameters
$a_title
$a_desc
$a_lang
$a_lang_default
Returns
bool

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

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

600  {
601  global $DIC;
602  $ilDB = $DIC['ilDB'];
603 
604  if (empty($a_title)) {
605  $a_title = "NO TITLE";
606  }
607 
608  $query = "UPDATE object_translation SET ";
609 
610  $query .= " title = " . $ilDB->quote($a_title, 'text');
611 
612  if ($a_desc != "") {
613  $query .= ", description = " . $ilDB->quote($a_desc, 'text') . " ";
614  }
615 
616  if ($a_lang_default) {
617  $query .= ", lang_default = " . $ilDB->quote($a_lang_default, 'integer') . " ";
618  }
619 
620  $query .= " WHERE obj_id = " . $ilDB->quote($this->getId(), 'integer') . " AND lang_code = " . $ilDB->quote($a_lang, 'text');
621  $ilDB->manipulate($query);
622 
623  return true;
624  }
global $DIC
Definition: saml.php:7
getId()
get object id public
$query
global $ilDB
+ Here is the call graph for this function:

◆ writePath()

ilObjOrgUnit::writePath ( )

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

References ilObject\getRefId().

628  {
629  if ($this->getRefId()) {
630  ilOrgUnitPathStorage::writePathByRefId($this->getRefId());
631  }
632  }
getRefId()
get reference id public
+ Here is the call graph for this function:

Field Documentation

◆ $amd_data

ilObjOrgUnit::$amd_data
protected

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

Referenced by setOrgUnitTypeId().

◆ $icons_cache

ilObjOrgUnit::$icons_cache
staticprotected

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

Referenced by setOrgUnitTypeId().

◆ $orgu_type_id

ilObjOrgUnit::$orgu_type_id = 0
protected

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

Referenced by getOrgUnitTypeId().

◆ $root_id

ilObjOrgUnit::$root_id
staticprotected

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

◆ $root_ref_id

ilObjOrgUnit::$root_ref_id
staticprotected

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

◆ TABLE_NAME

const ilObjOrgUnit::TABLE_NAME = 'orgu_data'

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


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