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

Inheritance diagram for ilObject:

Collaboration diagram for ilObject:

Public Member Functions
	__construct (int $id=0, bool $reference=true)

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

	processAutoRating ()

	read ()

	getId ()

	setId (int $id)

	setRefId (int $ref_id)

	getRefId ()

	getType ()

	setType (string $type)

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

	getTitle ()

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

	setTitle (string $title)

	getDescription ()

	setDescription (string $desc)

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

	getImportId ()

	setImportId (string $import_id)

	setOfflineStatus (bool $status)

	getOfflineStatus ()

	supportsOfflineHandling ()

	getOwner ()

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

	setOwner (int $usr_id)

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

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

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

	update ()

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

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

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

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

	setPermissions (int $parent_ref_id)

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

	createReference ()
	creates reference for object More...

	countReferences ()

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

	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type. More...

	applyDidacticTemplate (int $tpl_id)

	getXMLZip ()

	getHTMLDirectory ()

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

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

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

	selfOrParentWithRatingEnabled ()

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

Static Public Member Functions
static	_lookupObjIdByImportId (string $import_id)
	Get (latest) object id for an import id. More...

static	_lookupImportId (int $obj_id)

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

static	_getIdForImportId (string $import_id)

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

static	_lookupTitle (int $obj_id)

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

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

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

static	_lookupDescription (int $obj_id)

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

static	_getLastUpdateOfObjects (array $obj_ids)

static	_lookupObjId (int $ref_id)

static	_setDeletedDate (int $ref_id, int $deleted_by)

static	setDeletedDates (array $ref_ids, int $user_id)

static	_resetDeletedDate (int $ref_id)

static	_lookupDeletedDate (int $ref_id)

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

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

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

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

static	_isInTrash (int $ref_id)

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

static	_lookupObjectId (int $ref_id)

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

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

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

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

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

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

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

static	getLongDescriptions (array $obj_ids)

static	getAllOwnedRepositoryObjects (int $user_id)

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

static	_lookupCreationDate (int $obj_id)

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

Data Fields
const	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

int	$id

bool	$referenced

bool	$call_by_reference

int	$max_title = self::TITLE_LENGTH

int	$max_desc = self::DESC_LENGTH

bool	$add_dots = true

int	$ref_id = null

string	$type = ""

string	$title = ""

bool	$offline = false

string	$desc = ""

string	$long_desc = ""

int	$owner = 0

string	$create_date = ""

string	$last_update = ""

string	$import_id = ""

bool	$register = false

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
bool	$process_auto_reating = false

Detailed Description

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

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class 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 29 of file class.ilObject.php.

Constructor & Destructor Documentation

◆ __construct()

ilObject::__construct	(	int	$id = `0`,
		bool	$reference = `true`
	)

Parameters

int	$id	reference_id or object_id
bool	$reference	bool treat the id as reference_id (true) or object_id (false)

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

    {
        global $DIC;
 
        $this->ilias = $DIC["ilias"];
        $this->obj_definition = $DIC["objDefinition"];
        $this->db = $DIC["ilDB"];
        $this->log = $DIC["ilLog"];
        $this->obj_log = ilLoggerFactory::getLogger("obj");
        $this->error = $DIC["ilErr"];
        $this->tree = $DIC["tree"];
        $this->app_event_handler = $DIC["ilAppEventHandler"];
 
        $this->referenced = $reference;
        $this->call_by_reference = $reference;
 
        if (isset($DIC["lng"])) {
            $this->lng = $DIC["lng"];
        }
 
        if (isset($DIC["ilUser"])) {
            $this->user = $DIC["ilUser"];
        }
 
        if (isset($DIC["rbacadmin"])) {
            $this->rbac_admin = $DIC["rbacadmin"];
        }
 
        if (isset($DIC["rbacreview"])) {
            $this->rbac_review = $DIC["rbacreview"];
        }
 
        if ($id == 0) {
            $this->referenced = false;          // newly created objects are never referenced
        }                                                                       // they will get referenced if createReference() is called
 
        if ($this->referenced) {
            $this->ref_id = $id;
        } else {
            $this->id = $id;
        }
        // read object data
        if ($id != 0) {
            $this->read();
        }
    }

References $DIC, $id, error(), ilLoggerFactory\getLogger(), ILIAS\Repository\lng(), read(), and ILIAS\Repository\user().

Here is the call graph for this function:

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

Reimplemented in ilObjTalkTemplateAdministration, ilObjEmployeeTalk, ilObjEmployeeTalkSeries, ilObjOrgUnit, ilObjTalkTemplate, and ilObjMediaObject.

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

                                                                                          : 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);
    }

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

Referenced by ilBookingAssignObjectsTableGUI\__construct(), ilObjectFeedWriter\__construct(), ilBookingParticipant\__construct(), _lookupOwnerName(), ilPCFileList\afterPageUpdate(), ilPCMediaObject\afterPageUpdate(), ilSoapAdministration\checkObjectAccess(), ilPersonalSettingsGUI\checkPersonalStartingPoint(), ilPageObject\collectMediaObjects(), ilExAssTypeWikiTeamGUI\createWiki(), ilWikiPage\delete(), ilPageObject\delete(), ilNewsItem\delete(), ilDclBaseRecordModel\deleteFile(), ilObjSCORMLearningModuleGUI\deleteTrackingForUser(), ilPublicUserProfileGUI\deliverVCard(), ilForum\fetchPostNodeData(), ilLinksTableGUI\fillRow(), ilMediaCastTableGUI\fillRow(), ilWikiContributorsTableGUI\fillRow(), ilPageHistoryTableGUI\fillRow(), ilPDNewsTableGUI\fillRow(), ilSearchResult\filter(), ilCronFinishUnfinishedTestPasses\finishPassForUser(), ilStudyProgrammeExpandableProgressListGUI\getAccordionContentCoursesHTML(), ilObjStudyProgramme\getCompletedCourses(), getCourseReferencesInNode(), ilSoapCourseAdministration\getCoursesForUser(), ilPublicUserProfileGUI\getEmbeddable(), ilPersonalSkillsGUI\getEvalItem(), ilSoapGroupAdministration\getGroupsForUser(), ilGoogleMapGUI\getHtml(), ilOpenLayersMapGUI\getHtml(), ilDclFileuploadRecordRepresentation\getHTML(), ilExAssignment\getMemberListData(), ilGoogleMapGUI\getUserListHtml(), ilOpenLayersMapGUI\getUserListHtml(), ilAdvancedMDRecordParser\handlerBeginTag(), ilAdvancedMDFieldDefinitionInternalLink\importValueFromXML(), ilCalendarRemoteAccessHandler\initUser(), ilIndividualAssessmentSettingsStorageDB\loadInfoSettings(), ilIndividualAssessmentSettingsStorageDB\loadSettings(), ilWebDAVRepositoryHelper\objectWithRefIdExists(), ilSCORM2004TrackingItemsPerUserFilterGUI\parse(), ilSCORMTrackingItemsPerUserFilterGUI\parse(), ilDclFileuploadRecordFieldModel\parseExportValue(), ilDclFileuploadRecordRepresentation\parseFormInput(), ilDclMobRecordRepresentation\parseFormInput(), ilDclFileuploadRecordFieldModel\parseSortingValue(), ilDclFileuploadFieldRepresentation\passThroughFilter(), ilCronFinishUnfinishedTestPasses\processPasses(), ilNewsTimelineItemGUI\render(), ilExAssTypeWikiTeamGUI\renderOverviewContent(), 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().

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 816 of file class.ilObject.php.

                                                           : 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 = array();
        while ($row = $db->fetchAssoc($result)) {
            $ref[(int) $row["ref_id"]] = (int) $row["ref_id"];
        }
 
        return $ref;
    }

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

