Class ilObject Basic functions for all objects. More...

Inheritance diagram for ilObject:

Collaboration diagram for ilObject:

Public Member Functions
	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	_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	TITLE_LENGTH = 255

const	DESC_LENGTH = 128

const	LONG_DESC_LENGTH = 4000

const	TABLE_OBJECT_DATA = "object_data"

array	$objectList

string	$untranslatedTitle

Protected Member Functions
	doMDUpdateListener (string $a_element)

	beforeMDUpdateListener (string $a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDeleteMetaData ()

	beforeDeleteMetaData ()

	handleAutoRating ()

	hasAutoRating ()

Protected Attributes
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

Private Member Functions
	appendCopyInfoToTranslations (ilObjectTranslation $obj_translations, array $other_children_of_same_type)

	getCallbackForTitlesPerLanguageTransformation ()

	appendNumberOfCopiesToTitle (string $copy_suffix, string $copy_n_suffix, string $title, array $other_titles_for_lang)

	isTitleUnique (string $title, array $nodes)

	buildTitleWithoutCopySuffix (string $copy_suffix, string $copy_n_suffix, string $title)

Private Attributes
ilObjectProperties	$object_properties = null

ilObjectDIC	$object_dic

bool	$process_auto_reating = false

Detailed Description

Class ilObject Basic functions for all objects.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e; Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e; Stefan Hecken stefa.nosp@m.n.he.nosp@m.cken@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

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

Member Function Documentation

◆ _exists()

static ilObject::_exists	(	int	$id,
		bool	$reference = `false`,
		?string	$type = `null`
	)

static

checks if an object exists in object_data

Parameters

integer	$id	object id or reference id
bool	$reference	true if id is a reference, else false (default)
string \| null	$type	string restrict on a certain type.

Returns: bool true if object exists

Definition at line 1433 of file class.ilObject.php.

References $DIC, ilDBInterface\numRows(), ilDBInterface\query(), and ilDBInterface\quote().

Referenced by ilObjectFeedWriter\__construct(), ilBookingParticipant\__construct(), ilBookingAssignObjectsTableGUI\__construct(), _lookupOwnerName(), ilObjTalkTemplateGUI\addAdminLocatorItems(), ilNavigationHistory\addItem(), ilPCFileList\afterPageUpdate(), ilPCMediaObject\afterPageUpdate(), ilPCFileList\beforePageDelete(), ilPCMediaObject\beforePageDelete(), ilExAssTypePortfolioGUI\buildSubmissionPropertiesAndActions(), ilExAssTypeWikiTeamGUI\buildSubmissionPropertiesAndActions(), ilSoapAdministration\checkObjectAccess(), ilPersonalSettingsGUI\checkPersonalStartingPoint(), ILIAS\COPage\PC\MediaObject\MediaObjectManager\collectMediaObjects(), ILIAS\Survey\Participants\ParticipantsManager\createIfNotExisting(), ilExAssTypeWikiTeamGUI\createWiki(), ilNewsItem\delete(), ilPageObject\delete(), ilDclBaseRecordModel\deleteFile(), ilObjSCORMLearningModuleGUI\deleteTrackingForUser(), ilPublicUserProfileGUI\deliverVCard(), ilCOPageHTMLExport\exportPageElements(), ilForum\fetchPostNodeData(), ilLinksTableGUI\fillRow(), ilAdvancedMDRecordTableGUI\fillRow(), ilWikiContributorsTableGUI\fillRow(), ilPageHistoryTableGUI\fillRow(), ilMediaCastTableGUI\fillRow(), ilPDNewsTableGUI\fillRow(), ilMediaCastManageTableGUI\fillRow(), ilSearchResult\filter(), ilCronFinishUnfinishedTestPasses\finishPassForUser(), ilCronFinishUnfinishedTestPasses\finishPassOnProcessingTime(), ilStudyProgrammeExpandableProgressListGUI\getAccordionContentCoursesHTML(), ilObjEmployeeTalkGUI\getAdminTabs(), ilObjStudyProgramme\getCompletedCourses(), ilObjStyleSheet\getContentStylePath(), ilSoapCourseAdministration\getCoursesForUser(), ilPublicUserProfileGUI\getEmbeddable(), ilPersonalSkillsGUI\getEvalItem(), ilSoapGroupAdministration\getGroupsForUser(), ilGoogleMapGUI\getHtml(), ilOpenLayersMapGUI\getHtml(), ilObjMediaObject\getLinkedMediaObjects(), ilExAssignment\getMemberListData(), ilTagging\getObjectsForTagAndUser(), ilExSubmissionObjectGUI\getOverviewContentPortfolio(), ilStudyProgrammeMailTemplateContext\getSpecificPlaceholders(), ilGoogleMapGUI\getUserListHtml(), ilOpenLayersMapGUI\getUserListHtml(), ilUserStartingPointRepository\getValidAndAccessibleStartingPointAsUrl(), ilSoapObjectAdministration\getXMLTree(), ilSurveySkill\handleQuestionDeletion(), ilAdvancedMDRecordParser\handlerBeginTag(), ilAdvancedMDFieldDefinitionInternalLink\importValueFromXML(), ilCalendarRemoteAccessHandler\initUser(), ILIAS\components\Authentication\Logout\ConfigurableLogoutTarget\isInRepository(), ilWikiExportOptionHTMLWithComments\isObjectSupported(), ilIndividualAssessmentSettingsStorageDB\loadInfoSettings(), ilIndividualAssessmentSettingsStorageDB\loadSettings(), ilWebDAVRepositoryHelper\objectWithRefIdExists(), ilSCORMTrackingItemsPerUserFilterGUI\parse(), ilSCORM2004TrackingItemsPerUserFilterGUI\parse(), ilDclMobRecordRepresentation\parseFormInput(), ilNewsTimelineItemGUI\render(), ilExAssTypeWikiTeamGUI\renderOverviewContent(), ilPortfolioPageGUI\renderVerification(), ILIAS\OrgUnit\Webservices\SOAP\AddUserIdToPositionInOrgUnit\run(), ILIAS\OrgUnit\Webservices\SOAP\RemoveUserIdFromPositionInOrgUnit\run(), ilEmployeeTalkTableGUI\setTalkData(), ilNewsForContextBlockGUI\showNews(), ilPageObjectGUI\showPage(), ilObjSCORM2004LearningModuleGUI\showTrackingItems(), ilObjSCORMLearningModuleGUI\showTrackingItems(), ilSCORMTrackingItems\userDataArrayForExport(), and ilIndividualAssessmentMembers\userExists().

                                                                                           : bool
     {
         global $DIC;
         $db = $DIC->database();
 
         if ($reference) {
             $sql =
                 "SELECT object_data.obj_id" . PHP_EOL
                 . "FROM " . self::TABLE_OBJECT_DATA . PHP_EOL
                 . "LEFT JOIN object_reference ON object_reference.obj_id = object_data.obj_id " . PHP_EOL
                 . "WHERE object_reference.ref_id= " . $db->quote($id, "integer") . PHP_EOL
             ;
         } else {
             $sql =
                 "SELECT object_data.obj_id" . PHP_EOL
                 . "FROM " . self::TABLE_OBJECT_DATA . PHP_EOL
                 . "WHERE obj_id = " . $db->quote($id, "integer") . PHP_EOL
             ;
         }
 
         if ($type) {
             $sql .= " AND object_data.type = " . $db->quote($type, "text") . PHP_EOL;
         }
 
         $result = $db->query($sql);
 
         return (bool) $db->numRows($result);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getAllReferences()

static ilObject::_getAllReferences ( int $id )

staticfinal

get all reference ids for object ID

Returns: array<int, int>

Definition at line 809 of file class.ilObject.php.

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

                                                            : array
     {
         global $DIC;
         $db = $DIC->database();
 
         $sql =
             "SELECT ref_id" . PHP_EOL
             . "FROM object_reference" . PHP_EOL
             . "WHERE obj_id = " . $db->quote($id, 'integer') . PHP_EOL
         ;
 
         $result = $db->query($sql);
 
         $ref = [];
         while ($row = $db->fetchAssoc($result)) {
             $ref[(int) $row["ref_id"]] = (int) $row["ref_id"];
         }
 
         return $ref;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getIcon()

static ilObject::_getIcon	(	int	$obj_id = `0`,
		string	$size = `"big"`,
		string	$type = `""`,
		bool	$offline = `false`
	)

staticfinal

Get icon for repository item.

Parameters

int	object id
string	size (big, small, tiny)
string	object type
bool	true: offline, false: online

Definition at line 1920 of file class.ilObject.php.

      : string {
         return self::getIconForReference(0, $obj_id, $size, $type, $offline);
     }

Here is the caller graph for this function:

◆ _getIdForImportId()

static ilObject::_getIdForImportId ( string $import_id )

staticfinal

Definition at line 783 of file class.ilObject.php.

References $DIC, ilDBInterface\fetchAssoc(), ilDBInterface\query(), ilDBInterface\quote(), and ilDBInterface\setLimit().

Referenced by ilInternalLink\_getIdForImportId(), and ilDataSet\parseObjectExportId().

                                                                      : int
     {
         global $DIC;
         $db = $DIC->database();
         $db->setLimit(1, 0);
 
         $sql =
             "SELECT obj_id" . PHP_EOL
             . "FROM " . self::TABLE_OBJECT_DATA . PHP_EOL
             . "WHERE import_id = " . $db->quote($import_id, "text") . PHP_EOL
             . "ORDER BY create_date DESC" . PHP_EOL
         ;
 
         $result = $db->query($sql);
 
         if ($row = $db->fetchAssoc($result)) {
             return (int) $row["obj_id"];
         }
 
         return 0;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getIdsForTitle()

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

staticfinal

Returns: int[]

Definition at line 857 of file class.ilObject.php.

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

Referenced by ilLTIProviderObjectSettingGUI\checkLocalRole(), ilTestEvaluationData\getParticipants(), ilRoleXmlImporter\importSimpleXml(), ilObjLTIAdministrationGUI\listConsumers(), ilObjRoleGUI\mailToRoleObject(), and ILIAS\Test\Logging\LogTable\prepareFilterData().

                                                                                                                : array
     {
         global $DIC;
         $db = $DIC->database();
 
         $where = "title = " . $db->quote($title, "text");
         if ($partial_match) {
             $where = $db->like("title", "text", '%' . $title . '%');
         }
 
         $sql =
             "SELECT obj_id" . PHP_EOL
             . "FROM " . self::TABLE_OBJECT_DATA . PHP_EOL
             . "WHERE " . $where . PHP_EOL
         ;
 
         if ($type != '') {
             $sql .= " AND type = " . $db->quote($type, "text");
         }
 
         $result = $db->query($sql);
 
         $object_ids = [];
         while ($row = $db->fetchAssoc($result)) {
             $object_ids[] = (int) $row['obj_id'];
         }
 
         return $object_ids;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getLastUpdateOfObjects()

static ilObject::_getLastUpdateOfObjects ( array $obj_ids )

staticfinal

Definition at line 906 of file class.ilObject.php.

References $DIC, ilDBInterface\fetchAssoc(), ilDBInterface\in(), and ilDBInterface\query().

Referenced by ilPageObject\getLastUpdateOfIncludedElements().

                                                                         : string
     {
         global $DIC;
         $db = $DIC->database();
 
         $sql =
             "SELECT MAX(last_update) as last_update" . PHP_EOL
             . "FROM " . self::TABLE_OBJECT_DATA . PHP_EOL
             . "WHERE " . $db->in("obj_id", $obj_ids, false, "integer") . PHP_EOL
         ;
 
         $result = $db->query($sql);
         $row = $db->fetchAssoc($result);
 
         return (string) $row["last_update"];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getObjectsByType()

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

staticfinal

Definition at line 1471 of file class.ilObject.php.

References $DIC, ilDBInterface\fetchAssoc(), ilDBInterface\numRows(), ilDBInterface\query(), and ilDBInterface\quote().

Referenced by ILIAS\Skill\Service\SkillService\__construct(), ilLanguage\_getInstalledLanguages(), ilObjUserTracking\_hasLearningProgressOtherUsers(), ilChatroomServerConfigStoredObjective\achieve(), ilDashboardPage\afterConstructor(), ilBadgeWAC\canBeDelivered(), ilChatroomMetricsCollectedObjective\collectFrom(), ilObjLanguageFolderGUI\confirmRefreshObject(), ilObjLanguageFolderGUI\executeCommand(), ilLPCronObjectStatistics\gatherCourseLPData(), ilChatroomTabGUIFactory\getAdminTabsForCommand(), ilObjAuthSettings\getAuthSettingsRefId(), ilObjPortfolioTemplate\getAvailablePortfolioTemplates(), ilObjLanguage\getInstalledLanguages(), ilObjLanguageFolder\getLanguages(), ilEmployeeTalkMyStaffBaseGUI\loadActionBar(), ilAdvancedMDRecordLanguageTableGUI\readLanguages(), and ilObjLanguage\refreshAll().

                                                                                              : array
     {
         global $DIC;
         $db = $DIC->database();
 
         $order = " ORDER BY title";
 
         $where = "";
         if ($obj_type) {
             $where = "WHERE type = " . $db->quote($obj_type, "text");
 
             if (!is_null($owner)) {
                 $where .= " AND owner = " . $db->quote($owner, "integer");
             }
         }
 
         $sql =
             "SELECT obj_id, type, title, description, owner, create_date, last_update, import_id, offline" . PHP_EOL
             . "FROM " . self::TABLE_OBJECT_DATA . PHP_EOL
             . $where . PHP_EOL
             . $order . PHP_EOL
         ;
         $result = $db->query($sql);
 
         $arr = [];
         if ($db->numRows($result) > 0) {
             while ($row = $db->fetchAssoc($result)) {
                 $row["desc"] = $row["description"];
                 $arr[$row["obj_id"]] = $row;
             }
         }
 
         return $arr;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getObjectsDataForType()

static ilObject::_getObjectsDataForType	(	string	$type,
		bool	$omit_trash = `false`
	)

staticfinal

get all objects of a certain type

Parameters

string	$type	desired object type
boolean	$omit_trash	omit objects, that are in trash only

Returns: array of object data arrays ("id", "title", "type", "description")

Definition at line 1129 of file class.ilObject.php.

References $DIC, _hasUntrashedReference(), ilDBInterface\fetchAssoc(), ilDBInterface\query(), and ilDBInterface\quote().

Referenced by ilObjStyleSheet\_addMissingStyleClassesToAllStyles().

                                                                                                : array
     {
         global $DIC;
         $db = $DIC->database();
 
         $sql =
             "SELECT obj_id, type, title, description, owner, create_date, last_update, import_id, offline" . PHP_EOL
             . "FROM " . self::TABLE_OBJECT_DATA . PHP_EOL
             . "WHERE type = " . $db->quote($type, "text") . PHP_EOL
         ;
         $result = $db->query($sql);
 
         $objects = [];
         while ($row = $db->fetchAssoc($result)) {
             if ((!$omit_trash) || ilObject::_hasUntrashedReference((int) $row["obj_id"])) {
                 $objects[$row["title"] . "." . $row["obj_id"]] = [
                     "id" => $row["obj_id"],
                     "type" => $row["type"],
                     "title" => $row["title"],
                     "description" => $row["description"]
                 ];
             }
         }
         ksort($objects);
         return $objects;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getObjectTypeIdByTitle()

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

static

Definition at line 2164 of file class.ilObject.php.

References $DIC, $ilDB, $res, and null.

Referenced by ilAccessRBACOperationDeletedObjective\achieve(), ilAccessCustomRBACOperationAddedObjective\achieve(), ilAccessRbacStandardOperationsAddedObjective\achieve(), ilDBUpdateNewObjectType\addAdminNode(), ilDBUpdateNewObjectType\addNewType(), ilDBUpdateNewObjectType\addRBACCreate(), ilDBUpdateNewObjectType\applyInitialPermissionGuideline(), ilDBUpdateNewObjectType\deleteRBACOperation(), ilObjectNewTypeAddedObjective\isApplicable(), ilAccessRbacStandardOperationsAddedObjective\isApplicable(), ilAccessCustomRBACOperationAddedObjective\isApplicable(), ilTreeAdminNodeAddedObjective\isApplicable(), and ilAccessInitialPermissionGuidelineAppliedObjective\isApplicable().

                                                                                               : ?int
     {
         if (!$ilDB) {
             global $DIC;
             $ilDB = $DIC->database();
         }
 
         $sql =
             "SELECT obj_id FROM object_data" . PHP_EOL
             . "WHERE type = 'typ'" . PHP_EOL
             . "AND title = " . $ilDB->quote($type, 'text') . PHP_EOL
         ;
 
         $res = $ilDB->query($sql);
         if ($ilDB->numRows($res) == 0) {
             return null;
         }
 
         $row = $ilDB->fetchAssoc($res);
         return (int) $row['obj_id'] ?? null;
     }

Here is the caller graph for this function:

◆ _hasUntrashedReference()

static ilObject::_hasUntrashedReference ( int $obj_id )

staticfinal

checks whether an object has at least one reference that is not in trash

Definition at line 1104 of file class.ilObject.php.

References _getAllReferences(), and _isInTrash().

Referenced by ilLMObject\_getAllObjectsForImportId(), ilGlossaryTerm\_getIdForImportId(), ilLMObject\_getIdForImportId(), _getObjectsDataForType(), ilObjSurveyQuestionPool\_isWriteable(), ilObjQuestionPool\_isWriteable(), ilOrgUnitImporter\buildRef(), ilMailSearchObjectGUI\cancel(), ILIAS\Skill\Profile\SkillProfileManager\countUsers(), ilChatroomAdminViewGUI\forcePublicRoom(), ILIAS\Skill\Usage\SkillUsageManager\getAssignedObjectsForSkillProfile(), ilLuceneAdvancedSearchFields\getFields(), ilSoapObjectAdministration\getObjIdsByRefIds(), ILIAS\Notes\NotesManager\getRelatedObjectsOfUser(), ilObjSAHSLearningModule\getScormModulesForGlossary(), ilTaggingAppEventListener\handleEvent(), ilEmployeeTalkMyStaffBaseGUI\loadActionBar(), ilEmployeeTalkTableGUI\setTalkData(), and ilOrgUnitSimpleImport\simpleImportElement().

                                                                     : bool
     {
         $ref_ids = ilObject::_getAllReferences($obj_id);
         foreach ($ref_ids as $ref_id) {
             if (!ilObject::_isInTrash($ref_id)) {
                 return true;
             }
         }
 
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _isInTrash()

static ilObject::_isInTrash ( int $ref_id )

staticfinal

Definition at line 1095 of file class.ilObject.php.

References $DIC.

Referenced by _hasUntrashedReference(), ilSoapCourseAdministration\addCourse(), ilSoapExerciseAdministration\addExercise(), ilSoapFileAdministration\addFile(), ilSoapGroupAdministration\addGroup(), ilSoapRBACAdministration\addRole(), ilSoapRBACAdministration\addRoleFromTemplate(), ilOrgUnitImporter\buildRef(), ILIAS\Test\Utilities\TitleColumnsBuilder\buildTestTitleAsLink(), ilSoapAdministration\checkObjectAccess(), ilSoapWebLinkAdministration\createWebLink(), ilSoapDataCollectionAdministration\exportDataCollectionContent(), ilMStShowUserCoursesTableGUI\fillRow(), ilMStListCoursesTableGUI\fillRow(), ilStudyProgrammeMembersTableGUI\getCompletionLink(), ilSoapCourseAdministration\getCoursesForUser(), ilSoapGroupAdministration\getGroupsForUser(), ilSoapSCORMAdministration\getIMSManifestXML(), ilSoapObjectAdministration\getObjectByReference(), ilSoapRBACAdministration\getObjectTreeOperations(), ilOrgUnitType\getOrgUnits(), ilSoapObjectAdministration\getPathForRefId(), ilSoapTestAdministration\getTestResults(), ilSoapObjectAdministration\getXMLTree(), ilSoapGroupAdministration\groupExists(), ilCopyWizardSettingsXMLParser\handlerBeginTag(), ilSoapSCORMAdministration\hasSCORMCertificate(), ILIAS\components\Authentication\Logout\ConfigurableLogoutTarget\isInRepository(), ilStudyProgrammeUserTable\lookupTitle(), ilSoapObjectAdministration\moveObject(), ilSoapWebLinkAdministration\readWebLink(), ilCollectFilesJob\recurseFolder(), ilSoapObjectAdministration\removeFromSystemByImportId(), ilSoapTestAdministration\removeTestResults(), ilSoapWebLinkAdministration\updateWebLink(), and ilCheckSumOfFileSizesJob\validateAccess().

                                                         : bool
     {
         global $DIC;
         return $DIC->repositoryTree()->isDeleted($ref_id);
     }

Here is the caller graph for this function:

◆ _lookupCreationDate()

static ilObject::_lookupCreationDate ( int $obj_id )

static

Definition at line 2136 of file class.ilObject.php.

References $DIC, ilDBInterface\fetchAssoc(), ilDBInterface\query(), and ilDBInterface\quote().

Referenced by ilSearchResult\filter(), ILIAS\Help\Module\ModuleDBRepository\getHelpModules(), ilSearchResultPresentation\renderItemList(), and ilSearchResultTableGUI\setDataAndApplySortation().

                                                            : string
     {
         global $DIC;
         $db = $DIC->database();
 
         $sql =
             "SELECT create_date" . PHP_EOL
             . "FROM " . self::TABLE_OBJECT_DATA . PHP_EOL
             . "WHERE obj_id = " . $db->quote($obj_id, "integer") . PHP_EOL
         ;
         $result = $db->query($sql);
         $rec = $db->fetchAssoc($result);
         return $rec["create_date"];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupDeletedDate()

static ilObject::_lookupDeletedDate ( int $ref_id )

staticfinal

Definition at line 980 of file class.ilObject.php.

References $DIC, ilDBInterface\fetchAssoc(), null, ilDBInterface\query(), and ilDBInterface\quote().

Referenced by ilStudyProgrammeExpandableProgressListGUI\getAccordionContentCoursesHTML(), ilObjStudyProgramme\getCompletedCourses(), and ilStudyProgrammeMailTemplateContext\getSpecificPlaceholders().

                                                                 : ?string
     {
         global $DIC;
         $db = $DIC->database();
 
         $sql =
             "SELECT deleted" . PHP_EOL
             . "FROM object_reference" . PHP_EOL
             . "WHERE ref_id = " . $db->quote($ref_id, "integer") . PHP_EOL
         ;
         $result = $db->query($sql);
         $row = $db->fetchAssoc($result);
 
         return $row["deleted"] ?? null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupDescription()

static ilObject::_lookupDescription ( int $obj_id )

staticfinal

Definition at line 887 of file class.ilObject.php.

References $DIC.

Referenced by ilLPStatusEvent\_getStatusInfo(), ilDidacticTemplateLocalRoleAction\apply(), ilMDCopyrightUsageTableGUI\collectData(), ilECSSettingsGUI\exportImported(), ilECSSettingsGUI\exportReleased(), ilTaxonomyListTableGUI\fillRow(), ilObjectTranslation\getDefaultDescription(), ilFavouritesDBRepository\getFavouritesOfUser(), ilObjTest\getGroupData(), ilCourseGroupingAssignmentTableGUI\getItems(), ilObjTest\getRoleData(), ilObjStudyProgrammeAutoMembershipsGUI\getSelectionForm(), ilDashboardRecommendedContentGUI\initData(), ilCourseObjectivesGUI\initFormLimits(), ilObjStudyProgrammeReferenceListGUI\initItem(), ilObjCategoryReferenceListGUI\initItem(), ilObjGroupReferenceListGUI\initItem(), ilObjCourseReferenceListGUI\initItem(), ilSearchResultPresentation\lookupDescription(), ilCalendarSharedRoleListTableGUI\parse(), ilCalendarSharedListTableGUI\parse(), ilObjectCopyProgressTableGUI\parse(), ilCourseObjectiveQuestionsTableGUI\parse(), ilRepositoryObjectResultTableGUI\parseObjectIds(), ilObjectCopySearchResultTableGUI\parseSearchResults(), ilDclRecordEditGUI\parseSearchResults(), ilScorm2004DataSet\readData(), ilMediaObjectDataSet\readData(), ILIAS\Tracking\View\DataRetrieval\DataRetrieval\retrieveViewInfo(), ilConditionHandlerTableGUI\setConditions(), ilObjTaxonomyGUI\setTabs(), and ilRoleXmlExport\writeRole().

                                                                 : string
     {
         global $DIC;
         return (string) $DIC["ilObjDataCache"]->lookupDescription($obj_id);
     }

Here is the caller graph for this function:

◆ _lookupImportId()

static ilObject::_lookupImportId ( int $obj_id )

static

Definition at line 454 of file class.ilObject.php.

References $DIC, $res, ilDBConstants\FETCHMODE_OBJECT, ilDBInterface\query(), and ilDBInterface\quote().

Referenced by ilMediaObjectDataSet\readData(), and ILIAS\COPage\PC\MediaObject\MediaObjectManager\resolveMediaAliases().

                                                        : string
     {
         global $DIC;
 
         $db = $DIC->database();
 
         $sql =
             "SELECT import_id" . PHP_EOL
             . "FROM " . self::TABLE_OBJECT_DATA . PHP_EOL
             . "WHERE obj_id = " . $db->quote($obj_id, "integer") . PHP_EOL
         ;
 
         $res = $db->query($sql);
         while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
             return (string) $row->import_id;
         }
         return '';
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupLastUpdate()

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

staticfinal

Definition at line 893 of file class.ilObject.php.

References $DIC, $last_update, ilDatePresentation\formatDate(), and IL_CAL_DATETIME.

                                                                                         : string
     {
         global $DIC;
 
         $last_update = $DIC["ilObjDataCache"]->lookupLastUpdate($obj_id);
 
         if ($formatted) {
             return ilDatePresentation::formatDate(new ilDateTime($last_update, IL_CAL_DATETIME));
         }
 
         return (string) $last_update;
     }

Here is the call graph for this function:

◆ _lookupObjectId()

static ilObject::_lookupObjectId ( int $ref_id )

staticfinal

Definition at line 1116 of file class.ilObject.php.

References $DIC.

Referenced by ILIAS\Exercise\Object\ObjectManager\__construct(), ilWebDAVObjectMountInstructions\__construct(), ilGlossaryAdvMetaDataAdapter\__construct(), ilDclDetailedViewDefinitionGUI\__construct(), ilLOXmlWriter\__construct(), ilGlossaryTermGUI\__construct(), ILIAS\Glossary\Flashcard\FlashcardManager\__construct(), ilMMItemInformation\__construct(), ilObject2GUI\__construct(), ilSCORM13PlayerGUI\__construct(), ilObjSurveyQuestionPool\_getAvailableQuestionpools(), ilObjForumGUI\_goto(), ilAppointmentPresentationGUI\addContainerInfo(), ilObjStudyProgramme\addCrsToProgrammes(), ilSoapExerciseAdministration\addExercise(), ilSoapFileAdministration\addFile(), ilBookingGatewayGUI\checkBookingPoolsForSchedules(), ilLTIProviderObjectSettingGUI\checkLocalRole(), ilContainerSorting\cloneSorting(), ILIAS\MediaCast\Comments\GUIService\commentGUI(), ilRecommendedContentRoleConfigGUI\confirmRemoveItems(), ILIAS\Glossary\Term\TermManager\copyTermFromOtherGlossary(), ILIAS\Skill\Profile\SkillProfileManager\countUsers(), ilObjPortfolioGUI\createPortfolioFromAssignment(), ilExSubmissionObjectGUI\createPortfolioFromAssignmentObject(), ilLPListOfProgressGUI\details(), ilSAHSPresentationGUI\executeCommand(), ilSAHSEditGUI\executeCommand(), ilObjSAHSLearningModuleGUI\exportModule(), ilLPCollectionSettingsTableGUI\fillRow(), ilMStShowUserCoursesTableGUI\fillRow(), ilMStListCoursesTableGUI\fillRow(), ILIAS\Skill\Profile\SkillProfileCompletionManager\getActualMaxLevels(), ilContainerPageGUI\getAdditionalPageActions(), ilObjFileInfoRepository\getByRefId(), ILIAS\Bibliographic\Field\Table\ProfileTable\getDataRetrieval(), ilExAssTypeWikiTeam\getExportObjIdForResourceId(), ilOrgUnitExporter\getExternalId(), ilNewsForContextBlockGUI\getHTML(), ilSoapSCORMAdministration\getIMSManifestXML(), ilRecommendedContentRoleTableGUI\getItems(), ilBookingReservationsTableGUI\getItems(), ilLPProgressBlockGUI\getLegacyContent(), ilNotification\getNotificationsForObject(), ilWebDAVRepositoryHelper\getObjectIdFromRefId(), ilPRGAssignmentDBRepository\getObjIdFor(), ilOrgUnitPositionAccess\getObjIdForRefId(), ilSoapObjectAdministration\getObjIdsByRefIds(), ilTrQuery\getParticipantsForObject(), ilLPCollectionOfLMChapters\getPossibleItems(), ilSoapSCORMAdministration\getSCORMCompletionStatus(), ilBookingReservationsTableGUI\getSelectableUserColumns(), ilDclIliasReferenceRecordFieldModel\getStatus(), ilTrQuery\getSummaryDataForObject(), ilObjEmployeeTalkSeriesGUI\getTemplateRefId(), ilGlossaryTerm\getTermList(), ilSoapTestAdministration\getTestAccess(), ilSoapTestAdministration\getTestResults(), ilOrgUnitPathStorage\getTextRepresentationOfOrgUnits(), ilTrQuery\getUserDataForObject(), ilBadgeHandler\getUserIds(), ilTrQuery\getUserObjectMatrix(), ilDclIliasReferenceRecordFieldModel\getValueForRepresentation(), ilMembershipRegistrationCodeUtils\handleCode(), ilDclTable\hasPermissionToDeleteRecord(), ilDclTable\hasPermissionToDeleteRecords(), ilDclTable\hasPermissionToEditRecord(), ilDclTable\hasPermissionToViewRecord(), ilSoapSCORMAdministration\hasSCORMCertificate(), ilDashboardRecommendedContentGUI\initData(), ilObjContentObjectGUI\initMenuEntryForm(), ilRepositoryExplorer\isClickable(), ilObjEmployeeTalkSeriesGUI\loadRecurrenceSettings(), ilPollCommentsHandler\lookupObjectId(), ilObjForum\lookupStatisticsByRefId(), ilObjSCORMLearningModuleGUI\newModuleVersion(), ILIAS\AccessControl\Log\Table\parseChangesFaPa(), ilSoapWebLinkAdministration\readWebLink(), ilContainerGUI\redrawListItemObject(), ILIAS\Glossary\Term\TermManager\referenceTermsFromOtherGlossary(), ilSoapObjectAdministration\removeFromSystemByImportId(), ilObjGlossary\removeOfflineGlossaries(), ILIAS\Repository\Provider\RepositoryMainBarProvider\renderLastVisited(), ilNewsTimelineGUI\save(), ilLPTableBaseGUI\sendMail(), ilSAHSPresentationGUI\setInfoTabs(), ilBookingGatewayGUI\showPoolSelector(), ILIAS\Data\ReferenceId\toObjectId(), ilNewsTimelineGUI\update(), ilSoapWebLinkAdministration\updateWebLink(), and ilLearningSequenceXMLWriter\writeLSItems().

                                                              : int
     {
         global $DIC;
         return $DIC["ilObjDataCache"]->lookupObjId($ref_id);
     }

Here is the caller graph for this function:

◆ _lookupObjId()

static ilObject::_lookupObjId ( int $ref_id )

staticfinal

Definition at line 923 of file class.ilObject.php.

References $DIC.

                                                           : int
     {
         global $DIC;
         return $DIC["ilObjDataCache"]->lookupObjId($ref_id);
     }

Here is the caller graph for this function:

◆ _lookupObjIdByImportId()

static ilObject::_lookupObjIdByImportId ( string $import_id )

staticfinal

Get (latest) object id for an import id.

Definition at line 409 of file class.ilObject.php.

References $DIC, ilDBInterface\fetchObject(), ilDBInterface\numRows(), ilDBInterface\query(), and ilDBInterface\quote().

Referenced by ilOrgUnitImporter\buildRef(), ilOrgUnitSimpleUserImport\buildUserId(), ilSoapObjectAdministration\getObjIdByImportId(), ilSoapObjectAdministration\getRefIdsByImportId(), ilSoapObjectAdministration\getXMLTree(), ilAuthProviderECS\handleLogin(), ilGlossaryDataSet\importRecord(), ilRoleXmlImporter\initRole(), ilSoapObjectAdministration\removeFromSystemByImportId(), and ilOrgUnitSimpleImport\simpleImportElement().

                                                                           : int
     {
         global $DIC;
         $db = $DIC->database();
 
         $sql =
             "SELECT obj_id" . PHP_EOL
             . "FROM " . self::TABLE_OBJECT_DATA . PHP_EOL
             . "WHERE import_id = " . $db->quote($import_id, "text") . PHP_EOL
             . "ORDER BY create_date DESC" . PHP_EOL
         ;
         $result = $db->query($sql);
 
         if ($db->numRows($result) == 0) {
             return 0;
         }
 
         $row = $db->fetchObject($result);
 
         return (int) $row->obj_id;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupOwner()

static ilObject::_lookupOwner ( int $obj_id )

staticfinal

Lookup owner user ID for object ID.

Definition at line 848 of file class.ilObject.php.

References $DIC.

Referenced by ilMDCopyrightUsageTableGUI\collectData(), ilPageObjectGUI\executeCommand(), ilLPTableBaseGUI\getExportMeta(), ILIAS\GlobalScreen\Scope\MainMenu\Collector\Map\Map\MapManager\getHelpSectionsForId(), ilPCLearningHistory\getPresentation(), ilNoteGUI\getTarget(), ilPortfolioPageGUI\makePlaceHoldersClickable(), ilPortfolioRepositoryGUI\setOffline(), ilPortfolioRepositoryGUI\setOnline(), and ilObjPortfolioGUI\setOnlineAndShare().

                                                           : int
     {
         global $DIC;
         return (int) $DIC["ilObjDataCache"]->lookupOwner($obj_id);
     }

Here is the caller graph for this function:

◆ _lookupOwnerName()

static ilObject::_lookupOwnerName ( int $owner_id )

staticfinal

Lookup owner name for owner id.

Definition at line 489 of file class.ilObject.php.

References $DIC, _exists(), null, and ilLanguage\txt().

Referenced by getOwnerName(), and ilNoteGUI\getTarget().

                                                                 : string
     {
         global $DIC;
         $lng = $DIC->language();
 
         $owner = null;
         if ($owner_id != -1) {
             if (ilObject::_exists($owner_id)) {
                 $owner = new ilObjUser($owner_id);
             }
         }
 
         $own_name = $lng->txt("unknown");
         if (is_object($owner)) {
             $own_name = $owner->getFullname();
         }
 
         return $own_name;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupTitle()

static ilObject::_lookupTitle ( int $obj_id )

static

Definition at line 830 of file class.ilObject.php.

References $DIC.

                                                     : string
     {
         global $DIC;
         return (string) $DIC["ilObjDataCache"]->lookupTitle($obj_id);
     }

Here is the caller graph for this function:

◆ _lookupType()

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

staticfinal

Definition at line 1084 of file class.ilObject.php.

References $DIC.

                                                                               : string
     {
         global $DIC;
 
         if ($reference) {
             return $DIC["ilObjDataCache"]->lookupType($DIC["ilObjDataCache"]->lookupObjId($id));
         }
 
         return $DIC["ilObjDataCache"]->lookupType($id);
     }

Here is the caller graph for this function:

◆ _prepareCloneSelection()

static ilObject::_prepareCloneSelection	(	array	$ref_ids,
		string	$new_type,
		bool	$show_path = `true`
	)

staticfinal

Prepare copy wizard object selection.

This method should be renamed. Currently, used in ilObjSurvey and ilObjTest

Deprecated:: since version 5.2

Definition at line 1512 of file class.ilObject.php.

References $DIC, $path, $res, $title, ilAdvancedMDValues\_cloneValues(), ilCopyWizardOptions\_getInstance(), appendCopyInfo(), ilRbacAdmin\copyLocalRoles(), ilDBInterface\fetchObject(), getDescription(), getId(), ilLoggerFactory\getLogger(), getLongDescription(), getObjectProperties(), getRefId(), getTitle(), getType(), ilDBInterface\in(), ilObjectDefinition\isPlugin(), ilObjectPlugin\lookupTxtById(), ilDBInterface\query(), supportsOfflineHandling(), and ilLanguage\txt().

Referenced by ilObjSurveyQuestionPool\_getAvailableQuestionpools(), ilObjQuestionPool\_getAvailableQuestionpools(), and ilObjTest\_getAvailableTests().

      : array {
         global $DIC;
 
         $db = $DIC->database();
         $lng = $DIC->language();
         $obj_definition = $DIC["objDefinition"];
 
         $sql =
             "SELECT obj_data.title obj_title, path_data.title path_title, child" . PHP_EOL
             . "FROM tree " . PHP_EOL
             . "JOIN object_reference obj_ref ON child = obj_ref.ref_id " . PHP_EOL
             . "JOIN object_data obj_data ON obj_ref.obj_id = obj_data.obj_id " . PHP_EOL
             . "JOIN object_reference path_ref ON parent = path_ref.ref_id " . PHP_EOL
             . "JOIN object_data path_data ON path_ref.obj_id = path_data.obj_id " . PHP_EOL
             . "WHERE " . $db->in("child", $ref_ids, false, "integer") . PHP_EOL
             . "ORDER BY obj_data.title" . PHP_EOL
         ;
         $res = $db->query($sql);
 
         if (!$obj_definition->isPlugin($new_type)) {
             $options[0] = $lng->txt('obj_' . $new_type . '_select');
         } else {
             $options[0] = ilObjectPlugin::lookupTxtById($new_type, "obj_" . $new_type . "_select");
         }
 
         while ($row = $db->fetchObject($res)) {
             if (strlen($title = $row->obj_title) > 40) {
                 $title = substr($title, 0, 40) . '...';
             }
 
             if ($show_path) {
                 if (strlen($path = $row->path_title) > 40) {
                     $path = substr($path, 0, 40) . '...';
                 }
 
                 $title .= ' (' . $lng->txt('path') . ': ' . $path . ')';
             }
 
             $options[$row->child] = $title;
         }
         return $options ?: [];
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _resetDeletedDate()

static ilObject::_resetDeletedDate ( int $ref_id )

staticfinal

Definition at line 963 of file class.ilObject.php.

References $DIC, $ref_id, null, and ilDBInterface\update().

Referenced by ilTree\insertNode().

                                                                : void
     {
         global $DIC;
         $db = $DIC->database();
 
         $values = [
             "deleted" => ["timestamp", null],
             "deleted_by" => ["integer", 0]
         ];
 
         $where = [
             "ref_id" => ["integer", $ref_id]
         ];
 
         $db->update("object_reference", $values, $where);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _setDeletedDate()

static ilObject::_setDeletedDate	(	int	$ref_id,
		int	$deleted_by
	)

staticfinal

Definition at line 929 of file class.ilObject.php.

References $DIC, $ref_id, ilDBInterface\now(), and ilDBInterface\update().

                                                                               : void
     {
         global $DIC;
         $db = $DIC->database();
 
         $values = [
             "deleted" => ["date", $db->now()],
             "deleted_by" => ["integer", $deleted_by]
         ];
 
         $where = [
             "ref_id" => ["integer", $ref_id]
         ];
 
         $db->update("object_reference", $values, $where);
     }

Here is the call graph for this function:

◆ _writeDescription()

static ilObject::_writeDescription	(	int	$obj_id,
		string	$desc
	)

staticfinal

write description to db (static)

Definition at line 1019 of file class.ilObject.php.

References $desc, $DIC, _lookupType(), ilDBInterface\insert(), ilObjectDefinition\isRBACObject(), ilDBInterface\now(), ilDBInterface\query(), ilDBInterface\quote(), ilStr\shortenTextExtended(), and ilDBInterface\update().

Referenced by ilObjMediaObject\beforeMDUpdateListener().

                                                                              : void
     {
         global $DIC;
 
         $db = $DIC->database();
         $obj_definition = $DIC["objDefinition"];
 
         $desc = ilStr::shortenTextExtended($desc, self::DESC_LENGTH, true);
 
         $values = [
             "description" => ["text", $desc],
             "last_update" => ["date", $db->now()]
         ];
 
         $where = [
             "obj_id" => ["integer", $obj_id]
         ];
 
         $db->update(self::TABLE_OBJECT_DATA, $values, $where);
 
 
         if ($obj_definition->isRBACObject(ilObject::_lookupType($obj_id))) {
             // Update long description
             $sql =
                 "SELECT obj_id, description" . PHP_EOL
                 . "FROM object_description" . PHP_EOL
                 . "WHERE obj_id = " . $db->quote($obj_id, 'integer') . PHP_EOL
             ;
             $result = $db->query($sql);
 
             if ($result->numRows()) {
                 $values = [
                     "description" => ["clob", $desc]
                 ];
                 $db->update("object_description", $values, $where);
             } else {
                 $values = [
                     "description" => ["clob",$desc],
                     "obj_id" => ["integer",$obj_id]
                 ];
                 $db->insert("object_description", $values);
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _writeImportId()

static ilObject::_writeImportId	(	int	$obj_id,
		string	$import_id
	)

staticfinal

write import id to db (static)

Definition at line 1067 of file class.ilObject.php.

References $DIC, $import_id, ilDBInterface\now(), and ilDBInterface\update().

Referenced by ilAuthProviderECS\createUser(), ilImport\doImportObject(), and ilCourseXMLParser\handlerBeginTag().

                                                                                : void
     {
         global $DIC;
         $db = $DIC->database();
 
         $values = [
             "import_id" => ["text", $import_id],
             "last_update" => ["date", $db->now()]
         ];
 
         $where = [
             "obj_id" => ["integer", $obj_id]
         ];
 
         $db->update(self::TABLE_OBJECT_DATA, $values, $where);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _writeTitle()

static ilObject::_writeTitle	(	int	$obj_id,
		string	$title
	)

staticfinal

write title to db (static)

Definition at line 999 of file class.ilObject.php.

References $DIC, $title, ilDBInterface\now(), and ilDBInterface\update().

Referenced by ilObjMediaObject\beforeMDUpdateListener(), and ilObjSAHSLearningModuleGUI\uploadObject().

                                                                         : void
     {
         global $DIC;
         $db = $DIC->database();
 
         $values = [
             "title" => ["text", $title],
             "last_update" => ["date", $db->now()]
         ];
 
         $where = [
             "obj_id" => ["integer", $obj_id]
         ];
 
         $db->update(self::TABLE_OBJECT_DATA, $values, $where);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ appendCopyInfo()

ilObject::appendCopyInfo	(	int	$target_id,
		int	$copy_id
	)

final

Prepend Copy info if object with same name exists in that container.

Definition at line 1662 of file class.ilObject.php.

References ilCopyWizardOptions\_getInstance(), appendCopyInfoToTranslations(), appendNumberOfCopiesToTitle(), getId(), ilObjectTranslation\getInstance(), getTitle(), and ILIAS\Repository\lng().

Referenced by _prepareCloneSelection().

                                                                       : string
     {
         $cp_options = ilCopyWizardOptions::_getInstance($copy_id);
         if (!$cp_options->isRootNode($this->getRefId())) {
             return $this->getTitle();
         }
 
         $obj_translations = ilObjectTranslation::getInstance($this->getId());
 
         $other_children_of_same_type = $this->tree->getChildsByType($target_id, $this->type);
 
         if ($obj_translations->getLanguages() === []) {
             $existing_titles = array_map(
                 fn(array $child): string => $child['title'],
                 $other_children_of_same_type
             );
 
             return $this->appendNumberOfCopiesToTitle(
                 $this->lng->txt('copy_of_suffix'),
                 $this->lng->txt('copy_n_of_suffix'),
                 $this->getTitle(),
                 $existing_titles
             );
         }
 
         return $this->appendCopyInfoToTranslations($obj_translations, $other_children_of_same_type);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ appendCopyInfoToTranslations()

ilObject::appendCopyInfoToTranslations	(	ilObjectTranslation	$obj_translations,
		array	$other_children_of_same_type
	)

private

Definition at line 1690 of file class.ilObject.php.

References appendNumberOfCopiesToTitle(), getCallbackForTitlesPerLanguageTransformation(), ilObjectTranslation\getDefaultTitle(), ilObjectTranslation\getInstance(), ilObjectTranslation\getLanguages(), ILIAS\Repository\lng(), and ilObjectTranslation\setLanguages().

Referenced by appendCopyInfo().

      : string {
         $nodes_translations = array_map(
             fn(array $child): ilObjectTranslation =>
                 ilObjectTranslation::getInstance($child['obj_id']),
             $other_children_of_same_type
         );
 
         $title_translations_per_lang = array_reduce(
             $nodes_translations,
             $this->getCallbackForTitlesPerLanguageTransformation(),
             []
         );
 
         $new_languages = [];
         $installed_langs = $this->lng->getInstalledLanguages();
         foreach ($obj_translations->getLanguages() as $language) {
             $lang_code = $language->getLanguageCode();
             $suffix_lang = $lang_code;
             if (!in_array($suffix_lang, $installed_langs)) {
                 $suffix_lang = $this->lng->getDefaultLanguage();
             }
             $language->setTitle(
                 $this->appendNumberOfCopiesToTitle(
                     $this->lng->txtlng('common', 'copy_of_suffix', $suffix_lang),
                     $this->lng->txtlng('common', 'copy_n_of_suffix', $suffix_lang),
                     $language->getTitle(),
                     $title_translations_per_lang[$lang_code] ?? []
                 )
             );
             $new_languages[$lang_code] = $language;
         }
         $obj_translations->setLanguages($new_languages);
 
         return $obj_translations->getDefaultTitle();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ appendNumberOfCopiesToTitle()

ilObject::appendNumberOfCopiesToTitle	(	string	$copy_suffix,
		string	$copy_n_suffix,
		string	$title,
		array	$other_titles_for_lang
	)

private

Definition at line 1743 of file class.ilObject.php.

References buildTitleWithoutCopySuffix(), and isTitleUnique().

Referenced by appendCopyInfo(), and appendCopyInfoToTranslations().

      : string {
         $title_without_suffix = $this->buildTitleWithoutCopySuffix($copy_suffix, $copy_n_suffix, $title);
         $title_with_suffix = "{$title_without_suffix} {$copy_suffix}";
         if ($other_titles_for_lang === []
             || $this->isTitleUnique($title_with_suffix, $other_titles_for_lang)) {
             return $title_with_suffix;
         }
 
         for ($i = 2;true;$i++) {
             $title_with_suffix = $title_without_suffix . ' ' . sprintf($copy_n_suffix, $i);
             if ($this->isTitleUnique($title_with_suffix, $other_titles_for_lang)) {
                 return $title_with_suffix;
             }
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applyDidacticTemplate()

ilObject::applyDidacticTemplate ( int $tpl_id )

Definition at line 1412 of file class.ilObject.php.

References ilDidacticTemplateObjSettings\assignTemplate(), ilDidacticTemplateActionFactory\getActionsByTemplateId(), getId(), ilLoggerFactory\getLogger(), and getRefId().

Referenced by ilSessionDataSet\applyDidacticTemplate().

                                                       : void
     {
         ilLoggerFactory::getLogger('obj')->debug('Applying didactic template with id: ' . $tpl_id);
         if ($tpl_id) {
             foreach (ilDidacticTemplateActionFactory::getActionsByTemplateId($tpl_id) as $action) {
                 $action->setRefId($this->getRefId());
                 $action->apply();
             }
         }
 
         ilDidacticTemplateObjSettings::assignTemplate($this->getRefId(), $this->getId(), $tpl_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ beforeCreateMetaData()

ilObject::beforeCreateMetaData ( )

protected

Definition at line 710 of file class.ilObject.php.

Referenced by createMetaData().

                                              : bool
     {
         return true;
     }

Here is the caller graph for this function:

◆ beforeDeleteMetaData()

ilObject::beforeDeleteMetaData ( )

protected

Definition at line 758 of file class.ilObject.php.

Referenced by deleteMetaData().

                                              : bool
     {
         return true;
     }

Here is the caller graph for this function:

◆ beforeMDUpdateListener()

ilObject::beforeMDUpdateListener ( string $a_element )

protected

Definition at line 685 of file class.ilObject.php.

Referenced by MDUpdateListener().

                                                                 : bool
     {
         return true;
     }

Here is the caller graph for this function:

◆ beforeUpdateMetaData()

ilObject::beforeUpdateMetaData ( )

protected

Definition at line 741 of file class.ilObject.php.

Referenced by updateMetaData().

                                              : bool
     {
         return true;
     }

Here is the caller graph for this function:

◆ buildTitleWithoutCopySuffix()

ilObject::buildTitleWithoutCopySuffix	(	string	$copy_suffix,
		string	$copy_n_suffix,
		string	$title
	)

private

Definition at line 1774 of file class.ilObject.php.

References $title.

Referenced by appendNumberOfCopiesToTitle().

                                                                                                            : string
     {
         /*
          * create a regular expression from the language text copy_n_of_suffix, so that
          * we can match it against $filenameWithoutExtension, and retrieve the number of the copy.
          * for example, if copy_n_of_suffix is 'Copy (%1s)', this creates the regular
          * expression '/ Copy \\([0-9]+)\\)$/'.
          */
         $regexp_for_suffix = preg_replace(
             '/([\^$.\[\]|()?*+{}])/',
             '\\\\${1}',
             ' '
             . $copy_n_suffix
         );
         $regexp_for_file_name = '/' . preg_replace('/%1\\\\\$s/', '([0-9]+)', $regexp_for_suffix) . '$/';
 
         if (preg_match($regexp_for_file_name, $title, $matches)) {
             return substr($title, 0, -strlen($matches[0]));
         }
 
         if (str_ends_with($title, " {$copy_suffix}")) {
             return substr(
                 $title,
                 0,
                 -strlen(
                     " {$copy_suffix}"
                 )
             );
         }
 
         return $title;
     }

Here is the caller graph for this function:

◆ cloneDependencies()

ilObject::cloneDependencies	(	int	$target_id,
		int	$copy_id
	)

Clone object dependencies.

This method allows to refresh any ref id references to other objects that are affected in the same copy process. Ask ilCopyWizardOptions for the mappings.

Definition at line 1814 of file class.ilObject.php.

References ilConditionHandler\cloneDependencies(), getRefId(), and ilDidacticTemplateObjSettings\lookupTemplateId().

                                                                    : bool
     {
         ilConditionHandler::cloneDependencies($this->getRefId(), $target_id, $copy_id);
 
         $tpl_id = ilDidacticTemplateObjSettings::lookupTemplateId($this->getRefId());
         if ($tpl_id) {
             $factory = new ilObjectFactory();
             $obj = $factory->getInstanceByRefId($target_id, false);
             if ($obj instanceof ilObject) {
                 $obj->applyDidacticTemplate($tpl_id);
             }
         }
         return true;
     }

Here is the call graph for this function:

◆ cloneMetaData()

ilObject::cloneMetaData ( ilObject $target_obj )

Copy meta data.

Definition at line 1832 of file class.ilObject.php.

References $DIC, $path, _lookupType(), getId(), ilDidacticTemplateIconFactory\getInstance(), getType(), and null.

Referenced by ilObjSurveyQuestionPool\cloneObject(), ilObjLinkResource\cloneObject(), ilObjGlossary\cloneObject(), ilObjCourse\cloneObject(), ilObjQuestionPool\cloneObject(), ilObjTest\cloneObject(), ilObjMediaCast\copyOrder(), ilObjMediaPool\createFolder(), ilObjSurvey\importObject(), ilObjFileBasedLM\populateByDirectoy(), ilObjSAHSLearningModule\populateByDirectoy(), ilObjLearningSequence\raiseEvent(), ilObjGroup\read(), ilObjExercise\saveData(), ilObjSession\validate(), and ilObjContentObject\validatePages().

                                                        : bool
     {
         $this->lom_services->derive()
                            ->fromObject($this->getId(), 0, $this->getType())
                            ->forObject($target_obj->getId(), 0, $target_obj->getType());
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ collectDeletionDependencies()

static ilObject::collectDeletionDependencies	(	array &	$deps,
		int	$ref_id,
		int	$obj_id,
		string	$type,
		int	$depth = `0`
	)

static

Collect deletion dependencies.

E.g.

Definition at line 1974 of file class.ilObject.php.

References $c, $DIC, $id, $message, and ilTree\getChilds().

Referenced by ilRepositoryTrashGUI\showDeleteConfirmation().

      : void {
         global $DIC;
 
         $objDefinition = $DIC["objDefinition"];
         $tree = $DIC->repositoryTree();
 
         if ($depth == 0) {
             $deps["dep"] = [];
         }
 
         $deps["del_ids"][$obj_id] = $obj_id;
 
         if (!$objDefinition->isPluginTypeName($type)) {
             $class_name = "ilObj" . $objDefinition->getClassName($type);
             $odeps = call_user_func([$class_name, "getDeletionDependencies"], $obj_id);
             if (is_array($odeps)) {
                 foreach ($odeps as $id => $message) {
                     $deps["dep"][$id][$obj_id][] = $message;
                 }
             }
 
             // get deletion dependency of children
             foreach ($tree->getChilds($ref_id) as $c) {
                 ilObject::collectDeletionDependencies($deps, (int) $c["child"], (int) $c["obj_id"], (string) $c["type"], $depth + 1);
             }
         }
 
         // delete all dependencies to objects that will be deleted, too
         if ($depth == 0) {
             foreach ($deps["del_ids"] as $obj_id) {
                 unset($deps["dep"][$obj_id]);
             }
             $deps = $deps["dep"];
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ countReferences()

ilObject::countReferences ( )

final

Definition at line 1247 of file class.ilObject.php.

References $message, and $res.

Referenced by ilObjSurvey\delete(), and delete().

                                            : int
     {
         if (!isset($this->id)) {
             $message = "ilObject::countReferences(): No obj_id given!";
             $this->error->raiseError($message, $this->error->WARNING);
         }
 
         $sql =
             "SELECT COUNT(ref_id) num" . PHP_EOL
             . "FROM object_reference" . PHP_EOL
             . "WHERE obj_id = " . $this->db->quote($this->id, 'integer') . PHP_EOL
         ;
 
         $res = $this->db->query($sql);
         $row = $this->db->fetchObject($res);
 
         return (int) $row->num;
     }

Here is the caller graph for this function:

◆ create()

ilObject::create ( )

note: title, description and type should be set when this function is called

Definition at line 534 of file class.ilObject.php.

References $DIC, $id, $message, $owner, getDescription(), getId(), getImportId(), ilOrgUnitGlobalSettings\getInstance(), getLongDescription(), getObjectProperties(), getOwner(), getTitle(), getType(), null, setOwner(), and supportsOfflineHandling().

Referenced by ilWebDAVObjFactory\createDAVObject(), ilRemoteObjectBase\createFromECSEContent(), and ilObjEmployeeTalk\read().

                             : int
     {
         global $DIC;
         $user = $DIC["ilUser"];
 
         if (!isset($this->type)) {
             $message = sprintf("%s::create(): No object type given!", get_class($this));
             $this->error->raiseError($message, $this->error->WARNING);
         }
 
         $this->log->write("ilObject::create(), start");
 
         // determine owner
         $owner = 0;
         if ($this->getOwner() > 0) {
             $owner = $this->getOwner();
         } elseif (is_object($user)) {
             $owner = $user->getId();
         }
 
         $this->id = $this->db->nextId(self::TABLE_OBJECT_DATA);
         $values = [
             "obj_id" => ["integer", $this->getId()],
             "type" => ["text", $this->getType()],
             "title" => ["text", $this->getTitle()],
             "description" => ["text", $this->getDescription()],
             "owner" => ["integer", $owner],
             "create_date" => ["date", $this->db->now()],
             "last_update" => ["date", $this->db->now()],
             "import_id" => ["text", $this->getImportId()],
         ];
 
         $this->db->insert(self::TABLE_OBJECT_DATA, $values);
         $this->object_properties = null;
 
         // Save long form of description if is rbac object
         if ($this->obj_definition->isRBACObject($this->getType())) {
             $values = [
                 'obj_id' => ['integer',$this->id],
                 'description' => ['clob', $this->getLongDescription()]
             ];
             $this->db->insert('object_description', $values);
         }
 
         if ($this->supportsOfflineHandling()) {
             $property_is_online = $this->getObjectProperties()->getPropertyIsOnline()->withOffline();
             $this->getObjectProperties()->storePropertyIsOnline($property_is_online);
         }
 
         if ($this->obj_definition->isOrgUnitPermissionType($this->type)) {
             ilOrgUnitGlobalSettings::getInstance()->saveDefaultPositionActivationStatus($this->id);
         }
 
         // the line ($this->read();) messes up meta data handling: meta data,
         // that is not saved at this time, gets lost, so we query for the dates alone
         $sql =
             "SELECT last_update, create_date" . PHP_EOL
             . "FROM " . self::TABLE_OBJECT_DATA . PHP_EOL
             . "WHERE obj_id = " . $this->db->quote($this->id, "integer") . PHP_EOL
         ;
         $obj_set = $this->db->query($sql);
         $obj_rec = $this->db->fetchAssoc($obj_set);
         $this->last_update = $obj_rec["last_update"];
         $this->create_date = $obj_rec["create_date"];
 
         // set owner for new objects
         $this->setOwner($owner);
 
         // write log entry
         $this->log->write(
             sprintf(
                 "ilObject::create(), finished, obj_id: %s, type: %s, title: %s",
                 $this->getId(),
                 $this->getType(),
                 $this->getTitle()
             )
         );
 
         $this->app_event_handler->raise(
             'components/ILIAS/ILIASObject',
             'create',
             [
                 'obj_id' => $this->id,
                 'obj_type' => $this->type
             ]
         );
 
         return $this->id;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createMetaData()

ilObject::createMetaData ( )

final

Definition at line 690 of file class.ilObject.php.

References $DIC, beforeCreateMetaData(), doCreateMetaData(), getId(), getLongDescription(), getTitle(), and getType().

Referenced by ilObjLinkResource\create(), ilObjSurveyQuestionPool\create(), ilObjGlossary\create(), ilObjQuestionPool\create(), ilObjIndividualAssessment\create(), ilObjFileBasedLM\create(), ilObjSAHSLearningModule\create(), ilObjContentObject\create(), ilObjMediaPool\create(), ilObjSurvey\create(), ilObjMediaCast\create(), ilObjTest\create(), ilObjMediaObject\create(), ilObjExercise\create(), ilObjSession\create(), ilObjGroup\create(), ilObjCourse\create(), ilObjDataCollection\doCreate(), ilObjBlog\doCreate(), and ilObjContentPage\doCreate().

                                           : void
     {
         if ($this->beforeCreateMetaData()) {
             global $DIC;
             $ilUser = $DIC["ilUser"];
 
             $this->lom_services->derive()->fromBasicProperties(
                 $this->getTitle(),
                 $this->getLongDescription(),
                 $ilUser->getPref('language')
             )->forObject($this->getId(), 0, $this->getType());
 
             $this->doCreateMetaData();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createReference()

ilObject::createReference ( )

creates reference for object

Definition at line 1225 of file class.ilObject.php.

References $message, $ref_id, and getId().

Referenced by ilObjStudyProgramme\addNode(), ilSoapObjectAdministration\addReferences(), ilECSCourseCreationHandler\createCourseReference(), ilWebDAVObjFactory\createDAVObject(), ilRemoteObjectBase\createFromECSEContent(), ilObject2GUI\putObjectInTree(), and ilObjectGUI\putObjectInTree().

                                      : int
     {
         if (!isset($this->id)) {
             $message = "ilObject::createNewReference(): No obj_id given!";
             $this->error->raiseError($message, $this->error->WARNING);
         }
 
         $next_id = $this->db->nextId('object_reference');
 
         $values = [
             "ref_id" => ["integer", $next_id],
             "obj_id" => ["integer", $this->getId()]
         ];
 
         $this->db->insert("object_reference", $values);
 
         $this->ref_id = $next_id;
         $this->referenced = true;
 
         return $this->ref_id;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilObject::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!!

Returns: bool true if object was removed completely; false if only a references was removed

Definition at line 1274 of file class.ilObject.php.

References $DIC, ilAdvancedMDValues\_deleteByObjId(), ilLPObjSettings\_deleteByObjId(), ilBlockSetting\_deleteSettingsOfBlock(), _lookupType(), ilObjectDataDeletionLog\add(), countReferences(), ilRbacLog\delete(), ilObjectActivation\deleteAllEntries(), ilDidacticTemplateObjSettings\deleteByObjId(), ilDidacticTemplateObjSettings\deleteByRefId(), getId(), ilECSImportManager\getInstance(), getRefId(), getTitle(), getType(), and ilRbacAdmin\revokePermission().

Referenced by ilObject2GUI\deleteConfirmedObjects(), and ILIAS\Skill\Tree\SkillTreeManager\deleteTree().

                             : bool
     {
         global $DIC;
         $rbac_admin = $DIC["rbacadmin"];
 
         $remove = false;
 
         // delete object_data entry
         if ((!$this->referenced) || ($this->countReferences() == 1)) {
             $type = ilObject::_lookupType($this->getId());
             if ($this->type != $type) {
                 $log_entry = sprintf(
                     "ilObject::delete(): Type mismatch. Object with obj_id: %s was instantiated by type '%s'. DB type is: %s",
                     $this->id,
                     $this->type,
                     $type
                 );
 
                 $this->log->write($log_entry);
                 $this->error->raiseError(
                     sprintf("ilObject::delete(): Type mismatch. (%s/%s)", $this->type, $this->id),
                     $this->error->WARNING
                 );
             }
 
             $this->app_event_handler->raise('components/ILIAS/ILIASObject', 'beforeDeletion', ['object' => $this]);
 
             $sql =
                 "DELETE FROM " . self::TABLE_OBJECT_DATA . PHP_EOL
                 . "WHERE obj_id = " . $this->db->quote($this->getId(), "integer") . PHP_EOL
             ;
             $this->db->manipulate($sql);
 
             $sql =
                 "DELETE FROM object_description" . PHP_EOL
                 . "WHERE obj_id = " . $this->db->quote($this->getId(), "integer") . PHP_EOL
             ;
             $this->db->manipulate($sql);
 
             $this->log->write(
                 sprintf(
                     "ilObject::delete(), deleted object, obj_id: %s, type: %s, title: %s",
                     $this->getId(),
                     $this->getType(),
                     $this->getTitle()
                 )
             );
 
             // keep log of core object data
             ilObjectDataDeletionLog::add($this);
 
             // remove news
             $news_item = new ilNewsItem();
             $news_item->deleteNewsOfContext($this->getId(), $this->getType());
             ilBlockSetting::_deleteSettingsOfBlock($this->getId(), "news");
 
             ilDidacticTemplateObjSettings::deleteByObjId($this->getId());
 
             // BEGIN WebDAV: Delete WebDAV properties
             $sql =
                 "DELETE FROM dav_property" . PHP_EOL
                 . "WHERE obj_id = " . $this->db->quote($this->getId(), 'integer') . PHP_EOL
             ;
             $this->db->manipulate($sql);
             // END WebDAV: Delete WebDAV properties
 
             ilECSImportManager::getInstance()->_deleteByObjId($this->getId());
             ilAdvancedMDValues::_deleteByObjId($this->getId());
             ilLPObjSettings::_deleteByObjId($this->getId());
 
             $remove = true;
         } else {
             $this->log->write(
                 sprintf(
                     "ilObject::delete(), object not deleted, number of references: %s, obj_id: %s, type: %s, title: %s",
                     $this->countReferences(),
                     $this->getId(),
                     $this->getType(),
                     $this->getTitle()
                 )
             );
         }
 
         // delete object_reference entry
         if ($this->referenced) {
             ilObjectActivation::deleteAllEntries($this->getRefId());
 
             $this->app_event_handler->raise('components/ILIAS/ILIASObject', 'deleteReference', ['ref_id' => $this->getRefId()]);
 
             $sql =
                 "DELETE FROM object_reference" . PHP_EOL
                 . "WHERE ref_id = " . $this->db->quote($this->getRefId(), 'integer') . PHP_EOL
             ;
             $this->db->manipulate($sql);
 
             $this->log->write(
                 sprintf(
                     "ilObject::delete(), reference deleted, ref_id: %s, obj_id: %s, type: %s, title: %s",
                     $this->getRefId(),
                     $this->getId(),
                     $this->getType(),
                     $this->getTitle()
                 )
             );
 
             // DELETE PERMISSION ENTRIES IN RBAC_PA
             // DONE: method overwritten in ilObjRole & ilObjUser.
             // this call only applies for objects in rbac (not usr,role,rolt)
             // TODO: Do this for role templates too
             $rbac_admin->revokePermission($this->getRefId(), 0, false);
 
             ilRbacLog::delete($this->getRefId());
 
             // Remove applied didactic template setting
             ilDidacticTemplateObjSettings::deleteByRefId($this->getRefId());
         }
 
         // remove conditions
         if ($this->referenced) {
             $ch = new ilConditionHandler();
             $ch->delete($this->getRefId());
             unset($ch);
         }
 
         return $remove;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteMetaData()

ilObject::deleteMetaData ( )

final

Definition at line 746 of file class.ilObject.php.

References beforeDeleteMetaData(), doDeleteMetaData(), getId(), and getType().

Referenced by ilObjMediaObject\delete(), ilObjLinkResource\delete(), ilObjQuestionPool\delete(), ilObjIndividualAssessment\delete(), ilObjSurveyQuestionPool\delete(), ilObjFileBasedLM\delete(), ilObjMediaPool\delete(), ilObjSurvey\delete(), ilObjTest\delete(), ilObjExercise\delete(), ilObjMediaCast\delete(), ilObjGlossary\delete(), ilObjSession\delete(), ilObjGroup\delete(), ilObjCourse\delete(), ilObjSAHSLearningModule\delete(), ilObjDataCollection\doDelete(), ilObjBlog\doDelete(), ilObjFile\doDelete(), ilObjCmiXapi\doDelete(), and ilObjContentObject\getExportDirectory().

                                           : void
     {
         if ($this->beforeDeleteMetaData()) {
             $this->lom_services->deleteAll($this->getId(), 0, $this->getType());
             $this->doDeleteMetaData();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doCreateMetaData()

ilObject::doCreateMetaData ( )

protected

Definition at line 706 of file class.ilObject.php.

Referenced by createMetaData().

                                          : void
     {
     }

Here is the caller graph for this function:

◆ doDeleteMetaData()

ilObject::doDeleteMetaData ( )

protected

Definition at line 754 of file class.ilObject.php.

Referenced by deleteMetaData().

                                          : void
     {
     }

Here is the caller graph for this function:

◆ doMDUpdateListener()

ilObject::doMDUpdateListener ( string $a_element )

protected

Definition at line 681 of file class.ilObject.php.

Referenced by MDUpdateListener().

                                                             : void
     {
     }

Here is the caller graph for this function:

◆ doUpdateMetaData()

ilObject::doUpdateMetaData ( )

protected

Definition at line 737 of file class.ilObject.php.

Referenced by updateMetaData().

                                          : void
     {
     }

Here is the caller graph for this function:

◆ fixMissingTitles()

static ilObject::fixMissingTitles	(		$type,
		array &	$obj_title_map
	)

static

Try to fix missing object titles.

Definition at line 2089 of file class.ilObject.php.

References $DIC, ilDBInterface\fetchAssoc(), ilDBInterface\in(), and ilDBInterface\query().

Referenced by ilObjectOwnershipManagementGUI\listObjects().

     {
         global $DIC;
         $db = $DIC->database();
 
         if (!in_array($type, ["catr", "crsr", "sess", "grpr", "prgr"])) {
             return;
         }
 
         // any missing titles?
         $missing_obj_ids = [];
         foreach ($obj_title_map as $obj_id => $title) {
             if (!trim($title)) {
                 $missing_obj_ids[] = $obj_id;
             }
         }
 
         if (!sizeof($missing_obj_ids)) {
             return;
         }
 
         switch ($type) {
             case "grpr":
             case "catr":
             case "crsr":
             case "prgr":
                 $sql =
                     "SELECT oref.obj_id, od.type, od.title" . PHP_EOL
                     . "FROM object_data od" . PHP_EOL
                     . "JOIN container_reference oref ON (od.obj_id = oref.target_obj_id)" . PHP_EOL
                     . "AND " . $db->in("oref.obj_id", $missing_obj_ids, false, "integer") . PHP_EOL
                 ;
                 $result = $db->query($sql);
 
                 while ($row = $db->fetchAssoc($result)) {
                     $obj_title_map[$row["obj_id"]] = $row["title"];
                 }
                 break;
             case "sess":
                 foreach ($missing_obj_ids as $obj_id) {
                     $sess = new ilObjSession($obj_id, false);
                     $obj_title_map[$obj_id] = $sess->getFirstAppointment()->appointmentToString();
                 }
                 break;
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ flushObjectProperties()

ilObject::flushObjectProperties ( )

Deprecated:: 11: Do absolutely not use this! I will NOT check any usages before removal.

Definition at line 150 of file class.ilObject.php.

References null.

                                            : void
     {
         $this->object_properties = null;
     }

◆ getAllOwnedRepositoryObjects()

static ilObject::getAllOwnedRepositoryObjects ( int $user_id )

static

Definition at line 2043 of file class.ilObject.php.

References $DIC, $res, ilDBInterface\fetchAssoc(), ilObjectDefinition\getSubObjectsRecursively(), ilDBInterface\in(), ilDBInterface\query(), and ilDBInterface\quote().

Referenced by ilObjectOwnershipManagementGUI\listObjects().

                                                                      : array
     {
         global $DIC;
 
         $db = $DIC->database();
         $obj_definition = $DIC["objDefinition"];
 
         // restrict to repository
         $types = array_keys($obj_definition->getSubObjectsRecursively("root"));
 
         $sql =
             "SELECT od.obj_id, od.type, od.title" . PHP_EOL
             . "FROM object_data od" . PHP_EOL
             . "JOIN object_reference oref ON(oref.obj_id = od.obj_id)" . PHP_EOL
             . "JOIN tree ON (tree.child = oref.ref_id)" . PHP_EOL
         ;
 
         if ($user_id) {
             $sql .= "WHERE od.owner = " . $db->quote($user_id, "integer") . PHP_EOL;
         } else {
             $sql .=
                 "LEFT JOIN usr_data ud ON (ud.usr_id = od.owner)" . PHP_EOL
                 . "WHERE (od.owner < " . $db->quote(1, "integer") . PHP_EOL
                 . "OR od.owner IS NULL OR ud.login IS NULL)" . PHP_EOL
                 . "AND od.owner <> " . $db->quote(-1, "integer") . PHP_EOL
             ;
         }
 
         $sql .=
             "AND " . $db->in("od.type", $types, false, "text") . PHP_EOL
             . "AND tree.tree > " . $db->quote(0, "integer") . PHP_EOL
         ;
 
         $res = $db->query($sql);
 
         $all = [];
         while ($row = $db->fetchAssoc($res)) {
             $all[$row["type"]][$row["obj_id"]] = $row["title"];
         }
 
         return $all;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCallbackForTitlesPerLanguageTransformation()

ilObject::getCallbackForTitlesPerLanguageTransformation ( )

private

Definition at line 1729 of file class.ilObject.php.

References $lang.

Referenced by appendCopyInfoToTranslations().

                                                                     : callable
     {
         return function (array $npl, ?ilObjectTranslation $nt): array {
             $langs = $nt->getLanguages();
             foreach ($langs as $lang) {
                 if (!array_key_exists($lang->getLanguageCode(), $npl)) {
                     $npl[$lang->getLanguageCode()] = [];
                 }
                 $npl[$lang->getLanguageCode()][] = $lang->getTitle();
             }
             return $npl;
         };
     }

Here is the caller graph for this function:

◆ getCreateDate()

ilObject::getCreateDate ( )

final

Get create date in YYYY-MM-DD HH-MM-SS format.

Definition at line 517 of file class.ilObject.php.

References $create_date.

Referenced by ilObjUser\deleteUserDefinedFieldEntries(), ilCmiXapiUser\getIdent(), ilCmiXapiUser\getIdentAsId(), and ilObjectXMLWriter\getXML().

                                          : string
     {
         return $this->create_date;
     }

Here is the caller graph for this function:

◆ getDeletionDependencies()

static ilObject::getDeletionDependencies ( int $obj_id )

static

Get deletion dependencies.

Definition at line 2019 of file class.ilObject.php.

◆ getDescription()

ilObject::getDescription ( )

final

Definition at line 363 of file class.ilObject.php.

References $desc.

Referenced by _prepareCloneSelection(), ilObjContentPageGUI\afterSave(), ilObjMediaObject\beforeUpdateMetaData(), ilObjLTIConsumer\buildLaunchParameters(), ilObjLTIConsumer\buildLaunchParametersLTI13(), ilObjGlossary\cloneObject(), create(), ilContainer\create(), ilObjMediaPool\createFolder(), ilObjTaxonomy\doCloneObject(), ilObjItemGroup\doCreate(), ilObjFile\doCreate(), ilObjFile\doUpdate(), ilObjMediaObject\duplicate(), ilObjQuestionPool\exportTitleAndDescription(), ilStudyProgrammeExpandableProgressListGUI\getAccordionContentCoursesHTML(), ilObjCmiXapi\getStatementContextActivities(), ilObjCmiXapi\getStatementObject(), ilObjectXMLWriter\getXML(), ilObjStyleSheet\getXML(), ilObjStyleSheet\ilClone(), ilIndividualAssessmentSettingsStorageDB\loadSettings(), ilObjSAHSLearningModule\populateByDirectoy(), ilObjRoleFolder\read(), ilObjForum\saveData(), ilRemoteObjectBase\sendNewContentNotification(), ilObjLinkResource\toXML(), ilObjSurvey\toXML(), ilObjTest\toXML(), ilObjForum\update(), updateMetaData(), and ilObjContentObject\validatePages().

                                           : string
     {
         return $this->desc;
     }

Here is the caller graph for this function:

◆ getHTMLDirectory()

ilObject::getHTMLDirectory ( )

Definition at line 1466 of file class.ilObject.php.

                                       : bool
     {
         return false;
     }

◆ getIconForType()

static ilObject::getIconForType ( string $type )

static

Definition at line 1894 of file class.ilObject.php.

References $DIC, $location, and ilUtil\getImagePath().

Referenced by ilObjectGUI\buildSubItemsForGroup(), and ilObjectGUI\createObject().

                                                        : string
     {
         global $DIC;
         $objDefinition = $DIC['objDefinition'];
         if (!$objDefinition->isPluginTypeName($type)) {
             return ilUtil::getImagePath("standard/icon_{$type}.svg");
         }
 
         if ($objDefinition->getClassName($type) !== '') {
             $class_name = "il{$objDefinition->getClassName($type)}Plugin";
             $location = $objDefinition->getLocation($type);
             if (is_file($location . "/class.{$class_name}.php")) {
                 return call_user_func([$class_name, '_getIcon'], $type);
             }
         }
         return ilUtil::getImagePath('standard/icon_cmps.svg');
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getId()

ilObject::getId ( )

Definition at line 294 of file class.ilObject.php.

References $id.

                            : int
     {
         return $this->id;
     }

Here is the caller graph for this function:

◆ getImportId()

ilObject::getImportId ( )

final

Definition at line 395 of file class.ilObject.php.

References $import_id.

Referenced by create(), and ilObjectXMLWriter\getXML().

                                        : string
     {
         return $this->import_id;
     }

Here is the caller graph for this function:

◆ getLastUpdateDate()

ilObject::getLastUpdateDate ( )

final

Get last update date in YYYY-MM-DD HH-MM-SS format.

Definition at line 525 of file class.ilObject.php.

References $last_update.

Referenced by ilObjectXMLWriter\getXML().

                                              : string
     {
         return $this->last_update;
     }

Here is the caller graph for this function:

◆ getLongDescription()

ilObject::getLongDescription ( )

get object long description (stored in object_description)

Definition at line 383 of file class.ilObject.php.

References $desc, and $long_desc.

Referenced by _prepareCloneSelection(), ilObjectDataDeletionLog\add(), ilObjMediaObject\beforeCreateMetaData(), ilObjLearningSequenceSettingsGUI\buildFormElements(), create(), createMetaData(), ilObjItemGroup\doUpdate(), ilObjContentPage\doUpdate(), ILIAS\Repository\Provider\RepositoryOpenGraphExposer\exposeObjectOpenGraphMetaData(), ilObjExerciseGUI\getEditFormCustomValues(), ILIAS\EmployeeTalk\Notification\Calendar\VCalendarGenerator\getEventfromTalk(), ilSoapStructureObjectFactory\getInstanceForObject(), ilObjGroup\prepareAppointments(), ilObjCourse\prepareAppointments(), ilObjSession\prepareCalendarAppointments(), ilObjEmployeeTalk\read(), ilPollContentRenderer\render(), ilContainer\update(), and updateMetaData().

                                         : string
     {
         if ($this->long_desc !== '') {
             return $this->long_desc;
         }
 
         if ($this->desc !== '') {
             return $this->desc;
         }
         return '';
     }

Here is the caller graph for this function:

◆ getLongDescriptions()

static ilObject::getLongDescriptions ( array $obj_ids )

static

Definition at line 2024 of file class.ilObject.php.

References $DIC, ilDBInterface\fetchAssoc(), ilDBInterface\in(), and ilDBInterface\query().

Referenced by ILIAS\UI\Component\Legacy\Content\ItemSetManager\getCompleteDescriptions(), and ilContainer\getCompleteDescriptions().

                                                               : array
     {
         global $DIC;
         $db = $DIC->database();
 
         $sql =
             "SELECT obj_id, description" . PHP_EOL
             . "FROM object_description" . PHP_EOL
             . "WHERE " . $db->in("obj_id", $obj_ids, false, "integer") . PHP_EOL
         ;
         $result = $db->query($sql);
 
         $all = [];
         while ($row = $db->fetchAssoc($result)) {
             $all[$row["obj_id"]] = $row["description"];
         }
         return $all;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getObjectProperties()

ilObject::getObjectProperties ( )

Definition at line 139 of file class.ilObject.php.

References $object_properties, and null.

Referenced by _prepareCloneSelection(), ilObjLearningSequenceSettingsGUI\buildFormElements(), ilObjLearningSequence\cloneActivation(), create(), ilObjBibliographic\doCloneObject(), ilObjFile\doCloneObject(), ilObjBibliographic\doCreate(), ilObjFile\doCreate(), ilObjTest\fromXML(), getOfflineStatus(), ILIAS\Repository\Provider\RepositoryOpenGraphExposer\getPresentationImage(), ilTestImporter\importQuestionSkillAssignments(), ilObjTest\isExecutable(), ilObjTest\removeQuestionWithResults(), setDescription(), setImportId(), setOfflineStatus(), setTitle(), and update().

                                          : ilObjectProperties
     {
         if ($this->object_properties === null) {
             $this->object_properties = $this->object_dic['object_properties_agregator']->getFor($this->id, $this->type);
         }
         return $this->object_properties;
     }

Here is the caller graph for this function:

◆ getOfflineStatus()

ilObject::getOfflineStatus ( )

Definition at line 444 of file class.ilObject.php.

References getObjectProperties().

Referenced by ilObjSurvey\checkReminder(), ilObjCourse\cloneSettings(), ilObjContentPage\doCloneObject(), ilObjectXMLWriter\getXML(), ilObjSurvey\importObject(), ilObjCourse\isActivated(), ilPollStateInfo\isOfflineOrUnavailable(), ilObjFileBasedLM\populateByDirectoy(), ilObjSAHSLearningModule\populateByDirectoy(), ilObjCourse\prepareAppointments(), ilObjSurvey\toXML(), ilObjForum\update(), ilObjCourse\updateSettings(), and ilObjContentObject\validatePages().

                                       : bool
     {
         return !$this->getObjectProperties()->getPropertyIsOnline()->getIsOnline();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOwner()

ilObject::getOwner ( )

final

Definition at line 473 of file class.ilObject.php.

References $owner.

Referenced by ilObjChatroomGUI\afterImport(), ilObjChatroomGUI\afterSave(), ilObjForum\cloneAutoGeneratedRoles(), create(), getOwnerName(), ilObjectXMLWriter\getXML(), ilEmployeeTalkAppointmentGUI\loadRecurrenceSettings(), ilObjTest\sendAdvancedNotification(), ilObjTest\sendSimpleNotification(), ilObjForum\setPermissions(), and updateOwner().

                                     : int
     {
         return $this->owner;
     }

Here is the caller graph for this function:

◆ getOwnerName()

ilObject::getOwnerName ( )

final

get full name of object owner

Definition at line 481 of file class.ilObject.php.

References _lookupOwnerName(), and getOwner().

                                         : string
     {
         return ilObject::_lookupOwnerName($this->getOwner());
     }

Here is the call graph for this function:

◆ getPossibleSubObjects()

ilObject::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

Parameters

bool	filter disabled objects? ($a_filter = true)

Returns: array list of allowed object types

Definition at line 2159 of file class.ilObject.php.

                                                               : array
     {
         return $this->obj_definition->getSubObjects($this->type, $filter);
     }

◆ getPresentationTitle()

ilObject::getPresentationTitle ( )

get presentation title Normally same as title Overwritten for sessions

Definition at line 330 of file class.ilObject.php.

References getTitle().

Referenced by ILIAS\Repository\Provider\RepositoryOpenGraphExposer\exposeObjectOpenGraphMetaData().

                                           : string
     {
         return $this->getTitle();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRefId()

ilObject::getRefId ( )

final

Definition at line 310 of file class.ilObject.php.

                                     : int
     {
         return $this->ref_id ?? 0;
     }

Here is the caller graph for this function:

◆ getTitle()

ilObject::getTitle ( )

Definition at line 335 of file class.ilObject.php.

References $title.

Referenced by ilConditionHandlerGUI\__construct(), _prepareCloneSelection(), ilObjectDataDeletionLog\add(), ilObjMediaPoolGUI\addMobsToPool(), ilObjChatroomGUI\afterImport(), ilObjChatroomGUI\afterSave(), ilObjLTIConsumerGUI\afterSave(), ilObjContentPageGUI\afterSave(), appendCopyInfo(), ilObjMediaObject\beforeCreateMetaData(), ilObjFile\beforeUpdate(), ilObjMediaObject\beforeUpdateMetaData(), ilObjFileComponentBuilder\buildConfirmDeleteAllVersionsModal(), ilObjFileComponentBuilder\buildConfirmDeleteSpecificVersionsModal(), ilObjLearningSequenceSettingsGUI\buildFormElements(), ilObjLTIConsumer\buildLaunchParameters(), ilObjLTIConsumer\buildLaunchParametersLTI13(), ilMailSearchObjectGUI\cancel(), ilObjSurvey\checkReminder(), ilObjFileBasedLM\create(), ilObjMediaObject\create(), create(), ilContainer\create(), ilCalendarAppEventListener\createCategory(), ilWebDAVObjFactory\createDAVObject(), ilObjMediaPool\createFolder(), createMetaData(), ilObjBlogGUI\createPosting(), ilObjSurvey\delete(), delete(), ilObjTest\deliverPDFfromFO(), ilObjTest\deliverPDFfromHTML(), ilObjTaxonomy\doCloneObject(), ilObjFile\doCloneObject(), ilObjDataCollection\doCreate(), ilObjItemGroup\doCreate(), ilObjDataCollection\doUpdate(), ilObjItemGroup\doUpdate(), ilObjContentPage\doUpdate(), ilObjMediaObject\duplicate(), ilObjMediaPoolGUI\executeCommand(), ilObjExercise\exportGradesExcel(), ilObjSCORMLearningModule\exportSelected(), ilObjQuestionPool\exportTitleAndDescription(), ilMediaPoolPageUsagesTableGUI\fillRow(), ilMediaObjectUsagesTableGUI\fillRow(), ILIAS\EmployeeTalk\Notification\Calendar\VCalendarGenerator\fromTalkSeries(), ilStudyProgrammeExpandableProgressListGUI\getAccordionContentCoursesHTML(), ilObjMediaCastGUI\getCastItemValues(), ILIAS\EmployeeTalk\Notification\Calendar\VCalendarGenerator\getEventfromTalk(), ilObjRoleTemplate\getFilterOfInternalTemplate(), ilDclReferenceFieldRepresentation\getInputField(), ilSoapStructureObjectFactory\getInstanceForObject(), ilVerificationObject\getOfflineFilename(), ilObjRoleTemplate\getPresentationTitle(), ilObjSession\getPresentationTitle(), ilObjRole\getPresentationTitle(), ilContainerReference\getPresentationTitle(), getPresentationTitle(), ilObjSession\getPresentationTitleAppointmentPeriod(), ilObjCmiXapi\getStatementContextActivities(), ilObjCmiXapi\getStatementObject(), ilObjTest\getTitleFilenameCompliant(), ilStudyProgrammeIndividualPlanProgressListGUI\getTitleForItem(), ilStudyProgrammeProgressListGUI\getTitleForItem(), ilObjectXMLWriter\getXML(), ilObjMediaObject\getXML(), ilObjStyleSheet\getXML(), ilObjCourse\handleAutoFill(), ilObjStyleSheet\ilClone(), ilMediaObjectsPlayerWrapperGUI\image(), ilObjCmiXapiGUI\initMetadata(), ilObjLTIConsumerGUI\initMetadata(), ilObjSurvey\isComplete(), ilObjFile\isHidden(), ilObjRoleTemplate\isInternalTemplate(), ilIndividualAssessmentSettingsStorageDB\loadSettings(), ilObjGroup\prepareAppointments(), ilObjCourse\prepareAppointments(), ilObjSession\prepareCalendarAppointments(), putInTree(), ilObjRoleFolder\read(), ilObjEmployeeTalk\read(), ilObjGroup\register(), ilObjPortfolioBaseGUI\renderFullscreenHeader(), ilObjForum\saveData(), ilObjSurvey\send360ReminderToUser(), ilObjTest\sendAdvancedNotification(), ilObjSurvey\sendAppraiseeCloseNotification(), ilObjSurvey\sendAppraiseeNotification(), ilPRGMail\sendMail(), ilRemoteObjectBase\sendNewContentNotification(), ilObjSurvey\sendRaterNotification(), ilObjTest\sendSimpleNotification(), ilObjSurvey\sendTutorNotification(), ilObjLinkResource\toXML(), ilObjSurveyQuestionPool\toXML(), ilObjSurvey\toXML(), ilObjTest\toXML(), ilObjSurveyQuestionPool\toXmlForExport(), ilObjForum\update(), ilObjExercise\update(), ilContainer\update(), ilCalendarAppEventListener\updateCategory(), updateMetaData(), ilObjRole\validate(), ilObjGroup\validate(), and ilObjCourse\validate().

                               : string
     {
         return $this->title;
     }

Here is the caller graph for this function:

◆ getType()

ilObject::getType ( )

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

References $type.

Referenced by ilCertificateCloneAction\__construct(), ilConditionHandlerGUI\__construct(), ilObjectMetaDataGUI\__construct(), ilObjCourseGrouping\_checkGroupingDependencies(), ilObjCourseGrouping\_getGroupingItems(), _prepareCloneSelection(), ilObjectDataDeletionLog\add(), ilObjMediaCast\addMobToCast(), ilObjCmiXapiGUI\afterSave(), ilObjLTIConsumerGUI\afterSave(), ilObjectXMLWriter\appendObjectProperties(), ilObjContentObject\autoLinkGlossaryTerms(), ilObjMediaObject\beforeCreateMetaData(), ilObjMediaObject\beforeDeleteMetaData(), ilObjMediaObject\beforeMDUpdateListener(), ilObjMediaObject\beforeUpdateMetaData(), ilObjFileComponentBuilder\buildConfirmDeleteAllVersionsModal(), ilObjFileComponentBuilder\buildConfirmDeleteSpecificVersionsModal(), cloneMetaData(), ilObjQuestionPool\cloneObject(), ilObjMediaCast\copyItems(), ilObjEmployeeTalkSeriesGUI\copyTemplateValues(), ilCertificatePathFactory\create(), ilCertificateGUIFactory\create(), create(), ilCalendarAppEventListener\createCategory(), ilWebDAVObjFactory\createDAVObject(), ilObjGlossary\createExportDirectory(), createMetaData(), ilObjForum\delete(), delete(), deleteMetaData(), ilObjContentPage\doCloneObject(), ilObjContentPage\doDelete(), ilObjLinkResource\doMDUpdateListener(), ilObjContentObject\doMDUpdateListener(), ilContainerGUI\downloadObject(), ilTestRandomQuestionSetPoolDeriver\duplicateTaxonomies(), ilObjMediaPool\exportXML(), ilObjContentObject\exportXML(), ilObjContentObject\exportXMLPageObjects(), ILIAS\Repository\Provider\RepositoryOpenGraphExposer\exposeObjectOpenGraphMetaData(), ilContainer\filteredSubtree(), ilObjItemGroup\fixContainerItemGroupRefsAfterCloning(), ilObjPortfolioBase\fixLinksOnTitleChange(), ILIAS\EmployeeTalk\Notification\Calendar\VCalendarGenerator\fromTalkSeries(), ilObjectXMLWriter\getAccessInfo(), ilObjSurvey\getAuthor(), ilObjTest\getAuthor(), ILIAS\EmployeeTalk\Notification\Calendar\VCalendarGenerator\getEventfromTalk(), ilObjGlossary\getExportDirectory(), ilObjQuestionPool\getExportDirectory(), ILIAS\Export\ExportHandler\Manager\Handler\getExportTargetWithObject(), ilContainer\getGroupedObjTypes(), ilECSObjectSettings\getInstanceByObject(), ilSoapStructureObjectFactory\getInstanceForObject(), ilObjCmiXapi\getLaunchData(), ilObjContentPage\getPageObjIds(), ilObjForum\getPageObjIds(), ilObjectPlugin\getPlugin(), ilContainer\getSubItems(), ilObjectPermissionStatusGUI\getUser(), ilKioskModeService\getViewFor(), ilObjectXMLWriter\getXML(), ilObjMediaObject\getXML(), ilObjStyleSheet\ilClone(), ilRemoteObjectBase\importMetadataFromJson(), ilObjCmiXapiGUI\initMetadata(), ilObjLTIConsumerGUI\initMetadata(), ilContainer\isClassificationFilterActive(), ilContainerGUI\linkObject(), MDUpdateListener(), putInTree(), ilObjMediaCast\readItems(), ilObjPortfolioBaseGUI\renderFullscreenHeader(), ilObjSurvey\saveAuthorToMetadata(), ilObjTest\saveAuthorToMetadata(), ilRemoteObjectBase\sendNewContentNotification(), ilObjGroup\setParentRolePermissions(), setParentRolePermissions(), supportsOfflineHandling(), ilObjSurveyQuestionPool\toXML(), ilObjContentPage\trackProgress(), ilObjForum\update(), update(), ilObjStudyProgramme\updateCustomIcon(), ilObjGroup\updateGroupType(), ilPortfolioPage\updateInternalLinks(), updateMetaData(), and ilObjContentObject\validatePages().

                              : string
     {
         return $this->type;
     }

Here is the caller graph for this function:

◆ getUntranslatedTitle()

ilObject::getUntranslatedTitle ( )

final

Get untranslated object title WebDAV needs to access the untranslated title of an object.

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

References $untranslatedTitle.

Referenced by ilObjRoleTemplate\getPresentationTitle(), and ilObjRole\getPresentationTitle().

                                                 : string
     {
         return $this->untranslatedTitle;
     }

Here is the caller graph for this function:

◆ getXMLZip()

ilObject::getXMLZip ( )

Definition at line 1462 of file class.ilObject.php.

                                : string
     {
         return "";
     }

◆ handleAutoRating()

ilObject::handleAutoRating ( )

protected

Definition at line 1929 of file class.ilObject.php.

References hasAutoRating(), and update().

Referenced by putInTree().

                                          : void
     {
         if ($this->process_auto_reating
             && $this->hasAutoRating()
             && method_exists($this, "setRating")
         ) {
             $this->setRating(true);
             $this->update();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasAutoRating()

ilObject::hasAutoRating ( )

protected

Definition at line 1940 of file class.ilObject.php.

References $type, getRefId(), and selfOrParentWithRatingEnabled().

Referenced by handleAutoRating().

                                       : bool
     {
         $ref_id = $this->getRefId();
         $type = $this->type;
 
         if (!$ref_id || !in_array($type, ["file", "lm", "wiki"])) {
             return false;
         }
 
         return $this->selfOrParentWithRatingEnabled();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initDefaultRoles()

ilObject::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 set up default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example).

Definition at line 1408 of file class.ilObject.php.

Referenced by setPermissions().

                                       : void
     {
     }

Here is the caller graph for this function:

◆ isTitleUnique()

ilObject::isTitleUnique	(	string	$title,
		array	$nodes
	)

private

Definition at line 1764 of file class.ilObject.php.

Referenced by appendNumberOfCopiesToTitle().

                                                                : bool
     {
         foreach ($nodes as $node) {
             if (($title === $node)) {
                 return false;
             }
         }
         return true;
     }

Here is the caller graph for this function:

◆ lookupOfflineStatus()

static ilObject::lookupOfflineStatus ( int $obj_id )

static

Lookup offline status using objectDataCache.

Definition at line 839 of file class.ilObject.php.

References $DIC.

Referenced by ilObjContentObjectAccess\_checkAccess(), ilObjectAccess\_isOffline(), ilObjTestAccess\_isOffline(), ilAccess\doActivationCheck(), LSItemOnlineStatus\getOnlineStatus(), ilObjBookingPool\getPoolsWithReminders(), ilObjChatroomListGUI\getProperties(), ilObjForumListGUI\getProperties(), ilObjSurveyListGUI\getProperties(), ilObjContentPageListGUI\getProperties(), ilObjectListGUI\getProperties(), ilObjEmployeeTalkSeriesGUI\getTemplateRefId(), ilObjChatroomAccess\lookupOnline(), ilCourseObjectivesTableGUI\parse(), and ilContainerXmlWriter\writeSubitems().

                                                            : bool
     {
         global $DIC;
         return $DIC['ilObjDataCache']->lookupOfflineStatus($obj_id);
     }

Here is the caller graph for this function:

◆ MDUpdateListener()

ilObject::MDUpdateListener ( string $element )

final

Metadata update listener.

Important note: Do never call create() or update() method of ilObject here. It would result in an endless loop: update object -> update meta -> update object -> ... Use static _writeTitle() ... methods instead.

Definition at line 650 of file class.ilObject.php.

References beforeMDUpdateListener(), doMDUpdateListener(), getId(), getRefId(), getType(), setDescription(), setTitle(), and update().

                                                            : void
     {
         if ($this->beforeMDUpdateListener($element)) {
             $this->app_event_handler->raise(
                 'components/ILIAS/ILIASObject',
                 'update',
                 ['obj_id' => $this->getId(),
                       'obj_type' => $this->getType(),
                       'ref_id' => $this->getRefId()
                 ]
             );
 
             // Update Title and description
             if ($element == 'General') {
                 $paths = $this->lom_services->paths();
                 $reader = $this->lom_services->read(
                     $this->getId(),
                     0,
                     $this->getType(),
                     $paths->custom()->withNextStep('general')->get()
                 );
 
                 $this->setTitle($reader->firstData($paths->title())->value());
                 $this->setDescription($reader->firstData($paths->descriptions())->value());
 
                 $this->update();
             }
             $this->doMDUpdateListener($element);
         }
     }

Here is the call graph for this function:

◆ processAutoRating()

ilObject::processAutoRating ( )

Deprecated:: : This function will be removed asap.

Definition at line 168 of file class.ilObject.php.

                                        : void
     {
         $this->process_auto_reating = true;
     }

◆ putInTree()

ilObject::putInTree ( int $parent_ref_id )

maybe this method should be in tree object!?

Todo:: role/rbac stuff

Definition at line 1162 of file class.ilObject.php.

References getId(), getRefId(), getTitle(), getType(), and handleAutoRating().

Referenced by ilSoapObjectAdministration\addReferences(), ilWebDAVObjFactory\createDAVObject(), ilRemoteObjectBase\createFromECSEContent(), ilObject2GUI\putObjectInTree(), and ilObjectGUI\putObjectInTree().

                                                  : void
     {
         $this->tree->insertNode($this->getRefId(), $parent_ref_id);
         $this->handleAutoRating();
 
         $log_entry = sprintf(
             "ilObject::putInTree(), parent_ref: %s, ref_id: %s, obj_id: %s, type: %s, title: %s",
             $parent_ref_id,
             $this->getRefId(),
             $this->getId(),
             $this->getType(),
             $this->getTitle()
         );
 
         $this->log->write($log_entry);
 
         $this->app_event_handler->raise(
             'components/ILIAS/ILIASObject',
             'putObjectInTree',
             [
                 'object' => $this,
                 'obj_type' => $this->getType(),
                 'obj_id' => $this->getId(),
                 'parent_ref_id' => $parent_ref_id
             ]
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilObject::read ( )

Definition at line 173 of file class.ilObject.php.

References $DIC, Vendor\Package\$e, $message, $r, $res, ilDBConstants\FETCHMODE_OBJECT, ILIAS\Repository\int(), ILIAS\Repository\lng(), null, and setDescription().

Referenced by updateOwner().

                           : void
     {
         global $DIC;
         try {
             $ilUser = $DIC["ilUser"];
         } catch (InvalidArgumentException $e) {
         }
 
         if ($this->referenced) {
             if (!isset($this->ref_id)) {
                 $message = "ilObject::read(): No ref_id given! (" . $this->type . ")";
                 $this->error->raiseError($message, $this->error->WARNING);
             }
 
             // read object data
             $sql =
                 "SELECT od.obj_id, od.type, od.title, od.description, od.owner, od.create_date," . PHP_EOL
                 . "od.last_update, od.import_id, ore.ref_id, ore.obj_id, ore.deleted, ore.deleted_by" . PHP_EOL
                 . "FROM " . self::TABLE_OBJECT_DATA . " od" . PHP_EOL
                 . "JOIN object_reference ore ON od.obj_id = ore.obj_id" . PHP_EOL
                 . "WHERE ore.ref_id = " . $this->db->quote($this->ref_id, "integer") . PHP_EOL
             ;
 
             $result = $this->db->query($sql);
 
             // check number of records
             if ($this->db->numRows($result) === 0) {
                 $message = sprintf(
                     "ilObject::read(): Object with ref_id %s not found! (%s)",
                     $this->ref_id,
                     $this->type
                 );
                 $this->error->raiseError($message, $this->error->WARNING);
             }
         } else {
             if (!isset($this->id)) {
                 $message = sprintf("ilObject::read(): No obj_id given! (%s)", $this->type);
                 $this->error->raiseError($message, $this->error->WARNING);
             }
 
             $sql =
                 "SELECT obj_id, type, title, description, owner, create_date, last_update, import_id, offline" . PHP_EOL
                 . "FROM " . self::TABLE_OBJECT_DATA . PHP_EOL
                 . "WHERE obj_id = " . $this->db->quote($this->id, "integer") . PHP_EOL
             ;
             $result = $this->db->query($sql);
 
             if ($this->db->numRows($result) === 0) {
                 $message = sprintf("ilObject::read(): Object with obj_id: %s (%s) not found!", $this->id, $this->type);
                 throw new ilObjectNotFoundException($message);
             }
         }
         $obj = $this->db->fetchAssoc($result);
 
         $this->id = (int) $obj["obj_id"];
 
         // check type match (the "xxx" type is used for the unit test)
         if ($this->type != $obj["type"] && $obj["type"] != "xxx") {
             $message = sprintf(
                 "ilObject::read(): Type mismatch. Object with obj_id: %s was instantiated by type '%s'. DB type is: %s",
                 $this->id,
                 $this->type,
                 $obj["type"]
             );
 
             $this->log->write($message);
             throw new ilObjectTypeMismatchException($message);
         }
 
         $this->type = (string) $obj["type"];
         $this->title = (string) $obj["title"];
         // BEGIN WebDAV: WebDAV needs to access the untranslated title of an object
         $this->untranslatedTitle = (string) $obj["title"];
         // END WebDAV: WebDAV needs to access the untranslated title of an object
 
         $this->desc = (string) $obj["description"];
         $this->owner = (int) $obj["owner"];
         $this->create_date = (string) $obj["create_date"];
         $this->last_update = (string) $obj["last_update"];
         $this->import_id = (string) $obj["import_id"];
 
         if ($this->obj_definition->isRBACObject($this->getType())) {
             $sql =
                 "SELECT obj_id, description" . PHP_EOL
                 . "FROM object_description" . PHP_EOL
                 . "WHERE obj_id = " . $this->db->quote($this->id, 'integer') . PHP_EOL
             ;
 
             $res = $this->db->query($sql);
 
             while ($row = $res->fetchRow(ilDBConstants::FETCHMODE_OBJECT)) {
                 if (($row->description ?? '') !== '') {
                     $this->setDescription($row->description);
                 }
             }
         }
 
         // multilingual support system objects (sys) & categories (db)
         $translation_type = $this->obj_definition->getTranslationType($this->type);
 
         if ($translation_type == "sys") {
             $this->title = $this->lng->txt("obj_" . $this->type);
             $this->setDescription($this->lng->txt("obj_" . $this->type . "_desc"));
         } elseif ($translation_type == "db") {
             $sql =
                 "SELECT title, description" . PHP_EOL
                 . "FROM object_translation" . PHP_EOL
                 . "WHERE obj_id = " . $this->db->quote($this->id, 'integer') . PHP_EOL
                 . "AND lang_code = " . $this->db->quote($ilUser->getCurrentLanguage(), 'text') . PHP_EOL
             ;
             $r = $this->db->query($sql);
             $row = $r->fetchRow(ilDBConstants::FETCHMODE_OBJECT);
             if ($row) {
                 $this->title = (string) $row->title;
                 $this->setDescription((string) $row->description);
             }
         }
 
         $this->object_properties = null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ selfOrParentWithRatingEnabled()

ilObject::selfOrParentWithRatingEnabled ( )

Definition at line 1952 of file class.ilObject.php.

References $tree, ilContainer\_lookupContainerSetting(), _lookupObjId(), ilObjectServiceSettingsGUI\AUTO_RATING_NEW_OBJECTS, ilTree\checkForParentType(), and getRefId().

Referenced by hasAutoRating().

                                                    : bool
     {
         $tree = $this->tree;
         $ref_id = $this->getRefId();
         $parent_ref_id = $tree->checkForParentType($ref_id, "grp");
         if (!$parent_ref_id) {
             $parent_ref_id = $tree->checkForParentType($ref_id, "crs");
         }
         if ($parent_ref_id) {
             // get auto rate setting
             $parent_obj_id = ilObject::_lookupObjId($parent_ref_id);
             return (bool) ilContainer::_lookupContainerSetting(
                 $parent_obj_id,
                 ilObjectServiceSettingsGUI::AUTO_RATING_NEW_OBJECTS
             );
         }
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDeletedDates()

static ilObject::setDeletedDates	(	array	$ref_ids,
		int	$user_id
	)

static

Parameters

int[] $ref_ids

Definition at line 949 of file class.ilObject.php.

References $DIC, ilDBInterface\in(), ilDBInterface\manipulate(), ilDBInterface\now(), and ilDBInterface\quote().

Referenced by ilTree\moveToTrash().

                                                                         : void
     {
         global $DIC;
         $db = $DIC->database();
 
         $sql =
             "UPDATE object_reference" . PHP_EOL
             . "SET deleted = " . $db->now() . ", " . PHP_EOL
             . "deleted_by = " . $db->quote($user_id, "integer") . PHP_EOL
             . "WHERE " . $db->in("ref_id", $ref_ids, false, "integer") . PHP_EOL;
 
         $db->manipulate($sql);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDescription()

ilObject::setDescription ( string $description )

final

Definition at line 368 of file class.ilObject.php.

References getObjectProperties().

Referenced by ilObjStudyProgrammeSettingsGUI\buildForm(), ilObjBibliographic\cloneStructure(), ilObjEmployeeTalkSeriesGUI\copyTemplateValues(), shibUser\createFields(), ilObjTaxonomy\doCloneObject(), ilObjItemGroup\doCloneObject(), ilObjMediaObject\getExternalMetadata(), ilLTIConsumerSettingsFormGUI\initObject(), ilObjLanguage\install(), MDUpdateListener(), ilObjRoleFolder\read(), read(), ilObjLanguage\refresh(), ilObjLanguageExt\setLocal(), ilObjMediaObjectGUI\setObjectPerCreationForm(), ilObjIndividualAssessment\setSettings(), ilObjLanguage\uninstall(), shibUser\updateFields(), ilRemoteObjectBase\updateFromECSContent(), and ILIAS\Skill\Tree\SkillTreeManager\updateTree().

                                                              : void
     {
         $property = $this->getObjectProperties()
             ->getPropertyTitleAndDescription()->withDescription($description);
 
         $this->object_properties = $this->getObjectProperties()->withPropertyTitleAndDescription($property);
 
         // Shortened form is storted in object_data. Long form is stored in object_description
         $this->desc = $property->getDescription();
         $this->long_desc = $property->getLongDescription();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setId()

ilObject::setId ( int $id )

Definition at line 299 of file class.ilObject.php.

References $id.

Referenced by ilObjBibliographic\__construct(), ilObjUser\__construct(), and ilSessionReminder\byLoggedInUser().

                                   : void
     {
         $this->id = $id;
     }

Here is the caller graph for this function:

◆ setImportId()

ilObject::setImportId ( string $import_id )

final

Definition at line 400 of file class.ilObject.php.

References $import_id, and getObjectProperties().

                                                         : void
     {
         $this->object_properties = $this->getObjectProperties()->withImportId($import_id);
         $this->import_id = $import_id;
     }

Here is the call graph for this function:

◆ setOfflineStatus()

ilObject::setOfflineStatus ( bool $status )

Deprecated:: 11

Definition at line 434 of file class.ilObject.php.

References getObjectProperties().

Referenced by ilObjCourse\cloneObject(), ilObjCourse\cloneSettings(), ilObjForum\create(), ilObjSurvey\create(), ilObjContentPage\doCloneObject(), ilObjPoll\doCloneObject(), ilObjContentPage\doCreate(), ilTestImporter\importSkillLevelThresholds(), and ilLTIConsumerSettingsFormGUI\initObject().

                                                   : void
     {
         $property_is_online = $this->getObjectProperties()->getPropertyIsOnline()->withOnline();
         if ($status) {
             $property_is_online = $property_is_online->withOffline();
         }
 
         $this->object_properties = $this->getObjectProperties()->withPropertyIsOnline($property_is_online);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setOwner()

ilObject::setOwner ( int $usr_id )

final

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

Referenced by ilRemoteObjectBase\beforeCreate(), create(), and ilObjUser\setActive().

                                                : void
     {
         $this->owner = $usr_id;
     }

Here is the caller graph for this function:

◆ setParentRolePermissions()

ilObject::setParentRolePermissions ( int $parent_ref_id )

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.

Definition at line 1201 of file class.ilObject.php.

References getRefId(), getType(), and SYSTEM_ROLE_ID.

Referenced by setPermissions().

                                                                 : bool
     {
         $parent_roles = $this->rbac_review->getParentRoleIds($parent_ref_id);
         foreach ($parent_roles as $parent_role) {
             if ($parent_role['obj_id'] == SYSTEM_ROLE_ID) {
                 continue;
             }
             $operations = $this->rbac_review->getOperationsOfRole(
                 (int) $parent_role['obj_id'],
                 $this->getType(),
                 (int) $parent_role['parent']
             );
             $this->rbac_admin->grantPermission(
                 (int) $parent_role['obj_id'],
                 $operations,
                 $this->getRefId()
             );
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setPermissions()

ilObject::setPermissions ( int $parent_ref_id )

Definition at line 1190 of file class.ilObject.php.

References initDefaultRoles(), and setParentRolePermissions().

Referenced by ilSoapObjectAdministration\addReferences(), ilECSCourseCreationHandler\createCourseReference(), ilWebDAVObjFactory\createDAVObject(), ilRemoteObjectBase\createFromECSEContent(), ilObject2GUI\putObjectInTree(), and ilObjectGUI\putObjectInTree().

                                                       : void
     {
         $this->setParentRolePermissions($parent_ref_id);
         $this->initDefaultRoles();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setRefId()

ilObject::setRefId ( int $ref_id )

final

Definition at line 304 of file class.ilObject.php.

References $ref_id.

Referenced by ilMailSearchObjectGUI\cancel().

                                                : void
     {
         $this->ref_id = $ref_id;
         $this->referenced = true;
     }

Here is the caller graph for this function:

◆ setTitle()

ilObject::setTitle ( string $title )

final

Definition at line 349 of file class.ilObject.php.

References $title, getObjectProperties(), and ilStr\shortenTextExtended().

Referenced by ilObjEmployeeTalkGUI\addChangeDateButtonsToToolbar(), ilObjCmiXapiGUI\afterSave(), ilContainerReferenceGUI\afterSave(), ilObjLTIConsumerGUI\afterSave(), ilObjFile\beforeUpdate(), ilObjStudyProgrammeSettingsGUI\buildForm(), ilObjBibliographic\cloneStructure(), shibUser\createFields(), ilObjTaxonomy\doCloneObject(), ilObjItemGroup\doCloneObject(), ilObjFile\doCloneObject(), ilObjMediaObject\getExternalMetadata(), ilObjFile\handleChangedObjectTitle(), ilLTIConsumerSettingsFormGUI\initObject(), MDUpdateListener(), ilObjRoleFolder\read(), ilObjLanguage\refresh(), ilObjMediaObjectGUI\setObjectPerCreationForm(), ilObjIndividualAssessment\setSettings(), ilObjLanguage\uninstall(), ilRemoteObjectBase\updateFromECSContent(), ilObjMediaCastGUI\updateMediaItem(), ilObjFile\updateObjectFromRevision(), and ILIAS\Skill\Tree\SkillTreeManager\updateTree().

                                                  : void
     {
         $property = $this->getObjectProperties()->getPropertyTitleAndDescription()->withTitle(
             ilStr::shortenTextExtended($title, $this->max_title ?? self::TITLE_LENGTH, $this->add_dots)
         );
 
         $this->object_properties = $this->getObjectProperties()->withPropertyTitleAndDescription($property);
 
         $this->title = $property->getTitle();
 
         // WebDAV needs to access the untranslated title of an object
         $this->untranslatedTitle = $this->title;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setType()

ilObject::setType ( string $type )

final

Definition at line 320 of file class.ilObject.php.

References $type.

Referenced by ilObjTalkTemplate\__construct(), ilObjEmployeeTalkSeries\__construct(), ilObjEmployeeTalk\__construct(), and ilObjBibliographic\cloneStructure().

                                                : void
     {
         $this->type = $type;
     }

Here is the caller graph for this function:

◆ supportsOfflineHandling()

ilObject::supportsOfflineHandling ( )

Definition at line 449 of file class.ilObject.php.

References getType().

Referenced by _prepareCloneSelection(), and create().

                                              : bool
     {
         return $this->obj_definition->supportsOfflineHandling($this->getType());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

ilObject::update ( )

Definition at line 624 of file class.ilObject.php.

References getId(), getObjectProperties(), getRefId(), and getType().

Referenced by ilContainerReferenceGUI\afterSave(), ilObjBookingPoolGUI\afterSave(), ilObjWikiGUI\afterSave(), ilObjGroupGUI\afterSave(), ilObjLTIConsumerGUI\afterSave(), ilObjContentObjectGUI\afterSave(), ilObjCourseGUI\afterSave(), ilObjCourse\cloneSettings(), ilObjFileBasedLM\create(), ilObjSurvey\create(), handleAutoRating(), ilObjLanguage\install(), ilObjUserGUI\loadUserDefinedDataFromForm(), MDUpdateListener(), ilObjStudyProgrammeReferenceGUI\putObjectInTree(), ilObjEmployeeTalk\read(), ilObjLanguage\refresh(), ilObjLanguageExt\setLocal(), ilObjLanguage\uninstall(), and ILIAS\Skill\Tree\SkillTreeManager\updateTree().

                             : bool
     {
         $this->getObjectProperties()->storeCoreProperties();
 
         $this->app_event_handler->raise(
             'components/ILIAS/ILIASObject',
             'update',
             [
                 'obj_id' => $this->getId(),
                 'obj_type' => $this->getType(),
                 'ref_id' => $this->getRefId()
             ]
         );
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateMetaData()

ilObject::updateMetaData ( )

final

Definition at line 715 of file class.ilObject.php.

References beforeUpdateMetaData(), doUpdateMetaData(), getDescription(), getId(), getLongDescription(), getTitle(), and getType().

Referenced by ilObjFile\beforeUpdate(), ilObjDataCollection\doUpdate(), ilObjBlog\doUpdate(), ilObjContentPage\doUpdate(), ilObjFileBasedLM\update(), ilObjLinkResource\update(), ilObjSurveyQuestionPool\update(), ilObjQuestionPool\update(), ilObjMediaPool\update(), ilObjIndividualAssessment\update(), ilObjContentObject\update(), ilObjSurvey\update(), ilObjTest\update(), ilObjMediaCast\update(), ilObjGlossary\update(), ilObjMediaObject\update(), ilObjExercise\update(), ilObjSession\update(), ilObjGroup\update(), ilObjSAHSLearningModule\update(), and ilObjCourse\update().

                                           : void
     {
         if ($this->beforeUpdateMetaData()) {
             $paths = $this->lom_services->paths();
 
             $manipulator = $this->lom_services->manipulate($this->getId(), 0, $this->getType())
                 ->prepareCreateOrUpdate($paths->title(), $this->getTitle());
 
             if ($this->getDescription() !== '') {
                 $manipulator = $manipulator->prepareCreateOrUpdate(
                     $paths->firstDescription(),
                     $this->getLongDescription()
                 );
             } else {
                 $manipulator = $manipulator->prepareDelete($paths->firstDescription());
             }
 
             $manipulator->execute();
             $this->doUpdateMetaData();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateOwner()

ilObject::updateOwner ( )

final

update owner of object in db

Definition at line 766 of file class.ilObject.php.

References getId(), getOwner(), and read().

Referenced by ilObjUser\update().

                                        : void
     {
         $values = [
             "owner" => ["integer", $this->getOwner()],
             "last_update" => ["date", $this->db->now()]
         ];
 
         $where = [
             "obj_id" => ["integer", $this->getId()]
         ];
 
         $this->db->update(self::TABLE_OBJECT_DATA, $values, $where);
 
         // get current values from database so last_update is updated as well
         $this->read();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withReferences()

ilObject::withReferences ( )

final

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

Definition at line 158 of file class.ilObject.php.

Referenced by ilObjectMetaDataGUI\__construct(), and ilObjFolder\putInTree().

                                           : bool
     {
         // both vars could differ. this method should always return true if one of them is true without changing their status
         return ($this->call_by_reference) ? true : $this->referenced;
     }

Here is the caller graph for this function:

Field Documentation

◆ $add_dots

bool ilObject::$add_dots = true

protected

Definition at line 59 of file class.ilObject.php.

◆ $app_event_handler

ilAppEventHandler ilObject::$app_event_handler

protected

Definition at line 48 of file class.ilObject.php.

Referenced by ilObjMediaObject\create(), ilObjCategory\delete(), ilObjExercise\delete(), ilObjMediaObject\update(), and ilObjUser\update().

◆ $call_by_reference

bool ilObject::$call_by_reference

protected

Definition at line 56 of file class.ilObject.php.

Referenced by ilObjLearningSequenceAdmin\__construct(), ilObjStudyProgrammeReference\__construct(), ilObjAdministrativeNotification\__construct(), ilObjTypeDefinition\__construct(), ilObjWebDAV\__construct(), ilObjObjectFolder\__construct(), ilObjStudyProgrammeAdmin\__construct(), ilObjFileServices\__construct(), ilObjMainMenu\__construct(), ilObjIndividualAssessment\__construct(), ilObjLearningSequence\__construct(), and ilObjStudyProgramme\__construct().

◆ $create_date

string ilObject::$create_date = ""

protected

Definition at line 66 of file class.ilObject.php.

Referenced by getCreateDate().

◆ $db

ilDBInterface ilObject::$db

protected

Definition at line 44 of file class.ilObject.php.

◆ $desc

string ilObject::$desc = ""

protected

Definition at line 63 of file class.ilObject.php.

Referenced by ilObjLanguage\__construct(), _writeDescription(), getDescription(), getLongDescription(), and ilRemoteObjectBase\sendNewContentNotification().

◆ $error

ilErrorHandling ilObject::$error

protected

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

Referenced by ilObjContentObject\createExportDirectory(), ilObjContentObject\createImportDirectory(), ilObjSurvey\importObject(), ilObjSCORM2004LearningModule\readObject(), ilObjSession\validate(), ilObjCourse\validateInfoSettings(), and ilObjContentObject\validatePages().

◆ $ilias

ILIAS ilObject::$ilias

protected

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

Referenced by ilObjTest\_createImportDirectory().

◆ $import_id

string ilObject::$import_id = ""

protected

Definition at line 68 of file class.ilObject.php.

Referenced by _writeImportId(), getImportId(), and setImportId().

◆ $last_update

string ilObject::$last_update = ""

protected

Definition at line 67 of file class.ilObject.php.

Referenced by _lookupLastUpdate(), ilObjUser\getLastUpdate(), and getLastUpdateDate().

◆ $lng

ilLanguage ilObject::$lng

protected

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

Referenced by ilObjLanguage\__construct(), ilObjSurvey\__construct(), ilObjLanguageExt\_deleteValues(), ilObjMediaObject\_determineWidthHeight(), ilObjQuestionPool\_getAvailableQuestionpools(), ilObjSurveyQuestionPool\_getQuestiontypes(), ilObjQuestionPool\_getQuestionTypes(), ilObjSurveyQuestionPool\_getQuestionTypeTranslations(), ilObjLanguageExt\_getRemarks(), ilObjSCORMLearningModule\_getStatusForUser(), ilObjRole\_getTranslation(), ilObjLanguageExt\_getValues(), ilObjLearningSequence\_goto(), ilObjUser\_lookupLanguage(), ilObjRole\_removeObjectId(), ilObjLanguageExt\_saveValues(), ilObjUserFolder\buildExportFile(), ilObjPortfolioBase\clonePagesAndSettings(), ilObjLanguage\countUsers(), ilContainer\create(), ilObjItemGroup\doCreate(), ilObjGlossary\getAdvMDSubItemTitle(), ilObjWiki\getAdvMDSubItemTitle(), ilObjSAHSLearningModule\getAffectiveLocalization(), ilObjSAHSLearningModule\getApiStudentName(), ilObjRepositorySettings\getDefaultNewItemGrouping(), ilObjGlossary\getDeletionDependencies(), ilObjRepositorySettings\getNewItemGroups(), ilObjQuestionPool\getQuestionTypeTranslations(), ilObjSurvey\getSurveyCodesForExport(), ilObjSurvey\getSurveySkippedValue(), ilContainer\getTileSizes(), ilObjMediaPool\getUsedFormats(), ilObjStyleSheet\ilClone(), ilObjSCORMLearningModule\importRaw(), ilObjectPlugin\langExitsById(), ilObjTaxonomy\loadLanguageModule(), ilObjSAHSLearningModule\populateByDirectoy(), ilObjSCORM2004LearningModule\readObject(), ilObjContentObject\removeAutoGlossary(), ilObjSurvey\send360ReminderToUser(), ilObjSurvey\sendAppraiseeCloseNotification(), ilObjSurvey\sendAppraiseeNotification(), ilObjSurvey\sendRaterNotification(), ilObjAdvancedEditing\setUsedHTMLTags(), ilObjStudyProgramme\statusToRepr(), ilObjExercise\update(), ilObjUser\updateLogin(), and ilObjMediaObject\uploadMultipleSubtitleFile().

◆ $log

ilLogger ilObject::$log

protected

Definition at line 45 of file class.ilObject.php.

Referenced by ilContainer\_exportContainerSettings(), ilObjUser\_getUsersOnline(), ilContainer\_writeContainerSetting(), ilContainer\cloneAllObject(), ilContainer\cloneDependencies(), ilObjSCORM2004LearningModule\convert_1_2_to_2004(), ilContainer\create(), ilObjSurvey\getSurveysWithTutorResults(), ilObjCmiXapi\log(), ilObjLTIConsumer\sendResponseError(), and ilContainer\update().

◆ $lom_services

LOMServices ilObject::$lom_services

protected

Definition at line 53 of file class.ilObject.php.

◆ $long_desc

string ilObject::$long_desc = ""

protected

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

Referenced by ilObjMediaCast\addMobToCast(), ilContainer\getCompleteDescriptions(), and getLongDescription().

◆ $max_desc

int ilObject::$max_desc = self::DESC_LENGTH

protected

Definition at line 58 of file class.ilObject.php.

◆ $max_title

int ilObject::$max_title = self::TITLE_LENGTH

protected

Definition at line 57 of file class.ilObject.php.

◆ $obj_definition

ilObjectDefinition ilObject::$obj_definition

protected

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

◆ $obj_log

ilLogger ilObject::$obj_log

protected

Definition at line 41 of file class.ilObject.php.

◆ $object_dic

ilObjectDIC ilObject::$object_dic

private

Definition at line 54 of file class.ilObject.php.

◆ $object_properties

ilObjectProperties ilObject::$object_properties = null

private

Definition at line 39 of file class.ilObject.php.

Referenced by getObjectProperties(), and ilObjTest\removeQuestionWithResults().

◆ $objectList

array ilObject::$objectList

Definition at line 77 of file class.ilObject.php.

◆ $owner

int ilObject::$owner = 0

protected

Definition at line 65 of file class.ilObject.php.

Referenced by ilObjSurvey\_addQuestionblock(), create(), and getOwner().

◆ $process_auto_reating

bool ilObject::$process_auto_reating = false

private

Definition at line 71 of file class.ilObject.php.

◆ $rbac_admin

ilRbacAdmin ilObject::$rbac_admin

protected

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

◆ $rbac_review

ilRbacReview ilObject::$rbac_review

protected

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

◆ $ref_id

int ilObject::$ref_id = null

protected

Definition at line 60 of file class.ilObject.php.

Referenced by ilOrgUnitExtension\__construct(), ilObjUser\_getAllUserData(), ilObjSurveyQuestionPool\_getAvailableQuestionpools(), ilObjQuestionPool\_getAvailableQuestionpools(), ilObjTest\_getAvailableTests(), ilObjStyleSheet\_getClonableContentStyles(), ilObjGroup\_getMembers(), ilObjUser\_getUsersForFolder(), ilObjUserTracking\_hasLearningProgressOtherUsers(), ilObjQuestionPool\_isWriteable(), _resetDeletedDate(), _setDeletedDate(), createReference(), ilObjForum\createSettings(), ilObjPortfolioTemplate\getAvailablePortfolioTemplates(), ilObjStudyProgramme\getCreatableSubObjects(), ilObjTest\getGroupData(), ilObjStudyProgramme\getInstanceByRefId(), ilObjSession\handleAutoFill(), ilRemoteObjectBase\handleDelete(), ilObjForum\lookupForumIdByRefId(), ilObjForum\lookupLastPostByRefId(), ilObjForum\lookupStatisticsByRefId(), ilObjForum\preloadForumIdsByRefIds(), ilContainerReference\read(), ilObjGlossary\removeOfflineGlossaries(), ilObjStudyProgramme\setProgressesCompletedFor(), and setRefId().

◆ $register

bool ilObject::$register = false

protected

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

◆ $title

string ilObject::$title = ""

protected

Definition at line 62 of file class.ilObject.php.

Referenced by ilObjLanguage\__construct(), ilObjSurvey\_addQuestionblock(), ilObjQuestionPool\_getAvailableQuestionpools(), _prepareCloneSelection(), _writeTitle(), ilObjSystemFolder\addHeaderTitleTranslation(), ilObjQuestionPool\appendCounterToQuestionTitleIfNecessary(), buildTitleWithoutCopySuffix(), ilObjBookingPool\cloneObject(), ilObjTest\copyQuestions(), ilObjTest\delete(), ilObjTest\deliverPDFfromFO(), ilObjTest\deliverPDFfromHTML(), ilObjLinkResource\doMDUpdateListener(), ilObjSurveyQuestionPool\duplicateQuestion(), ilObjUser\exportPersonalData(), ilObjPortfolio\getAvailablePortfolioLinksForUserIds(), ilObjCourse\getDefaultMemberRole(), ilObjRepositorySettings\getDefaultNewItemGrouping(), ilObjRepositorySettings\getNewItemGroups(), ilObjSession\getPresentationTitleAppointmentPeriod(), ilObjTest\getQuestionTitle(), getTitle(), ilObjSCORM2004LearningModule\getTrackingDataAgg(), ilObjSurvey\insertQuestionblock(), ilObjDataCollection\reorderTables(), setTitle(), and ilObjContentObject\validatePages().

◆ $tree

ilTree ilObject::$tree

protected

Definition at line 47 of file class.ilObject.php.

Referenced by ilObjItemGroup\__construct(), ilObjStudyProgramme\__construct(), ilObjGroup\__construct(), ilObjMediaPool\_getPoolTree(), ilObjStyleSheet\_getStandardStyles(), ilObjSCORMLearningModule\_getTrackingItems(), ilObjContentObject\checkStructure(), ilObjContentObject\checkTree(), ilObjMediaPool\createFolder(), ilObjUser\delete(), ilObjTaxonomy\doDelete(), ilObjCourse\findCoursesWithNotEnoughMembers(), ilObjGroup\findGroupsWithNotEnoughMembers(), ilObjContentObject\fixTree(), ilObjGlossary\getAllGlossaryIds(), ilContainer\getInitialSubitems(), ilObjSurvey\getNotificationTargetUserIds(), ilObjIndividualAssessment\getParentContainerIdByType(), ilObjTaxonomyAdministration\getPath(), ilObjStudyProgramme\getReferencesTo(), ilObjTaxonomyAdministration\getRepositoryTaxonomies(), ilObjTaxonomy\getSubTreeItems(), ilObjStudyProgramme\getTree(), ilObjFolder\getViewMode(), ilObjGroup\getViewMode(), ilObjWorkspaceFolder\gotItems(), ilObjContentObject\hasSuccessorPage(), ilObjFolder\putInTree(), selfOrParentWithRatingEnabled(), ilObjBlog\sendNotification(), ilObjStudyProgramme\setProgressesCompletedIfParentIsProgrammeInLPCompletedMode(), and ilObjGroup\translateViewMode().

◆ $type

string ilObject::$type = ""

protected

Definition at line 61 of file class.ilObject.php.

Referenced by ilCertificateVerificationObject\__construct(), ilObjSurveyQuestionPool\_getQuestiontypes(), ilObjRole\_getTranslation(), ilObjSAHSLearningModule\checkMasteryScoreValues(), ilObjLearningSequence\cloneIntroAndExtroContentPages(), ilObjRole\createPermissionIntersection(), ilObjStudyProgramme\enableAutomaticMembershipSource(), ilContainer\getCompleteDescriptions(), ilObjQuestionPool\getExportDirectory(), ilObjContentObject\getExportFiles(), ilObjBibliographic\getFileTypeAsString(), ilObjOrgUnit\getIconsCache(), ilObjRepositorySettings\getNewItemGroupSubItems(), ilOrgUnitExtension\getOrgUnitSubtree(), ilObjMediaObject\getParentObjectIdForUsage(), ilObjContentObject\getPublicExportFiles(), ilObjCmiXapi\getSatisfiedStatement(), ilContainer\getSubItems(), ilObjStyleSheet\getTemplateXML(), getType(), ilObjStudyProgramme\hasAdvancedMetadata(), hasAutoRating(), ilRemoteObjectBase\importMetadataFromJson(), ilObjGroup\lookupGroupStatusTemplateId(), ilObjBibliographic\parseFileToDatabase(), ilVerificationObject\saveProperties(), ilObjStudyProgramme\setProgressesCompletedFor(), ilContainerReference\setTitleType(), and setType().

◆ $untranslatedTitle

string ilObject::$untranslatedTitle

Definition at line 81 of file class.ilObject.php.

Referenced by getUntranslatedTitle().

◆ $user

ilObjUser ilObject::$user

protected

Definition at line 51 of file class.ilObject.php.

Referenced by ilObjUser\_getUsersOnline(), ilObjUser\_uploadPersonalPicture(), ilObjUser\copyProfilePicturesToDirectory(), ilObjSCORMLearningModule\deleteTrackingDataOfUsers(), ilObjDataCollection\doUpdate(), ilRemoteObjectBase\getFullRemoteLink(), ilObjCmiXapi\getStatementActor(), ilObjSession\handleAutoFill(), and ilObjTest\insertManualFeedback().

◆ DESC_LENGTH

const ilObject::DESC_LENGTH = 128

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

Referenced by ilObjSystemFolder\_getHeaderTitleDescription(), ilObjSystemFolder\delete(), ilTree\fetchNodeData(), ilAdminSubItemsTableGUI\fillRow(), ILIAS\UI\Component\Legacy\Content\ItemSetManager\getCompleteDescriptions(), ilContainer\getCompleteDescriptions(), and ilObjectPropertyTitleAndDescription\getDescription().

◆ LONG_DESC_LENGTH

const ilObject::LONG_DESC_LENGTH = 4000

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

Referenced by ilObjBibliographicGUI\initCreateForm(), ilObjectGUI\initEditForm(), ilContainerGUI\initEditForm(), and ilObjectPropertyTitleAndDescription\toForm().

◆ TABLE_OBJECT_DATA

const ilObject::TABLE_OBJECT_DATA = "object_data"

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

Referenced by ilObjectTest\testCreationDeletion().

◆ TITLE_LENGTH

const ilObject::TITLE_LENGTH = 255

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

components/ILIAS/ILIASObject/classes/class.ilObject.php

Public Member Functions

Static Public Member Functions

Data Fields

Protected Member Functions

Protected Attributes

Private Member Functions

Private Attributes

Detailed Description

Member Function Documentation

◆ _exists()

◆ _getAllReferences()

◆ _getIcon()

◆ _getIdForImportId()

◆ _getIdsForTitle()

◆ _getLastUpdateOfObjects()

◆ _getObjectsByType()

◆ _getObjectsDataForType()

◆ _getObjectTypeIdByTitle()

◆ _hasUntrashedReference()

◆ _isInTrash()

◆ _lookupCreationDate()

◆ _lookupDeletedDate()

◆ _lookupDescription()

◆ _lookupImportId()

◆ _lookupLastUpdate()

◆ _lookupObjectId()

◆ _lookupObjId()

◆ _lookupObjIdByImportId()

◆ _lookupOwner()

◆ _lookupOwnerName()

◆ _lookupTitle()

◆ _lookupType()

◆ _prepareCloneSelection()

◆ _resetDeletedDate()

◆ _setDeletedDate()

◆ _writeDescription()

◆ _writeImportId()

◆ _writeTitle()

◆ appendCopyInfo()

◆ appendCopyInfoToTranslations()

◆ appendNumberOfCopiesToTitle()

◆ applyDidacticTemplate()

◆ beforeCreateMetaData()

◆ beforeDeleteMetaData()

◆ beforeMDUpdateListener()

◆ beforeUpdateMetaData()

◆ buildTitleWithoutCopySuffix()

◆ cloneDependencies()

◆ cloneMetaData()

◆ collectDeletionDependencies()

◆ countReferences()

◆ create()

◆ createMetaData()

◆ createReference()

◆ delete()

◆ deleteMetaData()

◆ doCreateMetaData()

◆ doDeleteMetaData()

◆ doMDUpdateListener()

◆ doUpdateMetaData()

◆ fixMissingTitles()

◆ flushObjectProperties()

◆ getAllOwnedRepositoryObjects()

◆ getCallbackForTitlesPerLanguageTransformation()

◆ getCreateDate()

◆ getDeletionDependencies()

◆ getDescription()

◆ getHTMLDirectory()

◆ getIconForType()

◆ getId()

◆ getImportId()

◆ getLastUpdateDate()

◆ getLongDescription()

◆ getLongDescriptions()

◆ getObjectProperties()

◆ getOfflineStatus()

◆ getOwner()

◆ getOwnerName()

◆ getPossibleSubObjects()

◆ getPresentationTitle()