Referenced by ILIAS\Skill\Service\SkillService\__construct(), ilTimingsUser\__construct(), ilAdvancedMDRecordGUI\__construct(), ilCourseParticipants\__construct(), ilGroupParticipants\__construct(), ilObjectCustomUserFieldsGUI\__construct(), ilLearningSequenceParticipants\__construct(), ilParticipant\__construct(), ilLPListOfProgressGUI\__initDetails(), ilCourseObjectiveMaterials\__read(), ilCourseObjectiveQuestion\__read(), ilEventParticipants\__read(), ilStartUpGUI\_checkGoto(), ilObjGlossaryAccess\_checkGoto(), ilObjContentObjectAccess\_checkGoto(), ilObjWikiAccess\_checkGoto(), ilObjStyleSheet\_getClonableContentStyles(), ilLMObject\_getIdForImportId(), ilInternalLink\_getIdForImportId(), ilSessionParticipants\_getInstanceByObjId(), ilObjGroup\_getMembers(), ilLPStatusCollectionManual\_getStatusInfo(), ilLPStatusCollectionTLT\_getStatusInfo(), ilLPStatusEvent\_getStatusInfo(), ilObjForumGUI\_goto(), ilLMPageObjectGUI\_goto(), ilObjWikiGUI\_goto(), ilObjUserTracking\_hasLearningProgressOtherUsers(), _hasUntrashedReference(), ilContainerReferenceAccess\_isAccessible(), ilObjCourseAccess\_isActivated(), ilObjQuestionPool\_isWriteable(), ilObjTestSettingsGeneralGUI\addAvailabilityProperties(), ilCalendarScheduleFilterTimings\addCustomEvents(), ilLPXmlWriter\addLPInformation(), ilStudyProgrammeAppEventListener\addMemberToProgrammes(), ilCalendarCategoryGUI\addReferenceLinks(), ilRepositorySearchGUI\addRole(), ilECSCourseCreationHandler\addUrlEntry(), ilLMPage\afterUpdate(), ilSoapCourseAdministration\assignCourseMember(), ilUserImportParser\assignToRole(), ilPCParagraph\autoLinkGlossaries(), ilCalendarExport\buildAppointmentUrl(), ilOrgUnitImporter\buildRef(), ilObjBlogAccess\canBeDelivered(), ilObjPollAccess\canBeDelivered(), ilPortfolioAccessHandler\canBeDelivered(), ilBadgeWAC\canBeDelivered(), ilContainerAccess\canBeDelivered(), ilObjectAccess\canBeDelivered(), ilObjDataCollectionAccess\checkAccessForDataCollectionId(), ilObjDataCollectionAccess\checkActionForObjId(), ilSearchAutoComplete\checkObjectPermission(), ilMDCopyrightUsageTableGUI\collectData(), ilAppointmentPresentationCourseGUI\collectPropertiesAndActions(), ilAppointmentPresentationEmployeeTalkGUI\collectPropertiesAndActions(), ilAppointmentPresentationGroupGUI\collectPropertiesAndActions(), ilAppointmentPresentationSessionGUI\collectPropertiesAndActions(), ilLORandomTestQuestionPools\copy(), ilECSCourseCreationHandler\createCourseReference(), ilSoapCourseAdministration\deleteCourse(), ilContainerReferenceAppEventListener\deleteReferences(), ilUserImportParser\detachFromRole(), ilCalendarAppointmentGUI\distributeNotifications(), ilECSCourseCreationHandler\doAttributeMapping(), ilCourseAppEventListener\doAutoFill(), ilGroupAppEventListener\doAutoFill(), ilMailSearchObjectGUI\doesExposeMembers(), ilECSCourseCreationHandler\doSync(), ilECSEnrolmentStatusCommandQueueHandler\doUpdate(), ilConsultationHoursGUI\edit(), ilSoapCourseAdministration\excludeCourseMember(), ilMediaObjectUsagesTableGUI\fillRow(), ilSkillAssignedObjectsTableGUI\fillRow(), ilECSImportedContentTableGUI\fillRow(), ilLuceneSearchResultFilter\filter(), ilOerHarvester\filter(), ilSearchResult\filter(), ilContainerImporter\finalProcessing(), ilObjCourse\findCoursesWithNotEnoughMembers(), ilObjGroup\findGroupsWithNotEnoughMembers(), ilSoapUtils\findMappedReferenceForNode(), ilLPTableBaseGUI\findReferencesForObjId(), ilLPObjectStatisticsTableGUI\findReferencesForObjId(), ilSessionClassificationPathGUI\findSessionContainerForItem(), ilLPCronObjectStatistics\gatherCourseLPData(), ILIAS\Skill\Profile\SkillProfileCompletionManager\getActualMaxLevels(), ilChatroomTabGUIFactory\getAdminTabsForCommand(), ilMailAddressTypeHelperImpl\getAllRefIdsForObjId(), ilExerciseGSToolProvider\getAssignmentInfo(), ilBlogExercise\getAssignmentsOfBlog(), ilPortfolioExercise\getAssignmentsOfPortfolio(), ilForumAppEventListener\getCachedReferences(), ilCalendarSelectionBlockGUI\getCalendars(), ilAppointmentBaseFileHandler\getCatInfo(), ilTestRandomQuestionSetConfig\getCommaSeparatedSourceQuestionPoolLinks(), ilStudyProgrammeMembersTableGUI\getCompletionLink(), ilSoapCourseAdministration\getCoursesForUser(), ilTestQuestionsTableGUI\getEditLink(), ilPortfolioExerciseGUI\getExerciseInfo(), ilAppointmentCourseFileHandler\getFiles(), ilTestQuestionSetConfig\getFirstQuestionPoolRefIdByObjId(), ilForumDraftsDerivedTaskProvider\getFirstRefIdWithPermission(), ilTermUsagesTableGUI\getFirstWritableRefId(), ilMediaPoolPageUsagesTableGUI\getFirstWritableRefId(), ilSoapGroupAdministration\getGroupsForUser(), ilCalendarAppointmentPanelGUI\getHTML(), ilDidacticTemplateIconFactory\getIconPathForObject(), ilSoapSCORMAdministration\getIMSManifestXML(), ilExcRepoObjAssignmentInfo\getInfo(), ilContainerSortingSettings\getInheritedSettings(), assQuestion\getInstances(), ilMediaPoolPageUsagesTableGUI\getItems(), ilObjectBadgeTableGUI\getItems(), ilMediaObjectUsagesTableGUI\getItems(), ilObjectLP\getMembers(), ilLPStatusCollection\getMembers(), ilLPStatusEvent\getMembers(), ilOrgUnitType\getOrgUnits(), ilTestQuestionsTableGUI\getPreviewLink(), ilObjStudyProgramme\getProgrammesMonitoringCategory(), ilObjStudyProgramme\getProgrammesMonitoringMemberSource(), ilTestQuestionBrowserTableGUI\getQuestionParentObjIds(), ilTestQuestionSetConfig\getQuestionPoolPathString(), ilAppointmentPresentationGUI\getReadableRefIds(), ilObjStudyProgramme\getReferencesTo(), ilObjStudyProgramme\getRefIdFor(), ilPRGAssignmentDBRepository\getRefIdFor(), getRefIdFor(), ilSoapObjectAdministration\getRefIdsByImportId(), ilForumCronNotification\getRefIdsByObjId(), ilForumNotificationDataProvider\getRefIdsByObjId(), ilSoapObjectAdministration\getRefIdsByObjId(), ilLSEventHandler\getRefIdsOfObjId(), ilLSLPEventHandler\getRefIdsOfObjId(), ilObjTestDynamicQuestionSetConfig\getSourceQuestionPoolLink(), ilObjTestDynamicQuestionSetConfig\getSourceQuestionPoolRefIds(), ilTrQuery\getSubItemsStatusForUser(), ilNoteGUI\getTarget(), ilSoapTestAdministration\getTestResults(), ILIAS\Skill\Tree\SkillTreeManager\getTree(), ilGlossaryExporter\getXmlExportTailDependencies(), ilCategoryExporter\getXmlRepresentation(), ilCourseExporter\getXmlRepresentation(), ilGroupExporter\getXmlRepresentation(), ilContainerExporter\getXmlRepresentation(), ilContainerReferenceExporter\getXmlRepresentation(), ilObjSession\handleAutoFill(), ilRemoteObjectBase\handleDelete(), ilSkillAppEventListener\handleEvent(), ilTaggingAppEventListener\handleEvent(), ilTrackingAppEventListener\handleEvent(), ilCertificateAppEventListener\handleLPUpdate(), ilECSAppEventListener\handleMembership(), ilObjectLP\handleMove(), ilLTIAppEventListener\handleOutcomeWithoutLP(), ilCourseReferenceAppEventListener\handleReferences(), ilECSCmsTreeSynchronizer\handleTreeUpdate(), ilECSCategoryMapping\handleUpdate(), ilLTIAppEventListener\handleUpdateStatus(), ilOerHarvester\harvest(), ilParticipants\hasParticipantListAccess(), ilSoapTestAdministration\hasWritePermissionForTest(), ilSurveySyncTableGUI\importData(), ilObjectGUI\importFileObject(), ilObjTestXMLParser\importRandomQuestionSourcePoolDefinition(), ilSessionDataSet\importRecord(), ilCategoryImporter\importXmlRepresentation(), ilCourseImporter\importXmlRepresentation(), ilGroupImporter\importXmlRepresentation(), ilCourseReferencePathInfo\init(), ilLSLocalDI\init(), ilObjPollGUI\initEditCustomForm(), ilObjPortfolioTemplateGUI\initEditCustomForm(), ilContainerNewsSettingsGUI\initForm(), ilObjectOwnershipManagementTableGUI\initItems(), ilLPStatusCollection\isMember(), ilLOTestQuestionAdapter\isQualifiedStartRun(), ilAssQuestionSkillAssignmentsGUI\isSyncOriginalPossibleAndAllowed(), ilObjDataCollectionAccess\isTableInDataCollection(), ilBadgeProfileGUI\listBadges(), ilUserCertificateGUI\listCertificates(), ilRepositorySearchGUI\listUsers(), ilEmployeeTalkMyStaffListGUI\loadActionBar(), ilEmployeeTalkMyStaffUserGUI\loadActionBar(), ilStudyProgrammeUserTable\lookupTitle(), ilMailSearchObjectGUI\mailObjects(), ilCalendarScheduleFilterTimings\modifyEvent(), ilStudyProgrammeAppEventListener\onServiceTrackingUpdateStatus(), ilECSExportedContentTableGUI\parse(), ilCalendarManageTableGUI\parse(), ilConsultationHoursTableGUI\parse(), ilExAssignmentReminder\parseGradeReminders(), ilExAssignmentReminder\parsePeerReminders(), ilSearchResultPresentation\parseResultReferences(), ilSkillObjDeletionHandler\processDeletion(), ilContainerReference\read(), ilLPCollectionOfRepositoryObjects\read(), ilSkillDataSet\readData(), ilSessionDataSet\readDidacticTemplateType(), ilCalendarCategoryGUI\readPermissions(), ilCalendarCategories\readSelectedCategories(), ilSoapWebLinkAdministration\readWebLink(), ilSoapObjectAdministration\removeFromSystemByImportId(), ilStudyProgrammeAppEventListener\removeMemberFromProgrammes(), ilTaggingSlateContentGUI\removeTagsWithoutAccess(), ilLearningHistoryTimelineItem\render(), ilBadgeRenderer\renderModalContent(), ilTaggingSlateContentGUI\renderResourcesForTag(), ilObjStudyProgrammeAutoMembershipsGUI\save(), ilContainerNewsSettingsGUI\save(), ilSystemNotification\sendMailAndReturnRecipients(), ilMembershipCronMinMembers\sendMessage(), ilContainerGlobalProfiles\setMemberRoleId(), ilContainerLocalProfiles\setMemberRoleId(), ilObjectCopyCourseGroupSelectionTableGUI\setObjects(), ilEmployeeTalkTableGUI\setTalkData(), ilCalendarAppointmentGUI\showInfoScreen(), ilPageEditorGUI\showSnippetInfo(), ilECSCmsTreeSynchronizer\syncCategory(), SurveyQuestionGUI\syncCopies(), ilECSCourseCreationHandler\syncNodeToTop(), ILIAS\Data\ObjectId\toReferenceIds(), ilObjGroup\translateViewMode(), ilObjStudyProgrammeReferenceGUI\tryingToCreateCircularReference(), ilStudyProgrammeType\updateAssignedStudyProgrammesIcons(), ilECSCourseCreationHandler\updateCourseData(), ilECSCourseCreationHandler\updateParallelCourses(), ilECSCourseCreationHandler\updateParallelGroups(), ilObjectServiceSettingsGUI\updateServiceSettingsForm(), ilSoapWebLinkAdministration\updateWebLink(), and ilPDNotesGUI\view().

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 1906 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 790 of file class.ilObject.php.

                                                                     : 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;
    }

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

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

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 864 of file class.ilObject.php.

                                                                                                               : 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;
    }

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

Referenced by ilLTIProviderObjectSettingGUI\checkLocalRole(), ilTestEvaluationData\getParticipants(), ilRoleXmlImporter\importSimpleXml(), ilObjLTIAdministrationGUI\listConsumers(), and ilObjRoleGUI\mailToRoleObject().

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 913 of file class.ilObject.php.

                                                                        : 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"];
    }

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

Referenced by ilPageObject\getLastUpdateOfIncludedElements().

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 1478 of file class.ilObject.php.

                                                                                            : 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;
    }

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

Referenced by ILIAS\Skill\Service\SkillService\__construct(), ilLanguage\_getInstalledLanguages(), ilObjUserTracking\_hasLearningProgressOtherUsers(), ilChatroomServerConfigStoredObjective\achieve(), ilBadgeWAC\canBeDelivered(), ilChatroomMetricsCollectedObjective\collectFrom(), ilObjLanguageFolderGUI\confirmRefreshObject(), ilLPCronObjectStatistics\gatherCourseLPData(), ilChatroomTabGUIFactory\getAdminTabsForCommand(), ilObjLanguage\getInstalledLanguages(), ilObjLanguageFolder\getLanguages(), ilEmployeeTalkMyStaffListGUI\loadActionBar(), ilEmployeeTalkMyStaffUserGUI\loadActionBar(), ilAdvancedMDRecordLanguageTableGUI\readLanguages(), and ilObjLanguage\refreshAll().

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 1136 of file class.ilObject.php.

                                                                                               : 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 = array();
        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;
    }

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

Referenced by ilObjStyleSheet\_addMissingStyleClassesToAllStyles().

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 2150 of file class.ilObject.php.

                                                                                             : ?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;
    }

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

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

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 1111 of file class.ilObject.php.

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

References $ref_id, _getAllReferences(), and _isInTrash().

Referenced by ilSkillAssignedObjectsTableGUI\__construct(), ilLMObject\_getIdForImportId(), _getObjectsDataForType(), ilObjQuestionPool\_isWriteable(), ilOrgUnitImporter\buildRef(), ilMailSearchObjectGUI\doesExposeMembers(), ilChatroomAdminViewGUI\forcePublicRoom(), ilLuceneAdvancedSearchFields\getFields(), ilSoapObjectAdministration\getObjIdsByRefIds(), ILIAS\Notes\NotesManager\getRelatedObjectsOfUser(), ilObjSAHSLearningModule\getScormModulesForGlossary(), ilTaggingAppEventListener\handleEvent(), ilEmployeeTalkMyStaffListGUI\loadActionBar(), ilEmployeeTalkMyStaffUserGUI\loadActionBar(), ilEmployeeTalkTableGUI\setTalkData(), and ilOrgUnitSimpleImport\simpleImportElement().

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 1102 of file class.ilObject.php.

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

References $DIC, and $ref_id.

Referenced by _hasUntrashedReference(), ilSoapCourseAdministration\addCourse(), ilSoapExerciseAdministration\addExercise(), ilSoapFileAdministration\addFile(), ilSoapGroupAdministration\addGroup(), ilSoapRBACAdministration\addRole(), ilSoapRBACAdministration\addRoleFromTemplate(), ilOrgUnitImporter\buildRef(), ilSoapAdministration\checkObjectAccess(), ilSoapWebLinkAdministration\createWebLink(), ilSoapDataCollectionAdministration\exportDataCollectionContent(), ilStudyProgrammeMembersTableGUI\getCompletionLink(), ilSoapCourseAdministration\getCoursesForUser(), ilSoapGroupAdministration\getGroupsForUser(), ilSoapSCORMAdministration\getIMSManifestXML(), ilSoapObjectAdministration\getObjectByReference(), ilSoapRBACAdministration\getObjectTreeOperations(), ilOrgUnitType\getOrgUnits(), ilSoapObjectAdministration\getPathForRefId(), ilSoapTestAdministration\getTestResults(), ilCopyWizardSettingsXMLParser\handlerBeginTag(), ilSoapSCORMAdministration\hasSCORMCertificate(), ilStudyProgrammeUserTable\lookupTitle(), ilSoapObjectAdministration\moveObject(), ilSoapWebLinkAdministration\readWebLink(), ilCollectFilesJob\recurseFolder(), ilSoapTestAdministration\removeTestResults(), ilSoapWebLinkAdministration\updateWebLink(), and ilCheckSumOfFileSizesJob\validateAccess().

Here is the caller graph for this function:

◆ _lookupCreationDate()

static ilObject::_lookupCreationDate ( int $obj_id )

static

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

                                                           : 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"];
    }

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

Referenced by ilSearchResultTableGUI\fillRow(), ilSearchResult\filter(), ilObjHelpSettings\getHelpModules(), and ilSearchResultPresentation\renderItemList().

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 987 of file class.ilObject.php.

                                                                : ?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"];
    }

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

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

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 894 of file class.ilObject.php.

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

References $DIC.

Referenced by ilLPStatusEvent\_getStatusInfo(), ilDidacticTemplateLocalRoleAction\apply(), ilMDCopyrightUsageTableGUI\collectData(), ilECSSettingsGUI\exportImported(), ilECSSettingsGUI\exportReleased(), ilTaxonomyListTableGUI\fillRow(), ilObjectTranslation\getDefaultDescription(), ilFavouritesDBRepository\getFavouritesOfUser(), ilObjTest\getGroupData(), ilCourseGroupingAssignmentTableGUI\getItems(), ilObjCategoryGUI\getObjectMetadataGUI(), ilObjTest\getRoleData(), ilCourseObjectivesGUI\initFormLimits(), ilSearchResultPresentation\lookupDescription(), ilCalendarSharedListTableGUI\parse(), ilCalendarSharedRoleListTableGUI\parse(), ilObjectCopyProgressTableGUI\parse(), ilCourseObjectiveQuestionsTableGUI\parse(), ilRoleSelectionTableGUI\parse(), ilRepositoryObjectResultTableGUI\parseObjectIds(), ilDclRecordEditGUI\parseSearchResults(), ilObjectCopySearchResultTableGUI\parseSearchResults(), ilScorm2004DataSet\readData(), ilConditionHandlerTableGUI\setConditions(), ilObjTaxonomyGUI\setTabs(), and ilRoleXmlExport\writeRole().

Here is the caller graph for this function:

◆ _lookupImportId()

static ilObject::_lookupImportId ( int $obj_id )

static

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

                                                       : 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 '';
    }

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

Here is the call graph for this function:

◆ _lookupLastUpdate()

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

staticfinal

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

                                                                                        : 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;
    }

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

Here is the call graph for this function:

◆ _lookupObjectId()

static ilObject::_lookupObjectId ( int $ref_id )

staticfinal

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

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

References $DIC, and $ref_id.

Referenced by ilSCORM13PlayerGUI\__construct(), ilMailMemberSearchTableGUI\__construct(), ilDclTableListGUI\__construct(), ilWebDAVObjectMountInstructions\__construct(), ilGlossaryAdvMetaDataAdapter\__construct(), ilGlossaryTermGUI\__construct(), ilLOXmlWriter\__construct(), ilObject2GUI\__construct(), ilDclCreateViewDefinitionGUI\__construct(), ilDclDetailedViewDefinitionGUI\__construct(), ilDclEditViewDefinitionGUI\__construct(), ilObjForumGUI\_goto(), ilAppointmentPresentationGUI\addContainerInfo(), ilObjStudyProgramme\addCrsToProgrammes(), ilBookingGatewayGUI\checkBookingPoolsForSchedules(), ilLTIProviderObjectSettingGUI\checkLocalRole(), ilPollBlockGUI\commentJSCall(), ilRecommendedContentRoleConfigGUI\confirmRemoveItems(), ilPDSelectedItemsBlockGUI\confirmRemoveObject(), ilObjStudyProgrammeTreeGUI\createNewLeaf(), ilObjPortfolioGUI\createPortfolioFromAssignment(), ilExSubmissionObjectGUI\createPortfolioFromAssignmentObject(), ilObjStudyProgrammeTreeGUI\delete(), ilLPListOfProgressGUI\details(), ilSAHSPresentationGUI\executeCommand(), ilSAHSEditGUI\executeCommand(), ilObjSAHSLearningModuleGUI\exportModule(), ilMStListCoursesTableGUI\fillRow(), ilMStShowUserCoursesTableGUI\fillRow(), ilSkillProfileTableGUI\fillRow(), ilLPCollectionSettingsTableGUI\fillRow(), ILIAS\Skill\Profile\SkillProfileCompletionManager\getActualMaxLevels(), ilContainerPageGUI\getAdditionalPageActions(), ILIAS\Skill\Profile\SkillProfileRoleDBRepository\getAssignedRoles(), ilObjFileInfoRepository\getByRefId(), ilExAssTypeWikiTeam\getExportObjIdForResourceId(), ilOrgUnitExporter\getExternalId(), ilNewsForContextBlockGUI\getHTML(), ilSoapSCORMAdministration\getIMSManifestXML(), ilRecommendedContentRoleTableGUI\getItems(), ilBookingReservationsTableGUI\getItems(), ilPollBlockGUI\getNumberOfComments(), ilWebDAVRepositoryHelper\getObjectIdFromRefId(), ilPRGAssignmentDBRepository\getObjIdFor(), ilOrgUnitPositionAccess\getObjIdForRefId(), ilSoapObjectAdministration\getObjIdsByRefIds(), ilTrQuery\getParticipantsForObject(), ilLPCollectionOfLMChapters\getPossibleItems(), ilSoapSCORMAdministration\getSCORMCompletionStatus(), ilBookingReservationsTableGUI\getSelectableUserColumns(), ilDclIliasReferenceRecordFieldModel\getStatus(), ilObjEmployeeTalkSeriesGUI\getTemplateRefId(), ilGlossaryTerm\getTermList(), ilSoapTestAdministration\getTestAccess(), ilSoapTestAdministration\getTestResults(), ilBadgeHandler\getUserIds(), ilDclIliasReferenceRecordFieldModel\getValueForRepresentation(), ilMembershipRegistrationCodeUtils\handleCode(), ilTestExpressPageObjectGUI\handleToolbarCommand(), ilDclTable\hasPermissionToDeleteRecord(), ilDclTable\hasPermissionToDeleteRecords(), ilDclTable\hasPermissionToEditRecord(), ilDclTable\hasPermissionToViewRecord(), ilSoapSCORMAdministration\hasSCORMCertificate(), ilObjContentObjectGUI\initMenuEntryForm(), ilRepositoryExplorer\isClickable(), ilRepositoryExplorerGUI\isNodeClickable(), ilObjAssessmentFolderGUI\logAdminObject(), ilObjForum\lookupStatisticsByRefId(), ilObjSCORMLearningModuleGUI\newModuleVersion(), ilRbacLogTableGUI\parseChangesFaPa(), ilSoapWebLinkAdministration\readWebLink(), ilContainerGUI\redrawListItemObject(), ilObjGlossary\removeOfflineGlossaries(), ILIAS\Repository\Provider\RepositoryMainBarProvider\renderLastVisited(), ilNewsTimelineGUI\save(), ilSAHSPresentationGUI\setInfoTabs(), ILIAS\Data\ReferenceId\toObjectId(), ilNewsTimelineGUI\update(), and ilSoapWebLinkAdministration\updateWebLink().

Here is the caller graph for this function:

◆ _lookupObjId()

static ilObject::_lookupObjId ( int $ref_id )

staticfinal

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

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

References $DIC, and $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 371 of file class.ilObject.php.

                                                                          : 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;
    }

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

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

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 855 of file class.ilObject.php.

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

References $DIC.

Referenced by ilMDCopyrightUsageTableGUI\collectData(), ilPortfolioPageAction\deletePagesOfBlog(), ilPageObjectGUI\executeCommand(), ilLPTableBaseGUI\getExportMeta(), ilObjBlogGUI\getHTML(), ilPCLearningHistory\getPresentation(), ilNoteGUI\getTarget(), ilPortfolioPageGUI\makePlaceHoldersClickable(), ilPortfolioRepositoryGUI\setOffline(), ilPortfolioRepositoryGUI\setOnline(), and ilObjPortfolioGUI\setOnlineAndShare().

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 443 of file class.ilObject.php.

                                                                : 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;
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupTitle()

static ilObject::_lookupTitle ( int $obj_id )

static

Reimplemented in ilContainerReference.

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

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

References $DIC.

Here is the caller graph for this function:

◆ _lookupType()

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

staticfinal

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

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

References $DIC, and $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 1519 of file class.ilObject.php.

     : 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 ?: array();
    }

References $lng, and ilLanguage\txt().

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

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 970 of file class.ilObject.php.

                                                               : 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);
    }

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

Here is the call graph for this function:

◆ _setDeletedDate()

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

staticfinal

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

                                                                              : 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);
    }

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

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 1026 of file class.ilObject.php.

                                                                             : 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);
            }
        }
    }

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

Referenced by ilObjMediaObject\beforeMDUpdateListener(), and ilSCORM13Package\il_import().

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 1074 of file class.ilObject.php.

                                                                               : 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);
    }

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

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

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 1006 of file class.ilObject.php.

                                                                        : 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);
    }

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

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

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 1657 of file class.ilObject.php.

                                                                      : 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);
    }

References $target_id, ilCopyWizardOptions\_getInstance(), ILIAS\Survey\Mode\getId(), ilObjectTranslation\getInstance(), and ILIAS\Repository\lng().

Here is the call graph for this function:

◆ appendCopyInfoToTranslations()

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

private

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

     : string {
        $nodes_translations = array_map(
            fn (array $child): ilObjectTranslation =>
                ilObjectTranslation::getInstance((int) $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();
    }

◆ appendNumberOfCopiesToTitle()

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

private

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

     : 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;
            }
        }
    }

◆ applyDidacticTemplate()

ilObject::applyDidacticTemplate ( int $tpl_id )

Reimplemented in ilObjGroup.

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

                                                      : 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);
    }

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

Referenced by ilSessionDataSet\applyDidacticTemplate().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ beforeCreateMetaData()

ilObject::beforeCreateMetaData ( )

protected

Reimplemented in ilObjMediaObject.

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

                                             : bool
    {
        return true;
    }

Referenced by createMetaData().

Here is the caller graph for this function:

◆ beforeDeleteMetaData()

ilObject::beforeDeleteMetaData ( )

protected

Reimplemented in ilObjMediaObject.

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

                                             : bool
    {
        return true;
    }

Referenced by deleteMetaData().

Here is the caller graph for this function:

◆ beforeMDUpdateListener()

ilObject::beforeMDUpdateListener ( string $a_element )

protected

Reimplemented in ilObjMediaObject.

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

                                                                : bool
    {
        return true;
    }

Referenced by MDUpdateListener().

Here is the caller graph for this function:

◆ beforeUpdateMetaData()

ilObject::beforeUpdateMetaData ( )

protected

Reimplemented in ilObjQuestionPool, and ilObjMediaObject.

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

                                             : bool
    {
        return true;
    }

Referenced by updateMetaData().

Here is the caller graph for this function:

◆ buildTitleWithoutCopySuffix()

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

private

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

                                                                                                           : 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;
    }

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

Reimplemented in ilObjCourse, ilObjGroup, ilObjItemGroup, ilObjCategory, ilObjFolder, and ilContainer.

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

                                                                   : 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;
    }

References $factory, $target_id, ilConditionHandler\cloneDependencies(), and ilDidacticTemplateObjSettings\lookupTemplateId().

Here is the call graph for this function:

◆ cloneMetaData()

ilObject::cloneMetaData ( ilObject $target_obj )

Copy meta data.

Reimplemented in ilObject2.

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

                                                       : bool
    {
        $md = new ilMD($this->getId(), 0, $this->getType());
        $md->cloneMD($target_obj->getId(), 0, $target_obj->getType());
        return true;
    }

References ILIAS\Survey\Mode\getId(), getId(), and getType().

Here is the call 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 1960 of file class.ilObject.php.

     : void {
        global $DIC;
 
        $objDefinition = $DIC["objDefinition"];
        $tree = $DIC->repositoryTree();
 
        if ($depth == 0) {
            $deps["dep"] = array();
        }
 
        $deps["del_ids"][$obj_id] = $obj_id;
 
        if (!$objDefinition->isPluginTypeName($type)) {
            $class_name = "ilObj" . $objDefinition->getClassName($type);
            $odeps = call_user_func(array($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"];
        }
    }

◆ countReferences()

ilObject::countReferences ( )

final

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

                                           : 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;
    }

References $message, $res, and error().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ create()

ilObject::create ( )

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

Reimplemented in ilObjBookingPool, ilObjCourseReference, ilObjTalkTemplate, ilObjTalkTemplateAdministration, ilObjFileAccessSettings, ilObjForum, ilObjGroup, ilObjIndividualAssessment, ilObjLearningSequence, ilObjMediaCast, ilObjMediaPool, ilObjOrgUnit, ilObjStudyProgramme, ilObjTest, ilObjRole, shibUser, ilContainer, and ilObjWebDAV.

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

                            : 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()],
            "offline" => ["integer", $this->supportsOfflineHandling() ? $this->getOfflineStatus() : null]
        ];
 
        $this->db->insert(self::TABLE_OBJECT_DATA, $values);
 
 
        // 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->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
        //$this->read();
        $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(
            'Services/Object',
            'create',
            [
                'obj_id' => $this->id,
                'obj_type' => $this->type
            ]
        );
 
        return $this->id;
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createMetaData()

ilObject::createMetaData ( )

final

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

                                          : void
    {
        if ($this->beforeCreateMetaData()) {
            global $DIC;
            $ilUser = $DIC["ilUser"];
 
            $md_creator = new ilMDCreator($this->getId(), 0, $this->getType());
            $md_creator->setTitle($this->getTitle());
            $md_creator->setTitleLanguage($ilUser->getPref('language'));
            $md_creator->setDescription($this->getLongDescription());
            $md_creator->setDescriptionLanguage($ilUser->getPref('language'));
            $md_creator->setKeywordLanguage($ilUser->getPref('language'));
            // see https://docu.ilias.de/goto_docu_wiki_wpage_4891_1357.html
            //$md_creator->setLanguage($ilUser->getPref('language'));
            $md_creator->create();
            $this->doCreateMetaData();
        }
    }

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

Referenced by ilObjSurvey\create(), ilObjSurveyQuestionPool\create(), ilObjQuestionPool\create(), ilObjLinkResource\create(), ilObjGroup\create(), ilObjIndividualAssessment\create(), ilObjTest\create(), ilObjFileBasedLM\create(), ilObjSession\create(), ilObjGlossary\create(), ilObjSAHSLearningModule\create(), and updateMetaData().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createReference()

ilObject::createReference ( )

creates reference for object

Reimplemented in ilObjSurvey, and ilObjQuestionPool.

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

                                     : 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;
    }

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

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

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

Reimplemented in ilObjBookingPool, ilObjCategory, ilObjChatroom, ilObjCourse, ilObjCourseAdministration, ilObjCourseReference, ilObjTalkTemplate, ilObjTalkTemplateAdministration, ilObjExercise, ilObjExerciseAdministration, ilObjForum, ilObjGlossary, ilObjGroup, ilObjGroupAdministration, ilObjFileBasedLM, ilObjIndividualAssessment, ilObjLearningSequence, ilObjMediaCast, ilObjMediaPool, ilObjOrgUnit, ilObjRootFolder, ilObjSAHSLearningModule, ilObjSession, ilObjStudyProgramme, ilObjSurvey, ilObjSurveyQuestionPool, ilObjSystemFolder, ilObjTest, ilObjQuestionPool, ilObjLinkResource, ilObjWebResourceAdministration, ilObjWiki, ilObjRole, ilObjRoleFolder, ilObjRoleTemplate, ilObjComponentSettings, ilContainer, ilContainerReference, ilObjMediaObject, ilObjNotificationAdmin, ilObject2, ilObjObjectFolder, ilObjRepositorySettings, ilObjSkillManagement, ilObjStyleSheet, ilObjTaxonomyAdministration, ilObjUser, and ilObjUserFolder.

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

                            : 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('Services/Object', '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('Services/Object', '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;
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteMetaData()

ilObject::deleteMetaData ( )

final

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

                                          : void
    {
        if ($this->beforeDeleteMetaData()) {
            $md = new ilMD($this->getId(), 0, $this->getType());
            $md->deleteAll();
            $this->doDeleteMetaData();
        }
    }

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

Referenced by ilObjGroup\delete(), ilObjIndividualAssessment\delete(), ilObjSAHSLearningModule\delete(), ilObjSession\delete(), ilObjSurvey\delete(), ilObjTest\delete(), ilObjQuestionPool\delete(), ilObjLinkResource\delete(), ilObjCmiXapi\doDelete(), and ilObjFile\doDelete().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ doCreateMetaData()

ilObject::doCreateMetaData ( )

protected

Reimplemented in ilObjSurvey, and ilObjTest.

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

                                         : void
    {
    }

Referenced by createMetaData().

Here is the caller graph for this function:

◆ doDeleteMetaData()

ilObject::doDeleteMetaData ( )

protected

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

                                         : void
    {
    }

Referenced by deleteMetaData().

Here is the caller graph for this function:

◆ doMDUpdateListener()

ilObject::doMDUpdateListener ( string $a_element )

protected

Reimplemented in ilObjCourse, ilObjContentObject, and ilObjLinkResource.

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

                                                            : void
    {
    }

Referenced by MDUpdateListener().

Here is the caller graph for this function:

◆ doUpdateMetaData()

ilObject::doUpdateMetaData ( )

protected

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

                                         : void
    {
    }

Referenced by updateMetaData().

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 2075 of file class.ilObject.php.

    {
        global $DIC;
        $db = $DIC->database();
 
        if (!in_array($type, array("catr", "crsr", "sess", "grpr", "prgr"))) {
            return;
        }
 
        // any missing titles?
        $missing_obj_ids = array();
        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;
        }
    }

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

Referenced by ilObjectOwnershipManagementGUI\listObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllOwnedRepositoryObjects()

static ilObject::getAllOwnedRepositoryObjects ( int $user_id )

static

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

                                                                     : 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 = array();
        while ($row = $db->fetchAssoc($res)) {
            $all[$row["type"]][$row["obj_id"]] = $row["title"];
        }
 
        return $all;
    }

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

Referenced by ilObjectOwnershipManagementGUI\listObjects().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCallbackForTitlesPerLanguageTransformation()

ilObject::getCallbackForTitlesPerLanguageTransformation ( )

private

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

                                                                    : 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;
        };
    }

References $lang.

◆ getCreateDate()

ilObject::getCreateDate ( )

final

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

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

                                         : string
    {
        return $this->create_date;
    }

References $create_date.

Referenced by ilCmiXapiUser\getIdent(), and ilCmiXapiUser\getIdentAsId().

Here is the caller graph for this function:

◆ getDeletionDependencies()

static ilObject::getDeletionDependencies ( int $obj_id )

static

Get deletion dependencies.

Reimplemented in ilObjGlossary.

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

◆ getDescription()

ilObject::getDescription ( )

final

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

                                          : string
    {
        return $this->desc;
    }

References $desc.

Referenced by ilObjContentPageGUI\afterSave(), ilObjLTIConsumer\buildLaunchParameters(), ilObjLTIConsumer\buildLaunchParametersLTI13(), create(), ilObjTaxonomy\doCloneObject(), ilObjFile\doCreate(), ilObjFile\doUpdate(), ilStudyProgrammeExpandableProgressListGUI\getAccordionContentCoursesHTML(), ilObjCmiXapi\getStatementContextActivities(), ilObjCmiXapi\getStatementObject(), ilIndividualAssessmentSettingsStorageDB\loadSettings(), ilObjRoleGUI\readRoleProperties(), ilObjForum\saveData(), ilObjForum\update(), and update().

Here is the caller graph for this function:

◆ getHTMLDirectory()

ilObject::getHTMLDirectory ( )

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

                                      : bool
    {
        return false;
    }

◆ getId()

ilObject::getId ( )

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

                           : int
    {
        return $this->id;
    }

References $id.

Here is the caller graph for this function:

◆ getImportId()

ilObject::getImportId ( )

final

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

                                       : string
    {
        return $this->import_id;
    }

References $import_id.

Referenced by create(), and update().

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 479 of file class.ilObject.php.

                                             : string
    {
        return $this->last_update;
    }

References $last_update.

Referenced by ilPreview\create().

Here is the caller graph for this function:

◆ getLongDescription()

ilObject::getLongDescription ( )

get object long description (stored in object_description)

Reimplemented in ilObjOrgUnit, ilObjAdministrativeNotification, ilObjFileServices, ilObjLanguageExt, ilObjMainMenu, and ilObjWebDAV.

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

                                        : string
    {
        if (strlen($this->long_desc)) {
            return $this->long_desc;
        } elseif (strlen($this->desc)) {
            return $this->desc;
        }
        return "";
    }

References $desc, and $long_desc.

Referenced by ilObjLearningSequenceSettingsGUI\__construct(), ilObjectDataDeletionLog\add(), create(), createMetaData(), ilObjContentPage\doUpdate(), ilObjItemGroup\doUpdate(), ilObjExerciseGUI\getEditFormCustomValues(), ilSoapStructureObjectFactory\getInstanceForObject(), ilObjSession\prepareCalendarAppointments(), update(), and updateMetaData().

Here is the caller graph for this function:

◆ getLongDescriptions()

static ilObject::getLongDescriptions ( array $obj_ids )

static

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

                                                              : 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 = array();
        while ($row = $db->fetchAssoc($result)) {
            $all[$row["obj_id"]] = $row["description"];
        }
        return $all;
    }

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

Referenced by ilContainer\getCompleteDescriptions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getOfflineStatus()

ilObject::getOfflineStatus ( )

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

                                      : bool
    {
        return $this->offline;
    }

References $offline.

Referenced by create(), ilObjContentPage\doCloneObject(), ilObjTest\saveToDb(), and update().

Here is the caller graph for this function:

◆ getOwner()

ilObject::getOwner ( )

final

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

                                    : int
    {
        return $this->owner;
    }

References $owner.

Referenced by ilObjForum\cloneAutoGeneratedRoles(), create(), ILIAS\EmployeeTalk\Service\VEventFactory\getInstanceFromTalk(), getOwnerName(), ilObjForum\setPermissions(), and updateOwner().

Here is the caller graph for this function:

◆ getOwnerName()

ilObject::getOwnerName ( )

final

get full name of object owner

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

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

References _lookupOwnerName(), and 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 2145 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

Reimplemented in ilObjFile, ilObjSession, ilObjRole, ilObjRoleTemplate, ilObjAdministrativeNotification, ilContainerReference, ilObjFileServices, ilObjMainMenu, and ilObjWebDAV.

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

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

References getTitle().

Referenced by ilObjRoleGUI\readRoleProperties().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRefId()

ilObject::getRefId ( )

final

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

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

Here is the caller graph for this function:

◆ getTitle()

ilObject::getTitle ( )

Reimplemented in ilObjTalkTemplateAdministration, and ilObjOrgUnit.

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

                              : string
    {
        return $this->title;
    }

References $title.

Referenced by ilObjLearningSequenceSettingsGUI\__construct(), ilConditionHandlerGUI\__construct(), ilObjectDataDeletionLog\add(), ilObjLTIConsumerGUI\afterSave(), ilObjContentPageGUI\afterSave(), ilObjFileBasedLMGUI\afterSave(), ilObjFile\beforeUpdate(), ilObjQuestionPool\beforeUpdateMetaData(), ilObjLTIConsumer\buildLaunchParameters(), ilObjLTIConsumer\buildLaunchParametersLTI13(), create(), ilCalendarAppEventListener\createCategory(), ilWebDAVObjFactory\createDAVObject(), createMetaData(), ilObjSurvey\delete(), delete(), ilObjFile\doCloneObject(), ilObjTaxonomy\doCloneObject(), ilObjDataCollection\doCreate(), ilMailSearchObjectGUI\doesExposeMembers(), ilObjContentPage\doUpdate(), ilObjItemGroup\doUpdate(), ilObjMediaPoolGUI\executeCommand(), ilObjSCORMLearningModule\exportSelected(), ilStudyProgrammeExpandableProgressListGUI\getAccordionContentCoursesHTML(), ilObjRoleTemplate\getFilterOfInternalTemplate(), ilSoapStructureObjectFactory\getInstanceForObject(), ILIAS\EmployeeTalk\Service\VEventFactory\getInstanceFromTalk(), ilDashboardLearningSequenceGUI\getLsoItem(), ilObjSession\getPresentationTitle(), ilObjRoleTemplate\getPresentationTitle(), ilContainerReference\getPresentationTitle(), getPresentationTitle(), ilObjSession\getPresentationTitleAppointmentPeriod(), ilObjCmiXapi\getStatementContextActivities(), ilObjCmiXapi\getStatementObject(), ilObjTest\getTitleFilenameCompliant(), ilStudyProgrammeIndividualPlanProgressListGUI\getTitleForItem(), ilStudyProgrammeProgressListGUI\getTitleForItem(), ilObjQuestionPoolGUI\importVerifiedFileObject(), ilObjLTIConsumerGUI\initMetadata(), ilObjCmiXapiGUI\initMetadata(), ilObjFile\isHidden(), ilObjRoleTemplate\isInternalTemplate(), ilIndividualAssessmentSettingsStorageDB\loadSettings(), ilObjSession\prepareCalendarAppointments(), putInTree(), ilObjForum\saveData(), ilObjForum\update(), update(), ilCalendarAppEventListener\updateCategory(), updateMetaData(), and ilObjGroup\validate().

Here is the caller graph for this function:

◆ getType()

ilObject::getType ( )

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

                             : string
    {
        return $this->type;
    }

References $type.

Referenced by ilObjectMetaDataGUI\__construct(), ilConditionHandlerGUI\__construct(), ilObjCourseGrouping\_checkGroupingDependencies(), ilObjCourseGrouping\_getGroupingItems(), ilObjectDataDeletionLog\add(), ilObjLTIConsumerGUI\afterSave(), ilObjCmiXapiGUI\afterSave(), ilObjectXMLWriter\appendObjectProperties(), ilObjQuestionPool\beforeUpdateMetaData(), ilObjTest\cleanupMediaobjectUsage(), cloneMetaData(), ilObjQuestionPool\cloneObject(), ilObjSurveyQuestionPool\cloneObject(), ilObjMediaCast\copyItems(), ilObjEmployeeTalkSeriesGUI\copyTemplateValues(), create(), ilCertificatePathFactory\create(), ilCertificateGUIFactory\create(), ilCalendarAppEventListener\createCategory(), ilWebDAVObjFactory\createDAVObject(), createMetaData(), ilPreview\createPreview(), ilObjForum\delete(), delete(), deleteMetaData(), ilObjContentPage\doCloneObject(), ilObjContentPage\doDelete(), ilObjLinkResource\doMDUpdateListener(), ilTestRandomQuestionSetPoolDeriver\duplicateTaxonomies(), ilObjQuestionPool\exportXMLMetaData(), ilObjectXMLWriter\getAccessInfo(), ilObjQuestionPool\getExportDirectory(), ILIAS\Survey\InfoScreen\InfoScreenGUI\getInfoScreenGUI(), ilECSObjectSettings\getInstanceByObject(), ilSoapStructureObjectFactory\getInstanceForObject(), ILIAS\EmployeeTalk\Service\VEventFactory\getInstanceFromTalk(), ILIAS\EmployeeTalk\Service\VCalendarFactory\getInstanceFromTalks(), ilObjCmiXapi\getLaunchData(), ilObjContentPage\getPageObjIds(), ilObjForum\getPageObjIds(), ilObjectPermissionStatusGUI\getUser(), ilKioskModeService\getViewFor(), ilRemoteObjectBase\importMetadataFromJson(), ilObjLTIConsumerGUI\initMetadata(), ilObjCmiXapiGUI\initMetadata(), MDUpdateListener(), putInTree(), ilObjMediaCast\readItems(), ilObjPortfolioBaseGUI\renderFullscreenHeader(), setParentRolePermissions(), supportsOfflineHandling(), ilObjContentPage\trackProgress(), update(), ilPortfolioPage\updateInternalLinks(), and updateMetaData().

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 320 of file class.ilObject.php.

                                                : string
    {
        return $this->untranslatedTitle;
    }

References $untranslatedTitle.

Referenced by ilObjRoleTemplate\getPresentationTitle().

Here is the caller graph for this function:

◆ getXMLZip()

ilObject::getXMLZip ( )

Reimplemented in ilObjGlossary, and ilObjTest.

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

                               : string
    {
        return "";
    }

◆ handleAutoRating()

ilObject::handleAutoRating ( )

protected

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

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

Referenced by putInTree().

Here is the caller graph for this function:

◆ hasAutoRating()

ilObject::hasAutoRating ( )

protected

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

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

References $ref_id, and $type.

◆ 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).

Reimplemented in ilObjBlog, ilObjChatroom, ilObjCourse, ilObjForum, ilObjGroup, ilObjIndividualAssessment, ilObjLearningSequence, and ilObjSession.

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

                                      : void
    {
    }

Referenced by setPermissions().

Here is the caller graph for this function:

◆ isTitleUnique()

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

private

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

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

◆ lookupOfflineStatus()

static ilObject::lookupOfflineStatus ( int $obj_id )

static

Lookup offline status using objectDataCache.

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

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

References $DIC.

Referenced by ilObjContentObjectAccess\_checkAccess(), ilObjTestAccess\_isOffline(), ilObjectAccess\_isOffline(), LSItemOnlineStatus\getOnlineStatus(), ilObjContentPageListGUI\getProperties(), ilObjCourseListGUI\getProperties(), ilObjForumListGUI\getProperties(), ilObjSurveyListGUI\getProperties(), ilObjectListGUI\getProperties(), ilObjEmployeeTalkSeriesGUI\getTemplateRefId(), ilCourseObjectivesTableGUI\parse(), and ilContainerXmlWriter\writeSubitems().

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 649 of file class.ilObject.php.

                                                           : void
    {
        if ($this->beforeMDUpdateListener($element)) {
            $this->app_event_handler->raise(
                'Services/Object',
                'update',
                array('obj_id' => $this->getId(),
                      'obj_type' => $this->getType(),
                      'ref_id' => $this->getRefId()
                )
            );
 
            // Update Title and description
            if ($element == 'General') {
                $md = new ilMD($this->getId(), 0, $this->getType());
                if (!is_object($md_gen = $md->getGeneral())) {
                    return;
                }
                $this->setTitle($md_gen->getTitle());
 
                foreach ($md_gen->getDescriptionIds() as $id) {
                    $md_des = $md_gen->getDescription($id);
                    $this->setDescription($md_des->getDescription());
                    break;
                }
                $this->update();
            }
            $this->doMDUpdateListener($element);
        }
    }

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

Here is the call graph for this function:

◆ processAutoRating()

ilObject::processAutoRating ( )

Deprecated:: : This function will be removed asap.

Definition at line 144 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

Reimplemented in ilObjStudyProgrammeReference, ilObjFolder, ilObjStudyProgramme, and ilContainer.

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

                                                 : 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(
            'Services/Object',
            'putObjectInTree',
            [
                'object' => $this,
                'obj_type' => $this->getType(),
                'obj_id' => $this->getId(),
                'parent_ref_id' => $parent_ref_id
            ]
        );
    }

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

Referenced by ilWebDAVObjFactory\createDAVObject(), ilRemoteObjectBase\createFromECSEContent(), ilOerHarvester\harvestObject(), ilObject2GUI\putObjectInTree(), and ilObjectGUI\putObjectInTree().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilObject::read ( )

Reimplemented in ilObjBookingPool, ilObjChatroom, ilObjCourse, ilObjCourseReference, ilObjTalkTemplate, ilObjTalkTemplateAdministration, ilObjEmployeeTalk, ilObjEmployeeTalkSeries, ilObjExercise, ilObjFileAccessSettings, ilObjFolder, ilObjGlossary, ilObjGroup, ilObjFileBasedLM, ilObjIndividualAssessment, ilObjContentObject, ilObjLearningSequence, ilObjMediaCast, ilObjMediaPool, ilObjSAHSLearningModule, ilObjSession, ilObjSurvey, ilObjSurveyQuestionPool, ilObjTest, ilObjWiki, ilObjRole, ilObjRoleFolder, ilObjComponentSettings, ilContainer, ilContainerReference, ilObjMediaObject, ilObject2, ilObjSkillManagement, ilObjStyleSheet, ilObjUser, and ilObjWebDAV.

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

                          : 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, od.offline, 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"];
 
        $this->setOfflineStatus((bool) $obj['offline']);
 
        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);
            }
        }
    }

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

Referenced by __construct(), and updateOwner().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ selfOrParentWithRatingEnabled()

ilObject::selfOrParentWithRatingEnabled ( )

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

                                                   : 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;
    }

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

Here is the call graph for this function:

◆ setDeletedDates()

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

static

Parameters

int[] $ref_ids

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

                                                                        : 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);
    }

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

Referenced by ilTree\moveToTrash().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDescription()

ilObject::setDescription ( string $desc )

final

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

                                                      : void
    {
        // Shortened form is storted in object_data. Long form is stored in object_description
        $this->desc = ilStr::shortenTextExtended($desc, $this->max_desc, $this->add_dots);
        $this->long_desc = ilStr::shortenTextExtended($desc, ilObject::LONG_DESC_LENGTH);
    }

References $desc, LONG_DESC_LENGTH, and ilStr\shortenTextExtended().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setId()

ilObject::setId ( int $id )

Reimplemented in ilObjExercise.

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

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

References $id.

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

Here is the caller graph for this function:

◆ setImportId()

ilObject::setImportId ( string $import_id )

final

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

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

References $import_id.

◆ setOfflineStatus()

ilObject::setOfflineStatus ( bool $status )

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

                                                  : void
    {
        $this->offline = $status;
    }

Referenced by ilObjFileBasedLM\__construct(), ilObjCourse\cloneSettings(), ilObjSurvey\create(), ilObjTalkTemplate\create(), ilObjForum\create(), ilObjTest\create(), ilObjPoll\doCloneObject(), ilObjContentPage\doCloneObject(), ilObjContentPage\doCreate(), ilTestImporter\importSkillLevelThresholds(), ilLTIConsumerSettingsFormGUI\initObject(), and read().

Here is the caller graph for this function:

◆ setOwner()

ilObject::setOwner ( int $usr_id )

final

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

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

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

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.

Reimplemented in ilObjCourse, and ilObjGroup.

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

                                                                : 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;
    }

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

Referenced by setPermissions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setPermissions()

ilObject::setPermissions ( int $parent_ref_id )

Reimplemented in ilObjForum.

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

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

References initDefaultRoles(), and setParentRolePermissions().

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

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 280 of file class.ilObject.php.

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

References $ref_id.

Referenced by ilMailSearchObjectGUI\doesExposeMembers().

Here is the caller graph for this function:

◆ setTitle()

ilObject::setTitle ( string $title )

final

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

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

References $title, and ilStr\shortenTextExtended().

Referenced by ilObjLTIConsumerGUI\afterSave(), ilObjWikiGUI\afterSave(), ilContainerReferenceGUI\afterSave(), ilObjCmiXapiGUI\afterSave(), ilObjFile\beforeUpdate(), ilObjStudyProgrammeSettingsGUI\buildForm(), ilObjBibliographic\cloneStructure(), shibUser\createFields(), ilTestRandomQuestionSetPoolDeriver\createNewPool(), ilObjFile\doCloneObject(), ilObjItemGroup\doCloneObject(), ilObjTaxonomy\doCloneObject(), ilObjFile\handleChangedObjectTitle(), ilLTIConsumerSettingsFormGUI\initObject(), ilObjRoleGUI\loadRoleProperties(), MDUpdateListener(), ilObjRoleFolder\read(), ilObjLanguage\refresh(), ilObjIndividualAssessment\setSettings(), ilObjLanguage\uninstall(), ilObjMediaCastGUI\updateCastItemObject(), shibUser\updateFields(), ilRemoteObjectBase\updateFromECSContent(), ilObjFile\updateObjectFromRevision(), and ILIAS\Skill\Tree\SkillTreeManager\updateTree().

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 296 of file class.ilObject.php.

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

References $type.

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

Here is the caller graph for this function:

◆ supportsOfflineHandling()

ilObject::supportsOfflineHandling ( )

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

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

References getType().

Referenced by create(), and update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ update()

ilObject::update ( )

Reimplemented in ilObjBookingPool, ilObjChatroom, ilObjCourse, ilObjCourseReference, ilObjTalkTemplate, ilObjTalkTemplateAdministration, ilObjExercise, ilObjFileAccessSettings, ilObjForum, ilObjGlossary, ilObjGroup, ilObjIndividualAssessment, ilObjContentObject, ilObjLearningSequence, ilObjMediaCast, ilObjMediaPool, ilObjOrgUnit, ilObjSAHSLearningModule, ilObjStudyProgramme, ilObjSurveyQuestionPool, ilObjTest, ilObjQuestionPool, ilObjLinkResource, ilObjRole, ilObjComponentSettings, ilContainer, ilContainerReference, ilObject2, ilObjSearchSettings, ilObjSkillManagement, ilObjStyleSheet, ilObjUser, and ilObjWebDAV.

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

                            : bool
    {
        $values = [
            "title" => ["text", $this->getTitle()],
            "description" => ["text", ilStr::subStr($this->getDescription(), 0, 128)],
            "last_update" => ["date", $this->db->now()],
            "import_id" => ["text", $this->getImportId()],
            "offline" => ["integer", $this->supportsOfflineHandling() ? $this->getOfflineStatus() : null]
        ];
 
        $where = [
            "obj_id" => ["integer", $this->getId()]
        ];
 
        $this->db->update(self::TABLE_OBJECT_DATA, $values, $where);
 
        // the line ($this->read();) messes up meta data handling: metadata,
        // that is not saved at this time, gets lost, so we query for the dates alone
        //$this->read();
        $sql =
            "SELECT last_update" . PHP_EOL
            . "FROM " . self::TABLE_OBJECT_DATA . PHP_EOL
            . "WHERE obj_id = " . $this->db->quote($this->getId(), "integer") . PHP_EOL
        ;
        $obj_set = $this->db->query($sql);
        $obj_rec = $this->db->fetchAssoc($obj_set);
        $this->last_update = $obj_rec["last_update"];
 
        if ($this->obj_definition->isRBACObject($this->getType())) {
            // Update long description
            $sql =
                "SELECT obj_id, description" . PHP_EOL
                . "FROM object_description" . PHP_EOL
                . "WHERE obj_id = " . $this->db->quote($this->getId(), 'integer') . PHP_EOL
            ;
            $res = $this->db->query($sql);
 
            if ($res->numRows()) {
                $values = [
                    'description' => ['clob',$this->getLongDescription()]
                ];
                $where = [
                    'obj_id' => ['integer',$this->getId()]
                ];
                $this->db->update('object_description', $values, $where);
            } else {
                $values = [
                    'description' => ['clob',$this->getLongDescription()],
                    'obj_id' => ['integer',$this->getId()]
                ];
                $this->db->insert('object_description', $values);
            }
        }
 
        $this->app_event_handler->raise(
            'Services/Object',
            'update',
            [
                'obj_id' => $this->getId(),
                'obj_type' => $this->getType(),
                'ref_id' => $this->getRefId()
            ]
        );
 
        return true;
    }

References $res, getDescription(), getId(), getImportId(), getLongDescription(), getOfflineStatus(), getRefId(), getTitle(), getType(), ilStr\subStr(), and supportsOfflineHandling().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateMetaData()

ilObject::updateMetaData ( )

final

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

                                          : void
    {
        if ($this->beforeUpdateMetaData()) {
            $md = new ilMD($this->getId(), 0, $this->getType());
            $md_gen = $md->getGeneral();
            // BEGIN WebDAV: metadata can be missing sometimes.
            if (!$md_gen instanceof ilMDGeneral) {
                $this->createMetaData();
                $md = new ilMD($this->getId(), 0, $this->getType());
                $md_gen = $md->getGeneral();
            }
            // END WebDAV: metadata can be missing sometimes.
            $md_gen->setTitle($this->getTitle());
 
            // sets first description (maybe not appropriate)
            $md_des_ids = $md_gen->getDescriptionIds();
            if (count($md_des_ids) > 0) {
                $md_des = $md_gen->getDescription($md_des_ids[0]);
                $md_des->setDescription($this->getLongDescription());
                $md_des->update();
            }
            $md_gen->update();
            $this->doUpdateMetaData();
        }
    }

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

Referenced by ilObjFile\beforeUpdate(), ilObjSurvey\update(), ilObjGroup\update(), ilObjIndividualAssessment\update(), ilObjSAHSLearningModule\update(), ilObjSurveyQuestionPool\update(), ilObjTest\update(), ilObjQuestionPool\update(), ilObjLinkResource\update(), ilObjFileBasedLM\update(), and ilObjSession\update().

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 773 of file class.ilObject.php.

                                       : 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();
    }

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

Referenced by ilObjUser\update().

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 134 of file class.ilObject.php.

                                          : 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;
    }

References $referenced, and true.

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

Here is the caller graph for this function:

Field Documentation

◆ $add_dots

bool ilObject::$add_dots = true

protected

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

◆ $app_event_handler

ilAppEventHandler ilObject::$app_event_handler

protected

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

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

◆ $call_by_reference

bool ilObject::$call_by_reference

protected

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

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

◆ $create_date

string ilObject::$create_date = ""

protected

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

Referenced by getCreateDate().

◆ $db

ilDBInterface ilObject::$db

protected

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

Referenced by _exists(), _getAllReferences(), ilObjSystemFolder\_getHeaderTitleDescription(), _getIdForImportId(), _getIdsForTitle(), _getLastUpdateOfObjects(), _getObjectsByType(), _getObjectsDataForType(), _lookupDeletedDate(), _lookupImportId(), _lookupObjIdByImportId(), _resetDeletedDate(), _setDeletedDate(), _writeDescription(), _writeImportId(), _writeTitle(), ilObjSystemFolder\addHeaderTitleTranslation(), ilObjBookingPool\create(), ilObjMediaCast\create(), ilObjMediaPool\create(), ilObjFileBasedLM\create(), ilObjSession\create(), ilObjCategory\delete(), ilObjMediaCast\delete(), ilObjSession\delete(), ilContainerReference\delete(), ilObjPoll\deleteAllAnswers(), ilObjPoll\deleteAllVotes(), ilObjPoll\deleteAnswer(), ilObjMediaCast\deleteOrder(), ilObjLearningSequence\deletePostConditionsForSubObjects(), ilObjSurvey\deleteSurveyRecord(), ilObjSCORM2004LearningModule\deleteTrackingDataOfUsers(), ilObjBlog\doCreate(), ilObjPoll\doCreate(), ilObjPortfolioBase\doCreate(), ilObjTaxonomy\doCreate(), ilObjBlog\doDelete(), ilObjPoll\doDelete(), ilObjPortfolioBase\doDelete(), ilObjBlog\doRead(), ilObjPoll\doRead(), ilObjPortfolioBase\doRead(), ilObjBlog\doUpdate(), ilObjPoll\doUpdate(), ilObjPortfolioBase\doUpdate(), ilObjPoll\getAnswer(), ilObjPoll\getAnswers(), ilObjSCORM2004LearningModule\getAttemptsForUser(), ilObjLearningSequence\getLSItems(), ilObjLearningSequence\getLSLearnerItems(), ilObjSCORM2004LearningModule\getModuleVersionForUser(), ilObjBookingPool\getPoolsWithReminders(), ilObjStudyProgramme\getProgrammesMonitoringCategory(), ilObjStudyProgramme\getProgrammesMonitoringMemberSource(), ilObjTaxonomyAdministration\getRepositoryTaxonomies(), ilObjSCORM2004LearningModule\getTrackedItems(), ilObjSCORM2004LearningModule\getTrackingDataAgg(), ilObjWorkspaceRootFolder\getTranslations(), ilObjPoll\getVotesByUsers(), ilObjSCORM2004LearningModule\importSuccess(), ilObjCourseReference\lookupMemberUpdateEnabled(), ilObjBookingPool\read(), ilObjFileBasedLM\read(), ilObjMediaCast\read(), ilObjMediaPool\read(), ilContainerReference\read(), ilObjSkillManagement\read(), ilObjUser\read(), ilObjMediaCast\readOrder(), ilObjLTIAdministration\readReleaseObjects(), ilObjSystemFolder\removeHeaderTitleTranslations(), ilObjWorkspaceRootFolder\removeTranslations(), ilObjPoll\saveAnswer(), ilObjUser\saveAsNew(), ilObjMediaCast\saveOrder(), setDeletedDates(), ilObjLearningSequence\storeLSItems(), ilObjBookingPool\update(), ilObjMediaCast\update(), ilObjMediaPool\update(), ilContainerReference\update(), ilObjSkillManagement\update(), ilObjUser\update(), ilObjFileBasedLM\update(), ilObjSession\update(), ilObjPoll\updateAnswer(), ilObjPoll\updateAnswerPositions(), and ilObjUser\writeAccepted().

◆ $desc

string ilObject::$desc = ""

protected

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

Referenced by ilObjLanguage\__construct(), _writeDescription(), getDescription(), getLongDescription(), setDescription(), and ilObjOrgUnit\updateTranslation().

◆ $error

ilErrorHandling ilObject::$error

protected

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

Referenced by ilObjSCORM2004LearningModule\readObject(), and ilObjSession\validate().

◆ $id

int ilObject::$id

protected

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

◆ $ilias

ILIAS ilObject::$ilias

protected

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

Referenced by ilObjUser\__construct(), ilObjTest\_createImportDirectory(), and ilObjQuestionPool\_createImportDirectory().

◆ $import_id

string ilObject::$import_id = ""

protected

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

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

◆ $last_update

string ilObject::$last_update = ""

protected

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

Referenced by _lookupLastUpdate(), and getLastUpdateDate().

◆ $lng

ilLanguage ilObject::$lng

protected

◆ $log

ilLogger ilObject::$log

protected

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

Referenced by ilObjSCORM2004LearningModule\convert_1_2_to_2004(), ilObjCmiXapi\log(), and ilObjLTIConsumer\sendResponseError().

◆ $long_desc

string ilObject::$long_desc = ""

protected

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

Referenced by getLongDescription().

◆ $max_desc

int ilObject::$max_desc = self::DESC_LENGTH

protected

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

◆ $max_title

int ilObject::$max_title = self::TITLE_LENGTH

protected

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

◆ $obj_definition

ilObjectDefinition ilObject::$obj_definition

protected

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

Referenced by _writeDescription().

◆ $obj_log

ilLogger ilObject::$obj_log

protected

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

◆ $objectList

array ilObject::$objectList

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

◆ $offline

bool ilObject::$offline = false

protected

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

Referenced by getOfflineStatus().

◆ $owner

int ilObject::$owner = 0

protected

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

Referenced by _getObjectsByType(), _lookupOwnerName(), create(), and getOwner().

◆ $process_auto_reating

bool ilObject::$process_auto_reating = false

private

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

◆ $rbac_admin

ilRbacAdmin ilObject::$rbac_admin

protected

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

Referenced by delete().

◆ $rbac_review

ilRbacReview ilObject::$rbac_review

protected

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

◆ $ref_id

int ilObject::$ref_id = null

protected

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

Referenced by ilOrgUnitExtension\__construct(), ilObjQuestionPool\_getAvailableQuestionpools(), ilObjQuestionPool\_getFullPathToQpl(), ilObjUserTracking\_hasLearningProgressOtherUsers(), _hasUntrashedReference(), _isInTrash(), ilObjQuestionPool\_isWriteable(), _lookupDeletedDate(), _lookupObjectId(), _lookupObjId(), _resetDeletedDate(), _setDeletedDate(), createReference(), ilObjForum\createSettings(), ilObjStudyProgramme\getInstanceByRefId(), ilObjLearningSequence\getInstanceByRefId(), ilObjLearningSequence\getParentObjectInfo(), ilObjForum\getUserIdsOfLastPostsByRefIdAndThreadIds(), ilObjSession\handleAutoFill(), ilObjForum\lookupForumIdByRefId(), ilObjForum\lookupLastPostByRefId(), ilObjForum\lookupStatisticsByRefId(), ilObjForum\preloadForumIdsByRefIds(), ilContainerReference\read(), and setRefId().

◆ $referenced

bool ilObject::$referenced

protected

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

Referenced by withReferences().

◆ $register

bool ilObject::$register = false

protected

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

◆ $title

◆ $tree

◆ $type

string ilObject::$type = ""

protected

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

Referenced by ilCertificateVerificationObject\__construct(), _exists(), _getIdsForTitle(), _getObjectsDataForType(), ilObjSAHSLearningModule\checkMasteryScoreValues(), ilObjLearningSequence\cloneIntroAndExtroContentPages(), delete(), ilObjStudyProgramme\enableAutomaticMembershipSource(), ilObjQuestionPool\getExportDirectory(), ilObjBibliographic\getFileTypeAsString(), ilObjOrgUnit\getIconsCache(), ilObjRepositorySettings\getNewItemGroupSubItems(), ilOrgUnitExtension\getOrgUnitSubtree(), ilObjectPlugin\getPluginObjectByType(), ilObjLearningSequence\getPossiblePostConditionsForType(), ilObjCmiXapi\getSatisfiedStatement(), getType(), ilObjStudyProgramme\hasAdvancedMetadata(), ilRemoteObjectBase\importMetadataFromJson(), ilObjGroup\lookupGroupStatusTemplateId(), ilObjBibliographic\parseFileToDatabase(), ilContainerReference\setTitleType(), and setType().

◆ $untranslatedTitle

string ilObject::$untranslatedTitle

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

Referenced by getUntranslatedTitle().

◆ $user

ilObjUser ilObject::$user

protected

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

Referenced by create(), ilRemoteObjectBase\getFullRemoteLink(), ilObjChatroom\getPersonalInformation(), ilObjCmiXapi\getStatementActor(), and ilObjSession\handleAutoFill().

◆ DESC_LENGTH

const ilObject::DESC_LENGTH = 128

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

Referenced by ilObjSystemFolder\_getHeaderTitleDescription(), ilTree\fetchNodeData(), ilAdminSubItemsTableGUI\fillRow(), and ilContainer\getCompleteDescriptions().

◆ LONG_DESC_LENGTH

const ilObject::LONG_DESC_LENGTH = 4000

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

Referenced by ilObjectGUI\initCreateForm(), ilObjectGUI\initEditForm(), and setDescription().

◆ TABLE_OBJECT_DATA

const ilObject::TABLE_OBJECT_DATA = "object_data"

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

Referenced by ilObjectTest\testCreationDeletion().

◆ TITLE_LENGTH

const ilObject::TITLE_LENGTH = 255

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

Referenced by ilSearchRootSelector\__construct(), ilContainerSelectionExplorer\__construct(), ilObjEmployeeTalkSeriesGUI\initCreateForm(), ilObjGlossaryGUI\initCreateForm(), ilObjPortfolioGUI\initCreateForm(), ilObjectGUI\initCreateForm(), ilObjectPluginGUI\initCreateForm(), ilObjDataCollectionGUI\initEditForm(), ilObjFolderGUI\initEditForm(), ilObjPortfolioGUI\initEditForm(), ilObjSurveyQuestionPoolGUI\initEditForm(), ilObjectGUI\initEditForm(), ilObjectPluginGUI\initEditForm(), ilRemoteObjectBaseGUI\initEditForm(), ilFileVersionFormGUI\initForm(), ilContainerReferenceGUI\initForm(), and ilObjFileBasedLMGUI\initSettingsForm().

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

Services/Object/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

Constructor & Destructor Documentation

◆ __construct()

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()

◆ getAllOwnedRepositoryObjects()

◆ getCallbackForTitlesPerLanguageTransformation()

◆ getCreateDate()

◆ getDeletionDependencies()

◆ getDescription()

◆ getHTMLDirectory()

◆ getId()

◆ getImportId()

◆ getLastUpdateDate()

◆ getLongDescription()

◆ getLongDescriptions()

◆ getOfflineStatus()

◆ getOwner()

◆ getOwnerName()

◆ getPossibleSubObjects()

◆ getPresentationTitle()

◆ getRefId()