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

Inheritance diagram for ilObject:

Collaboration diagram for ilObject:

Public Member Functions
	ilObject ($a_id=0, $a_reference=true)
	Constructor @access public. More...

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

	read ($a_force_db=false)
	read object data from db into object More...

	getId ()
	get object id @access public More...

	setId ($a_id)
	set object id @access public More...

	setRefId ($a_id)
	set reference id @access public More...

	getRefId ()
	get reference id @access public More...

	getType ()
	get object type @access public More...

	setType ($a_type)
	set object type @access public More...

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

	getTitle ()
	get object title @access public More...

	getUntranslatedTitle ()
	get untranslated object title @access public More...

	setTitle ($a_title)
	set object title More...

	getDescription ()
	get object description More...

	setDescription ($a_desc)
	set object description More...

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

	getImportId ()
	get import id More...

	setImportId ($a_import_id)
	set import id More...

	getOwner ()
	get object owner More...

	getOwnerName ()

	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...

	setOwner ($a_owner)
	set object owner More...

	getCreateDate ()
	get create date @access public More...

	getLastUpdateDate ()
	get last update date @access public More...

	getDiskUsage ()

	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class) More...

	create ()
	create More...

	update ()
	update object in db More...

	MDUpdateListener ($a_element)
	Meta data update listener. More...

	createMetaData ()
	create meta data entry More...

	updateMetaData ()
	update meta data entry More...

	deleteMetaData ()
	delete meta data entry More...

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

	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...

	_lookupOwner ($a_id)
	lookup object owner More...

	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...

	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...

	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree More...

	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...

	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...

	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...

	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...

	_isInTrash ($a_ref_id)
	checks wether object is in trash More...

	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...

	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...

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

	setPermissions ($a_parent_ref)
	set permissions of object More...

	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...

	createReference ()
	creates reference for object More...

	countReferences ()
	count references of object More...

	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 If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) @access public More...

	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...

	notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
	notifys an object about an event occured Based on the event passed, each object may decide how it reacts. More...

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	getXMLZip ()

	getHTMLDirectory ()

	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	Clone object permissions, put in tree ... More...

	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...

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

	_lookupCreationDate ($a_id)
	Lookup creation date. More...

Static Public Member Functions
static	_lookupObjIdByImportId ($a_import_id)

static	_getAllReferences ($a_id)
	get all reference ids of object More...

static	_lookupTitle ($a_id)
	lookup object title More...

static	_getIdsForTitle ($title, $type='', $partialmatch=false)

static	_lookupDescription ($a_id)
	lookup object description More...

static	_lookupObjId ($a_id)

static	setDeletedDates ($a_ref_ids)
	Set deleted date @global type $ilDB. More...

static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...

static	_lookupObjectId ($a_ref_id)
	lookup object id More...

static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data@access public More...

static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...

static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection. More...

static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $a_obj_ids)
	Get long description data. More...

static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns. More...

static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

Data Fields
const	TITLE_LENGTH = 255
	max length of object title More...

const	DESC_LENGTH = 128

	$ilias

	$lng

	$id

	$ref_id

	$type

	$title

	$untranslatedTitle

	$desc

	$long_desc

	$owner

	$create_date

	$last_update

	$import_id

	$register = false

	$referenced

	$objectList

	$max_title

	$max_desc

	$add_dots

	$obj_data_record
	object_data record More...

Detailed Description

Class ilObject Basic functions for all objects.

Author: Stefan Meyer smeye.nosp@m.r.il.nosp@m.ias@g.nosp@m.mx.d.nosp@m.e; Alex Killing alex..nosp@m.kill.nosp@m.ing@g.nosp@m.mx.d.nosp@m.e

Version: $Id$

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

Member Function Documentation

◆ _exists()

static ilObject::_exists	(	$a_id,
		$a_reference = `false`,
		$a_type = `null`
	)

static

checks if an object exists in object_data@access public

Parameters

integer	object id or reference id
boolean	true if id is a reference, else false (default)
string	restrict on a certain type.

Returns: boolean true if object exists

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

        {
                global $ilDB;
                
                if ($a_reference)
                {
                        $q = "SELECT * FROM object_data ".
                                 "LEFT JOIN object_reference ON object_reference.obj_id=object_data.obj_id ".
                                 "WHERE object_reference.ref_id= ".$ilDB->quote($a_id, "integer");
                }
                else
                {
                        $q = "SELECT * FROM object_data WHERE obj_id=".$ilDB->quote($a_id, "integer");
                }
 
                if($a_type)
                        $q .= " AND object_data.type = ".$ilDB->quote($a_type, "text");
                
                $r = $ilDB->query($q);
 
                return $ilDB->numRows($r) ? true : false;
        }

References $ilDB.

Referenced by ilShopUtils\_createRandomUserAccount(), _lookupOwnerName(), ilNavigationHistory\addItem(), ilSoapObjectAdministration\addObject(), ilPCFileList\afterPageUpdate(), ilPCMediaObject\afterPageUpdate(), ilPCFileList\beforePageDelete(), ilPCMediaObject\beforePageDelete(), ilSoapAdministration\checkObjectAccess(), ilPageObject\collectMediaObjects(), ilPageObject\delete(), ilNewsItem\delete(), ilObjSCORMLearningModuleGUI\deleteTrackingForUser(), ilPublicUserProfileGUI\deliverVCard(), ilObjExerciseGUI\downloadAllObject(), ilSCORM2004Asset\exportFileItems(), ilObjContentObject\exportHTML(), ilCOPageHTMLExport\exportPageElements(), ilForum\fetchPostNodeData(), ilLinksTableGUI\fillRow(), ilMediaCastTableGUI\fillRow(), ilWikiContributorsTableGUI\fillRow(), ilPageHistoryTableGUI\fillRow(), ilPDNewsTableGUI\fillRow(), ilPageObject\getContentObject(), ilObjStyleSheet\getContentStylePath(), ilSoapCourseAdministration\getCoursesForUser(), ilPublicUserProfileGUI\getEmbeddable(), ilSCORM2004ScoGUI\getExportResources(), ilSoapGroupAdministration\getGroupsForUser(), ilGoogleMapGUI\getHtml(), ilOpenLayersMapGUI\getHtml(), ilObjMediaObject\getLinkedMediaObjects(), ilNoteGUI\getNoteListHTML(), ilTagging\getObjectsForTagAndUser(), ilExAssignmentGUI\getOverviewBody(), ilGoogleMapGUI\getUserListHtml(), ilOpenLayersMapGUI\getUserListHtml(), ilObjectFeedWriter\ilObjectFeedWriter(), ilSCORM2004TrackingItemsPerUserFilterGUI\parse(), ilSCORMTrackingItemsPerUserFilterGUI\parse(), ilNewsForContextBlockGUI\showNews(), ilPageObjectGUI\showPage(), ilObjSCORM2004LearningModuleGUI\showTrackingItems(), ilObjSCORMLearningModuleGUI\showTrackingItems(), ilObjSCORMLearningModuleGUI\stopUserOfflineMode(), ilObjectTest\testCreationDeletion(), ilSCORMTrackingItems\userDataArrayForExport(), and ilContObjectManifestBuilder\writeResources().

Here is the caller graph for this function:

◆ _getAllReferences()

static ilObject::_getAllReferences ( $a_id )

static

get all reference ids of object

Parameters

int $a_id object id

Reimplemented in ilObject2.

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

        {
                global $ilDB;
 
                $query = "SELECT * FROM object_reference WHERE obj_id = ".
                        $ilDB->quote($a_id,'integer');
                        
                $res = $ilDB->query($query);
                $ref = array();
                while($obj_rec = $ilDB->fetchAssoc($res))
                {
                        $ref[$obj_rec["ref_id"]] = $obj_rec["ref_id"];
                }
 
                return $ref;
        }

References $ilDB, $query, and $res.

Here is the caller graph for this function:

◆ _getIcon()

static ilObject::_getIcon	(	$a_obj_id = `""`,
		$a_size = `"big"`,
		$a_type = `""`,
		$a_offline = `false`
	)

static

Get icon for repository item.

Parameters

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

Reimplemented in ilObject2.

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

        {
                global $ilSetting, $objDefinition;
 
                if ($a_obj_id == "" && $a_type == "")
                {
                        return "";
                }
                
                if ($a_type == "")
                {
                        $a_type = ilObject::_lookupType($a_obj_id);
                }
                
                if ($a_size == "")
                {
                        $a_size = "big";
                }
                
                if ($ilSetting->get("custom_icons") &&
                        in_array($a_type, array("cat","grp","crs", "root", "fold")))
                {
                        require_once("./Services/Container/classes/class.ilContainer.php");
                        if (ilContainer::_lookupContainerSetting($a_obj_id, "icon_custom"))
                        {
                                $cont_dir = ilContainer::_getContainerDirectory($a_obj_id);
 
                                $file_name = $cont_dir."/icon_custom.svg";
                                if (is_file($file_name))
                                {
                                        return $file_name;
                                }
                        }
                }
                
                if (!$a_offline)
                {                       
                        if ($objDefinition->isPluginTypeName($a_type))
                        {
                                if ($objDefinition->getClassName($a_type) != "")
                                {
                                        $class_name = "il".$objDefinition->getClassName($a_type).'Plugin';
                                        $location = $objDefinition->getLocation($a_type);
                                        if (is_file($location."/class.".$class_name.".php"))
                                        {
                                                include_once($location."/class.".$class_name.".php");
                                                return call_user_func(array($class_name, "_getIcon"), $a_type, $a_size, $a_obj_id);
                                        }
                                }
                                return ilUtil::getImagePath("icon_cmps.svg");
                        }
                        
                        return ilUtil::getImagePath("icon_".$a_type.".svg");
                }
                else
                {
                        return "./images/icon_".$a_type.".svg";
                }
        }

References $ilSetting, $location, ilContainer\_getContainerDirectory(), ilContainer\_lookupContainerSetting(), _lookupType(), and ilUtil\getImagePath().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _getIdForImportId()

ilObject::_getIdForImportId ( $a_import_id )

get current object id for import id (static)

Parameters

int $a_import_id import id

Returns: int id

Reimplemented in ilObject2.

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

        {
                global $ilDB;
                
                $ilDB->setLimit(1,0);
                $q = "SELECT * FROM object_data WHERE import_id = ".$ilDB->quote($a_import_id, "text").
                        " ORDER BY create_date DESC";
                $obj_set = $ilDB->query($q);
 
                if ($obj_rec = $ilDB->fetchAssoc($obj_set))
                {
                        return $obj_rec["obj_id"];
                }
                else
                {
                        return 0;
                }
        }

References $ilDB.

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

Here is the caller graph for this function:

◆ _getIdsForTitle()

static ilObject::_getIdsForTitle	(	$title,
		$type = `''`,
		$partialmatch = `false`
	)

static

Reimplemented in ilObject2.

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

        {
                global $ilDB;
                
                $query = (!$partialmatch)
                        ? "SELECT obj_id FROM object_data WHERE title = ".$ilDB->quote($title, "text")
                        : "SELECT obj_id FROM object_data WHERE ".$ilDB->like("title", "text", '%'.$title.'%');
                if($type != '')
                {
                        $query .= " AND type = ".$ilDB->quote($type, "text");
                }
                
                $result = $ilDB->query($query);
                
                $object_ids = array();
                while($row = $ilDB->fetchAssoc($result))
                {
                        $object_ids[] = $row['obj_id'];
                }
                
                return is_array($object_ids) ? $object_ids : array();
        }

References $ilDB, $query, $result, $row, $title, and $type.

Referenced by ilTestEvaluationData\getParticipants(), ilRoleXmlImporter\importSimpleXml(), ilObjCourseGUI\mailMembersObject(), ilObjGroupGUI\mailMembersObject(), ilObjRoleGUI\mailToRoleObject(), and ilObjectTest\testSetGetLookup().

Here is the caller graph for this function:

◆ _getLastUpdateOfObjects()

ilObject::_getLastUpdateOfObjects ( $a_objs )

Get last update for a set of media objects.

Parameters

array

Reimplemented in ilObject2.

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

        {
                global $ilDB;
                
                if (!is_array($a_objs))
                {
                        $a_objs = array($a_objs);
                }
                $types = array();
                $set = $ilDB->query("SELECT max(last_update) as last_update FROM object_data ".
                        "WHERE ".$ilDB->in("obj_id", $a_objs, false, "integer")." ");
                $rec = $ilDB->fetchAssoc($set);
                
                return ($rec["last_update"]);
        }

References $ilDB.

Referenced by ilPageObject\getLastUpdateOfIncludedElements().

Here is the caller graph for this function:

◆ _getObjectsByType()

static ilObject::_getObjectsByType	(	$a_obj_type = `""`,
		$a_owner = `""`
	)

static

Get objects by type.

Reimplemented in ilObject2.

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

        {
                global $ilDB;
                                
                $order = " ORDER BY title";
 
                // where clause
                if ($a_obj_type)
                {
                        $where_clause = "WHERE type = ".
                                $ilDB->quote($a_obj_type, "text");
                                
                        if ($a_owner != "")
                        {
                                $where_clause.= " AND owner = ".$ilDB->quote($a_owner, "integer");
                        }
                }
        
                $q = "SELECT * FROM object_data ".$where_clause.$order;
                $r = $ilDB->query($q);
 
                $arr = array();
                if ($ilDB->numRows($r) > 0)
                {
                        while ($row = $ilDB->fetchAssoc($r))
                        {
                                $row["desc"] = $row["description"];
                                $arr[$row["obj_id"]] = $row;
                        }
                }
        
                return $arr;
        }

References $ilDB, and $row.

Referenced by ilObjUserTracking\_hasLearningProgressOtherUsers(), ilLPCronObjectStatistics\gatherCourseLPData(), ilObjPortfolioTemplate\getAvailablePortfolioTemplates(), ilLanguage\getInstalledLanguages(), ilObjLanguage\getInstalledLanguages(), ilObjLanguageFolder\getLanguages(), ilObjLanguage\refreshAll(), and ilObjectTest\testSetGetLookup().

Here is the caller graph for this function:

◆ _getObjectsDataForType()

ilObject::_getObjectsDataForType	(	$a_type,
		$a_omit_trash = `false`
	)

get all objects of a certain type

Parameters

string	$a_type	desired object type
boolean	$a_omit_trash	omit objects, that are in trash only (default: false)

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

Reimplemented in ilObject2.

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

        {
                global $ilDB;
 
                $q = "SELECT * FROM object_data WHERE type = ".$ilDB->quote($a_type, "text");
                $obj_set = $ilDB->query($q);
 
                $objects = array();
                while ($obj_rec = $ilDB->fetchAssoc($obj_set))
                {
                        if ((!$a_omit_trash) || ilObject::_hasUntrashedReference($obj_rec["obj_id"]))
                        {
                                $objects[$obj_rec["title"].".".$obj_rec["obj_id"]] = array("id" => $obj_rec["obj_id"],
                                        "type" => $obj_rec["type"], "title" => $obj_rec["title"],
                                        "description" => $obj_rec["description"]);
                        }
                }
                ksort($objects);
                return $objects;
        }

References $ilDB, and _hasUntrashedReference().

Referenced by ilObjStyleSheet\_addMissingStyleClassesToAllStyles().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _hasUntrashedReference()

ilObject::_hasUntrashedReference ( $a_obj_id )

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

Reimplemented in ilObject2.

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

        {
                $ref_ids  = ilObject::_getAllReferences($a_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 ilLMObject\_getAllObjectsForImportId(), ilGlossaryTerm\_getIdForImportId(), ilLMObject\_getIdForImportId(), ilSCORM2004Node\_getIdForImportId(), _getObjectsDataForType(), ilObjSurveyQuestionPool\_isWriteable(), ilObjQuestionPool\_isWriteable(), ilOrgUnitImporter\buildRef(), ilChatroomViewTask\forcePublicRoom(), ilSoapObjectAdministration\getObjIdsByRefIds(), ilObjSAHSLearningModule\getScormModulesForGlossary(), ilTaggingAppEventListener\handleEvent(), ilMailSearchGroupsGUI\showMyGroups(), ilOrgUnitSimpleImport\simpleImportElement(), ilObjectTest\testTreeTrash(), ilBasicSkill\updateAllUserSkillLevels(), and ilBasicSkill\updateSkillLevelsByTriggerRef().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _isInTrash()

ilObject::_isInTrash ( $a_ref_id )

checks wether object is in trash

Reimplemented in ilObject2.

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

        {
                global $tree;
 
                return $tree->isSaved($a_ref_id);
        }

Referenced by _hasUntrashedReference(), ilSoapCourseAdministration\addCourse(), ilSoapExerciseAdministration\addExercise(), ilSoapFileAdministration\addFile(), ilSoapGroupAdministration\addGroup(), ilSoapObjectAdministration\addObject(), ilSoapRBACAdministration\addRole(), ilSoapRBACAdministration\addRoleFromTemplate(), ilOrgUnitImporter\buildRef(), ilSoapAdministration\checkObjectAccess(), ilSoapWebLinkAdministration\createWebLink(), ilObjFolder\downloadFolder(), ilObjWorkspaceFolder\downloadFolder(), ilContainerGUI\downloadMultipleObjects(), ilBasicSkillGUI\editLevelTrigger(), ilSoapCourseAdministration\getCoursesForUser(), ilSoapExerciseAdministration\getExerciseXML(), ilSoapFileAdministration\getFileXML(), ilSoapGroupAdministration\getGroup(), ilSoapGroupAdministration\getGroupsForUser(), ilSoapSCORMAdministration\getIMSManifestXML(), ilSoapObjectAdministration\getObjectByReference(), ilSoapRBACAdministration\getObjectTreeOperations(), ilSoapObjectAdministration\getPathForRefId(), ilSoapTestAdministration\getTestResults(), ilCopyWizardSettingsXMLParser\handlerBeginTag(), ilSoapSCORMAdministration\hasSCORMCertificate(), ilSoapObjectAdministration\moveObject(), ilSoapWebLinkAdministration\readWebLink(), ilObjFolder\recurseFolder(), ilObjWorkspaceFolder\recurseFolder(), ilContainerGUI\recurseFolder(), ilSoapTestAdministration\removeTestResults(), ilObjectTest\testTreeTrash(), ilSoapExerciseAdministration\updateExercise(), ilSoapFileAdministration\updateFile(), ilSoapGroupAdministration\updateGroup(), ilSoapObjectAdministration\updateObjects(), and ilSoapWebLinkAdministration\updateWebLink().

Here is the caller graph for this function:

◆ _lookupCreationDate()

ilObject::_lookupCreationDate ( $a_id )

Lookup creation date.

Parameters

return

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

        {
                global $ilDB;
                
                $set = $ilDB->query("SELECT create_date FROM object_data ".
                        " WHERE obj_id = ".$ilDB->quote($a_id, "integer"));
                $rec  = $ilDB->fetchAssoc($set);
                return $rec["create_date"];
        }

References $ilDB.

Referenced by ilObjHelpSettings\getHelpModules().

Here is the caller graph for this function:

◆ _lookupDeletedDate()

ilObject::_lookupDeletedDate ( $a_ref_id )

only called in ilObjectGUI::insertSavedNodes

Reimplemented in ilObject2.

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

        {
                global $ilDB;
                
                $query = "SELECT deleted FROM object_reference".
                        " WHERE ref_id = ".$ilDB->quote($a_ref_id, "integer");
                $set = $ilDB->query($query);
                $rec = $ilDB->fetchAssoc($set);
 
                return $rec["deleted"];
        }

References $ilDB, and $query.

Referenced by ilObjectTest\testObjectReference(), and ilObjectTest\testSetGetLookup().

Here is the caller graph for this function:

◆ _lookupDescription()

static ilObject::_lookupDescription ( $a_id )

static

lookup object description

Parameters

int $a_id object id

Reimplemented in ilObject2.

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

        {
                global $ilObjDataCache;
 
                return $ilObjDataCache->lookupDescription($a_id);
        }

Referenced by ilLPStatusEvent\_getStatusInfo(), ilObjUser\_lookupDesktopItems(), ilDidacticTemplateLocalRoleAction\apply(), ilECSSettingsGUI\exportImported(), ilECSSettingsGUI\exportReleased(), ilObjSurvey\getGroupData(), ilObjTest\getGroupData(), ilCourseGroupingAssignmentTableGUI\getItems(), ilShopSearchResult\getResultsForPresentation(), ilObjSurvey\getRoleData(), ilObjTest\getRoleData(), ilSCORMOfflineMode\il2sop(), ilCourseObjectivesGUI\initFormLimits(), ilObjCategoryReferenceListGUI\initItem(), ilObjCourseReferenceListGUI\initItem(), ilLOEditorGUI\initTestForm(), ilSearchResultPresentation\lookupDescription(), ilCourseObjectiveQuestionsTableGUI\parse(), ilRoleSelectionTableGUI\parse(), ilCalendarSharedListTableGUI\parse(), ilCalendarSharedRoleListTableGUI\parse(), ilRepositoryObjectResultTableGUI\parseObjectIds(), ilDataCollectionRecordEditGUI\parseSearchResults(), ilObjectCopySearchResultTableGUI\parseSearchResults(), ilMediaObjectDataSet\readData(), ilConditionHandlerTableGUI\setConditions(), ilShopGUI\showContainerContent(), ilPDTaggingBlockGUI\showResourcesForTag(), ilShopGUI\showSpecialContent(), ilShopGUI\showTopicsContent(), ilObjectTest\testSetGetLookup(), and ilRoleXmlExport\writeRole().

Here is the caller graph for this function:

◆ _lookupLastUpdate()

ilObject::_lookupLastUpdate	(	$a_id,
		$a_as_string = `false`
	)

lookup last update

Parameters

int $a_id object id

Reimplemented in ilObject2.

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

        {
                global $ilObjDataCache;
                
                if ($a_as_string)
                {
                        return ilDatePresentation::formatDate(new ilDateTime($ilObjDataCache->lookupLastUpdate($a_id),IL_CAL_DATETIME));
                }
                else
                {
                        return $ilObjDataCache->lookupLastUpdate($a_id);
                }
        }

References ilDatePresentation\formatDate(), and IL_CAL_DATETIME.

Referenced by ilObjectTest\testSetGetLookup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupObjectId()

static ilObject::_lookupObjectId ( $a_ref_id )

static

lookup object id

Parameters

int $a_id object id

Reimplemented in ilObject2.

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

        {
                global $ilObjDataCache;
 
                return (int) $ilObjDataCache->lookupObjId($a_ref_id);
        }

Referenced by ilObject2GUI\__construct(), ilSCORM13Player\__construct(), ilSCORMOfflineMode\__construct(), ilShopUtils\_assignPurchasedCourseMemberRole(), ilShopUtils\_deassignPurchasedCourseMemberRole(), ilObjSurveyQuestionPool\_getAvailableQuestionpools(), ilPDSelectedItemsBlockGUI\confirmRemoveObject(), ilContainerGUI\editPageContentObject(), ilSAHSEditGUI\executeCommand(), ilSAHSPresentationGUI\executeCommand(), ilSCORMOfflineModeGUI\executeCommand(), ilObjiLincClassroomGUI\getDefaultValues(), ilSoapExerciseAdministration\getExerciseXML(), ilSoapFileAdministration\getFileXML(), ilSoapSCORMAdministration\getIMSManifestXML(), ilObjiLincClassroomGUI\getObjectValues(), ilSoapObjectAdministration\getObjIdsByRefIds(), ilTrQuery\getParticipantsForObject(), ilLPCollectionOfLMChapters\getPossibleItems(), ilSoapSCORMAdministration\getSCORMCompletionStatus(), ilTrQuery\getSummaryDataForObject(), ilSoapTestAdministration\getTestResults(), ilTrQuery\getUserDataForObject(), ilTrQuery\getUserObjectMatrix(), ilMembershipRegistrationCodeUtils\handleCode(), ilSoapSCORMAdministration\hasSCORMCertificate(), ilObjContentObjectGUI\initMenuEntryForm(), ilShopRepositoryExplorer\isClickable(), ilRepositoryExplorer\isClickable(), ilRepositoryExplorerGUI\isNodeClickable(), ilForum\moveThreads(), ilObjSCORMLearningModuleGUI\newModuleVersion(), assTextQuestionGUI\outQuestionForTest(), ilRbacLogTableGUI\parseChangesFaPa(), ilSoapWebLinkAdministration\readWebLink(), ilObjiLincClassroomGUI\save(), ilSAHSPresentationGUI\setInfoTabs(), ilObjectTest\testSetGetLookup(), ilObjiLincClassroomGUI\updateClassroom(), ilSoapExerciseAdministration\updateExercise(), ilSoapFileAdministration\updateFile(), ilSoapObjectAdministration\updateObjects(), and ilSoapWebLinkAdministration\updateWebLink().

Here is the caller graph for this function:

◆ _lookupObjId()

static ilObject::_lookupObjId ( $a_id )

static

Reimplemented in ilObject2.

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

        {
                global $ilObjDataCache;
 
                return (int) $ilObjDataCache->lookupObjId($a_id);
        }

Here is the caller graph for this function:

◆ _lookupObjIdByImportId()

static ilObject::_lookupObjIdByImportId ( $a_import_id )

static

Reimplemented in ilObject2.

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

        {
                global $ilDB;
 
                $query = "SELECT * FROM object_data ".
                        "WHERE import_id = ".$ilDB->quote($a_import_id, "text")." ".
                        "ORDER BY create_date DESC";
                $res = $ilDB->query($query);
                while($row = $ilDB->fetchObject($res))
                {
                        return $row->obj_id;
                }
                return 0;
        }

References $ilDB, $query, $res, and $row.

Referenced by ilSoapObjectAdministration\addObject(), ilOrgUnitImporter\buildRef(), ilOrgUnitSimpleUserImport\buildUserId(), ilSoapObjectAdministration\getObjIdByImportId(), ilSoapObjectAdministration\getRefIdsByImportId(), ilRoleXmlImporter\initRole(), ilAuthContainerECS\loginObserver(), ilSoapObjectAdministration\removeFromSystemByImportId(), ilOrgUnitSimpleImport\simpleImportElement(), and ilObjectTest\testSetGetLookup().

Here is the caller graph for this function:

◆ _lookupOwner()

ilObject::_lookupOwner ( $a_id )

lookup object owner

Parameters

int $a_id object id

Reimplemented in ilObject2.

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

        {
                global $ilObjDataCache;
 
                $owner = $ilObjDataCache->lookupOwner($a_id);
                return $owner;
        }

References $owner.

Referenced by ilLPTableBaseGUI\getExportMeta(), ilObjTest\randomSelectQuestions(), ilObjBlogGUI\renderList(), ilNoteGUI\showTargets(), and ilObjectTest\testSetGetLookup().

Here is the caller graph for this function:

◆ _lookupOwnerName()

ilObject::_lookupOwnerName ( $a_owner_id )

lookup owner name for owner id

Reimplemented in ilObject2.

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

        {
                global $lng;
 
                if ($a_owner_id != -1)
                {
                        if (ilObject::_exists($a_owner_id))
                        {
                                $owner = new ilObjUser($a_owner_id);
                        }
                }
 
                if (is_object($owner))
                {
                        $own_name = $owner->getFullname();
                }
                else
                {
                        $own_name = $lng->txt("unknown");
                }
 
                return $own_name;
        }

References $lng, $owner, and _exists().

Referenced by getOwnerName(), and ilObjectTest\testSetGetLookup().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _lookupTitle()

static ilObject::_lookupTitle ( $a_id )

static

lookup object title

Parameters

int $a_id object id

Reimplemented in ilObject2, and ilContainerReference.

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

        {
                global $ilObjDataCache;
 
                $tit = $ilObjDataCache->lookupTitle($a_id);
//echo "<br>LOOKING-$a_id-:$tit";               
                return $tit;
        }

Here is the caller graph for this function:

◆ _lookupType()

static ilObject::_lookupType	(	$a_id,
		$a_reference = `false`
	)

static

lookup object type

Parameters

int $a_id object id

Reimplemented in ilObject2.

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

        {
                global $ilObjDataCache;
 
                if($a_reference)
                {
                        return $ilObjDataCache->lookupType($ilObjDataCache->lookupObjId($a_id));
                }
                return $ilObjDataCache->lookupType($a_id);
        }

Here is the caller graph for this function:

◆ _prepareCloneSelection()

static ilObject::_prepareCloneSelection	(	$a_ref_ids,
		$new_type,
		$show_path = `true`
	)

static

Prepare copy wizard object selection.

@access public

Parameters

array int array of ref ids

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

        {
                global $ilDB,$lng,$objDefinition;
                
                $query = "SELECT obj_data.title obj_title,path_data.title path_title,child FROM tree ".
                        "JOIN object_reference obj_ref ON child = obj_ref.ref_id ".
                        "JOIN object_data obj_data ON obj_ref.obj_id = obj_data.obj_id ".
                        "JOIN object_reference path_ref ON parent = path_ref.ref_id ".
                        "JOIN object_data path_data ON path_ref.obj_id = path_data.obj_id ".
                        "WHERE ".$ilDB->in("child", $a_ref_ids, false, "integer")." ".
                        "ORDER BY obj_data.title ";
                $res = $ilDB->query($query);
                
                if (!$objDefinition->isPlugin($new_type))
                {
                        $options[0] = $lng->txt('obj_'.$new_type.'_select');
                }
                else
                {
                        include_once("./Services/Component/classes/class.ilPlugin.php");
                        $options[0] = ilPlugin::lookupTxt("rep_robj", $new_type, "obj_".$new_type."_select");
                }
 
                while($row = $ilDB->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 ? $options : array();
        }

References $ilDB, $lng, $options, $path, $query, $res, $row, $title, and ilPlugin\lookupTxt().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _resetDeletedDate()

ilObject::_resetDeletedDate ( $a_ref_id )

only called in ilObjectGUI::insertSavedNodes

Reimplemented in ilObject2.

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

        {
                global $ilDB;
                
                $query = "UPDATE object_reference SET deleted = ".$ilDB->quote(null,'timestamp').
                        " WHERE ref_id = ".$ilDB->quote($a_ref_id,'integer');
                $res = $ilDB->manipulate($query);
        }

References $ilDB, $query, and $res.

Referenced by ilTree\insertNode(), ilObjectTest\testObjectReference(), and ilObjectTest\testSetGetLookup().

Here is the caller graph for this function:

◆ _setDeletedDate()

ilObject::_setDeletedDate ( $a_ref_id )

only called in ilTree::saveSubTree

Reimplemented in ilObject2.

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

        {
                global $ilDB;
                
                $query = "UPDATE object_reference SET deleted= ".$ilDB->now().' '.
                        "WHERE ref_id = ".$ilDB->quote($a_ref_id,'integer');
                $res = $ilDB->manipulate($query);
        }

References $ilDB, $query, and $res.

Referenced by ilObjectTest\testObjectReference(), and ilObjectTest\testSetGetLookup().

Here is the caller graph for this function:

◆ _writeDescription()

ilObject::_writeDescription	(	$a_obj_id,
		$a_desc
	)

write description to db (static)

Parameters

int	$a_obj_id	object id
string	$a_desc	description @access public

Reimplemented in ilObject2.

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

        {
                global $ilDB,$objDefinition;
 
 
                $desc = ilUtil::shortenText($a_desc,self::DESC_LENGTH,true);
 
                $q = "UPDATE object_data ".
                        "SET ".
                        "description = ".$ilDB->quote($desc, "text").",".
                        "last_update = ".$ilDB->now()." ".
                        "WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer");
 
                $ilDB->manipulate($q);
 
                if($objDefinition->isRBACObject(ilObject::_lookupType($a_obj_id)))
                {
                        // Update long description
                        $res = $ilDB->query("SELECT * FROM object_description WHERE obj_id = ".
                                $ilDB->quote($a_obj_id,'integer'));
 
                        if($res->numRows())
                        {
                                $values = array(
                                        'description'   => array('clob',$a_desc)
                                        );
                                $ilDB->update('object_description',$values,array('obj_id' => array('integer',$a_obj_id)));
                        }
                        else
                        {
                                $values = array(
                                        'description'   => array('clob',$a_desc),
                                        'obj_id'                => array('integer',$a_obj_id));
                                $ilDB->insert('object_description',$values);
                        }
                }
        }

References $desc, $ilDB, $res, _lookupType(), and ilUtil\shortenText().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ _writeImportId()

ilObject::_writeImportId	(	$a_obj_id,
		$a_import_id
	)

write import id to db (static)

Parameters

int	$a_obj_id	object id
string	$a_import_id	import id @access public

Reimplemented in ilObject2.

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

        {
                global $ilDB;
 
                $q = "UPDATE object_data ".
                        "SET ".
                        "import_id = ".$ilDB->quote($a_import_id, "text").",".
                        "last_update = ".$ilDB->now()." ".
                        "WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer");
 
                $ilDB->manipulate($q);
        }

References $ilDB.

Referenced by ilAuthContainerECS\createUser(), ilCourseXMLParser\handlerBeginTag(), ilObjGlossaryGUI\importFileObject(), ilObjContentObject\importFromDirectory(), and ilGlossaryImporter\importXmlRepresentation().

Here is the caller graph for this function:

◆ _writeTitle()

ilObject::_writeTitle	(	$a_obj_id,
		$a_title
	)

write title to db (static)

Parameters

int	$a_obj_id	object id
string	$a_title	title @access public

Reimplemented in ilObject2.

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

        {
                global $ilDB;
 
                $q = "UPDATE object_data ".
                        "SET ".
                        "title = ".$ilDB->quote($a_title, "text").",".
                        "last_update = ".$ilDB->now()." ".
                        "WHERE obj_id = ".$ilDB->quote($a_obj_id, "integer");
 
                $ilDB->manipulate($q);
        }

References $ilDB.

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

Here is the caller graph for this function:

◆ appendCopyInfo()

ilObject::appendCopyInfo	(	$a_target_id,
		$a_copy_id
	)

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

@access public

Parameters

int copy_id

Reimplemented in ilObject2.

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

        {
                global $tree;
                
                include_once('Services/CopyWizard/classes/class.ilCopyWizardOptions.php');
                $cp_options = ilCopyWizardOptions::_getInstance($a_copy_id);
                if(!$cp_options->isRootNode($this->getRefId()))
                {
                        return $this->getTitle();
                }
                $nodes = $tree->getChilds($a_target_id);
                
                $title_unique = false;
                require_once 'Modules/File/classes/class.ilObjFileAccess.php';
                $numberOfCopy = 1;
                $handleExtension = ($this->getType() == "file"); // #14883
                $title = ilObjFileAccess::_appendNumberOfCopyToFilename($this->getTitle(), $numberOfCopy, $handleExtension);
                while(!$title_unique)
                {
                        $found = 0;
                        foreach($nodes as $node)
                        {
                                if(($title == $node['title']) and ($this->getType() == $node['type']))
                                {
                                        $found++;
                                }
                        }
                        if($found > 0)
                        {
                                $title = ilObjFileAccess::_appendNumberOfCopyToFilename($this->getTitle(), ++$numberOfCopy, $handleExtension);
                        }
                        else
                        {
                                break;
                        }
                }
                return $title;
        }       

References $title, ilObjFileAccess\_appendNumberOfCopyToFilename(), ilCopyWizardOptions\_getInstance(), getTitle(), and getType().

Referenced by cloneObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ applyDidacticTemplate()

ilObject::applyDidacticTemplate ( $a_tpl_id )

Apply template.

Parameters

int $a_tpl_id

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

        {
                if(!$a_tpl_id)
                {
                        return true;
                }
 
                include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateObjSettings.php';
                ilDidacticTemplateObjSettings::assignTemplate($this->getRefId(), $this->getId(), (int) $a_tpl_id);
 
                include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateActionFactory.php';
                foreach(ilDidacticTemplateActionFactory::getActionsByTemplateId($a_tpl_id) as $action)
                {
                        $action->setRefId($this->getRefId());
                        $action->apply();
                }
        }

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

Here is the call graph for this function:

◆ cloneDependencies()

ilObject::cloneDependencies	(	$a_target_id,
		$a_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.

@access public

Parameters

int	ref_id of target object
int	copy_id

Reimplemented in ilObjCategory, ilCourseStart, ilObjCourse, ilObjFolder, ilObjGroup, ilObjItemGroup, ilObjSession, ilObjWorkspaceFolder, ilContainer, and ilObject2.

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

        {
                include_once './Services/AccessControl/classes/class.ilConditionHandler.php';
                include_once './Services/CopyWizard/classes/class.ilCopyWizardOptions.php';
 
                $cwo = ilCopyWizardOptions::_getInstance($a_copy_id);
                $mappings = $cwo->getMappings();
 
                $conditions = ilConditionHandler::_getConditionsOfTarget($this->getRefId(), $this->getId());
                foreach($conditions as $con)
                {
                        if($mappings[$con['trigger_ref_id']])
                        {
                                $newCondition = new ilConditionHandler();
 
                                $target_obj = ilObject::_lookupObjId($a_target_id);
                                $target_typ = ilObject::_lookupType($target_obj);
 
                                $newCondition->setTargetRefId($a_target_id);
                                $newCondition->setTargetObjId($target_obj);
                                $newCondition->setTargetType($target_typ);
 
                                $trigger_ref = $mappings[$con['trigger_ref_id']];
                                $trigger_obj = ilObject::_lookupObjId($trigger_ref);
                                $trigger_typ = ilObject::_lookupType($trigger_obj);
 
                                $newCondition->setTriggerRefId($trigger_ref);
                                $newCondition->setTriggerObjId($trigger_obj);
                                $newCondition->setTriggerType($trigger_typ);
                                $newCondition->setOperator($con['operator']);
                                $newCondition->setValue($con['value']);
                                $newCondition->setReferenceHandlingType($con['ref_handling']);
                                $newCondition->setObligatory($con['obligatory']);
                                $newCondition->setHiddenStatus(ilConditionHandler::lookupHiddenStatusByTarget($this->getRefId()));
                                $newCondition->storeCondition();
                        }
                }
 
                include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateObjSettings.php';
                $tpl_id = ilDidacticTemplateObjSettings::lookupTemplateId($this->getRefId());
                if($tpl_id)
                {
                        include_once './Services/Object/classes/class.ilObjectFactory.php';
                        $factory = new ilObjectFactory();
                        $obj = $factory->getInstanceByRefId($a_target_id, FALSE);
                        if($obj instanceof ilObject)
                        {
                                $obj->applyDidacticTemplate($tpl_id);
                        }
                }
                return true;
        }

References ilConditionHandler\_getConditionsOfTarget(), ilCopyWizardOptions\_getInstance(), _lookupObjId(), _lookupType(), getId(), getRefId(), ilConditionHandler\lookupHiddenStatusByTarget(), and ilDidacticTemplateObjSettings\lookupTemplateId().

Here is the call graph for this function:

◆ cloneMetaData()

ilObject::cloneMetaData ( $target_obj )

Copy meta data.

@access public

Parameters

object target object

Reimplemented in ilObject2.

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

        {
                include_once "./Services/MetaData/classes/class.ilMD.php";
                $md = new ilMD($this->getId(),0,$this->getType());
                $md->cloneMD($target_obj->getId(),0,$target_obj->getType());
                return true;            
        }

References getId(), and getType().

Referenced by ilObjCourse\cloneObject(), ilObjGlossary\cloneObject(), ilObjFileBasedLM\cloneObject(), ilObjContentObject\cloneObject(), ilObjSAHSLearningModule\cloneObject(), ilObjSurvey\cloneObject(), and ilObjLinkResource\cloneObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ cloneObject()

ilObject::cloneObject	(	$a_target_id,
		$a_copy_id = `0`,
		$a_omit_tree = `false`
	)

Clone object permissions, put in tree ...

@access public

Parameters

int	target id
int	copy id for class.ilCopyWizardOptions()

Returns: object new object

Reimplemented in ilObjBookingPool, ilObjChatroom, and ilObject2.

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

        {
                global $objDefinition,$ilUser,$rbacadmin, $ilDB;
                
                $location = $objDefinition->getLocation($this->getType());
                $class_name = ('ilObj'.$objDefinition->getClassName($this->getType()));
                
                if(!$a_omit_tree)
                {
                        $title = $this->appendCopyInfo($a_target_id,$a_copy_id);
                }
                else
                {
                        $title = $this->getTitle();
                }
 
                // create instance
                include_once($location."/class.".$class_name.".php");
                $new_obj = new $class_name(0, false);
                $new_obj->setOwner($ilUser->getId());
                $new_obj->setTitle($title);
                $new_obj->setDescription($this->getLongDescription());
                $new_obj->setType($this->getType());
                // Choose upload mode to avoid creation of additional settings, db entries ...
                $new_obj->create(true);
                
                if(!$a_omit_tree)
                {
                        $new_obj->createReference();
                        $new_obj->putInTree($a_target_id);
                        $new_obj->setPermissions($a_target_id);
 
                        // when copying from personal workspace we have no current ref id
                        if($this->getRefId())
                        {
                                // copy local roles
                                $rbacadmin->copyLocalRoles($this->getRefId(),$new_obj->getRefId());
                        }
                }
                
                include_once('./Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php');
                ilAdvancedMDValues::_cloneValues($this->getId(),$new_obj->getId());
 
                // BEGIN WebDAV: Clone WebDAV properties
                $query = "INSERT INTO dav_property (obj_id,node_id,ns,name,value) ".
                        "SELECT ".$ilDB->quote($new_obj->getId(),'integer').",node_id,ns,name,value ".
                        "FROM dav_property ".
                        "WHERE obj_id = ".$ilDB->quote($this->getId(),'integer');
                $res = $ilDB->manipulate($query);
                // END WebDAV: Clone WebDAV properties
                
                return $new_obj;
        }

References $ilDB, $ilUser, $location, $query, $res, $title, ilAdvancedMDValues\_cloneValues(), appendCopyInfo(), getId(), getLongDescription(), getRefId(), getTitle(), and getType().

Here is the call graph for this function:

◆ collectDeletionDependencies()

static ilObject::collectDeletionDependencies	(	&	$deps,
			$a_ref_id,
			$a_obj_id,
			$a_type,
			$a_depth = `0`
	)

static

Collect deletion dependencies.

E.g.

Parameters

return

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

        {
                global $objDefinition, $tree;
 
                if ($a_depth == 0)
                {
                        $deps["dep"] = array();
                }
                
                $deps["del_ids"][$a_obj_id] = $a_obj_id;
                
                if (!$objDefinition->isPluginTypeName($a_type))
                {
                        $class_name = "ilObj".$objDefinition->getClassName($a_type);            
                        $location = $objDefinition->getLocation($a_type);
                        include_once($location."/class.".$class_name.".php");
                        $odeps = call_user_func(array($class_name, "getDeletionDependencies"), $a_obj_id);
                        if (is_array($odeps))
                        {
                                foreach ($odeps as $id => $message)
                                {
                                        $deps["dep"][$id][$a_obj_id][] = $message;
                                }
                        }
                        
                        // get deletion dependency of childs
                        foreach ($tree->getChilds($a_ref_id) as $c)
                        {
                                ilObject::collectDeletionDependencies($deps, $c["child"], $c["obj_id"], $c["type"], $a_depth + 1);
                        }
                }
                
                // delete all dependencies to objects that will be deleted, too
                if ($a_depth == 0)
                {
                        foreach ($deps["del_ids"] as $obj_id)
                        {
                                unset($deps["dep"][$obj_id]);
                        }
                        $deps = $deps["dep"];
                }               
        }

References $id, $location, and collectDeletionDependencies().

Referenced by collectDeletionDependencies(), and ilRepUtilGUI\showDeleteConfirmation().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ countReferences()

ilObject::countReferences ( )

count references of object

@access public

Returns: integer number of references for this object

Reimplemented in ilObject2.

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

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

References $ilDB, $query, $res, and $row.

Referenced by delete().

Here is the caller graph for this function:

◆ create()

ilObject::create ( )

create

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

@access public

Returns: integer object id

Reimplemented in ilObjBookingPool, ilObjForum, ilObjGroup, ilObjFileBasedLM, ilObjMediaCast, ilObjMediaPool, ilObjOrgUnit, ilObjSession, ilObjRole, shibUser, ilContainer, ilObjNotificationAdmin, ilObjDiskQuotaSettings, and ilObjFileAccessSettings.

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

        {
                global $ilDB, $log,$ilUser,$objDefinition;
 
                if (!isset($this->type))
                {
                        $message = get_class($this)."::create(): No object type given!";
                        $this->ilias->raiseError($message,$this->ilias->error_obj->WARNING);
                }
 
                // write log entry
                $log->write("ilObject::create(), start");
 
                $this->title = ilUtil::shortenText($this->getTitle(), $this->max_title, $this->add_dots);
                $this->desc = ilUtil::shortenText($this->getDescription(), $this->max_desc, $this->add_dots);
                
                // determine owner
                if ($this->getOwner() > 0)
                {
                        $owner = $this->getOwner();
                }
                elseif(is_object($ilUser))
                {
                        $owner = $ilUser->getId();
                }
                else
                {
                        $owner = 0;
                }
                $this->id = $ilDB->nextId("object_data");
                $q = "INSERT INTO object_data ".
                         "(obj_id,type,title,description,owner,create_date,last_update,import_id) ".
                         "VALUES ".
                         "(".
                         $ilDB->quote($this->id, "integer").",".
                         $ilDB->quote($this->type, "text").",".
                         $ilDB->quote($this->getTitle(), "text").",".
                         $ilDB->quote($this->getDescription(), "text").",".
                         $ilDB->quote($owner, "integer").",".
                         $ilDB->now().",".
                         $ilDB->now().",".
                         $ilDB->quote($this->getImportId(), "text").")";
 
                $ilDB->manipulate($q);
 
                //$this->id = $ilDB->getLastInsertId();
 
                
                // Save long form of description if is rbac object
                if($objDefinition->isRBACObject($this->getType()))
                {
                        $values = array(
                                'obj_id'                => array('integer',$this->id),
                                'description'   => array('clob', $this->getLongDescription()));
//var_dump($values);
                        $ilDB->insert('object_description',$values);
                }
                
 
                // 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();
                $q = "SELECT last_update, create_date FROM object_data".
                         " WHERE obj_id = ".$ilDB->quote($this->id, "integer");
                $obj_set = $ilDB->query($q);
                $obj_rec = $ilDB->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
                $log->write("ilObject::create(), finished, obj_id: ".$this->id.", type: ".
                        $this->type.", title: ".$this->getTitle());
 
                $GLOBALS['ilAppEventHandler']->raise(
                        'Services/Object',
                        'create',
                        array('obj_id' => $this->id,'obj_type' => $this->type));
 
                return $this->id;
        }

References $GLOBALS, $id, $ilDB, $ilUser, $log, $owner, getDescription(), getImportId(), getLongDescription(), getOwner(), getTitle(), setOwner(), and ilUtil\shortenText().

Referenced by ilRemoteObjectBase\createFromECSEContent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ createMetaData()

ilObject::createMetaData ( )

create meta data entry

Reimplemented in ilObjSurvey, ilObjTest, ilObjMediaObject, and ilObject2.

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

        {
                include_once 'Services/MetaData/classes/class.ilMDCreator.php';
 
                global $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'));
                $md_creator->setLanguage($ilUser->getPref('language'));
                $md_creator->create();
 
                return true;
        }

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

Referenced by ilObjContentObject\create(), ilObjCourse\create(), ilObjGlossary\create(), ilObjSurveyQuestionPool\create(), ilObjQuestionPool\create(), ilObjLinkResource\create(), ilObjSAHSLearningModule\create(), ilObjFileBasedLM\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

@access public

Returns: integer reference_id of object

Reimplemented in ilObjSurvey, ilObjQuestionPool, ilObjMediaObject, ilObject2, and ilObjStyleSheet.

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

        {
                global $ilDB;
 
                if (!isset($this->id))
                {
                        $message = "ilObject::createNewReference(): No obj_id given!";
                        $this->raiseError($message,$this->ilias->error_obj->WARNING);
                }
 
                $next_id = $ilDB->nextId('object_reference');
                $query = "INSERT INTO object_reference ".
                         "(ref_id, obj_id) VALUES (".$ilDB->quote($next_id,'integer').','.$ilDB->quote($this->id ,'integer').")";
                $this->ilias->db->query($query);
 
                $this->ref_id = $next_id;
                $this->referenced = true;
 
                return $this->ref_id;
        }

References $ilDB, $query, and $ref_id.

Referenced by ilObject2GUI\putObjectInTree(), and ilObjectGUI\putObjectInTree().

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

@access public

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

Reimplemented in ilObjBookingPool, ilObjCategory, ilObjCourse, ilObjCourseAdministration, ilObjExercise, ilObjExerciseAdministration, ilObjExternalFeed, ilObjGlossary, ilObjGroup, ilObjGroupAdministration, ilObjFileBasedLM, ilObjiLincClassroom, ilObjiLincCourse, ilObjContentObject, ilObjLearningResourcesSettings, ilObjMediaCast, ilObjMediaCastSettings, ilObjMediaPool, ilObjOrgUnit, ilObjRootFolder, ilObjAICCLearningModule, ilObjSAHSLearningModule, ilObjSession, ilObjSurvey, ilObjSurveyAdministration, ilObjSurveyQuestionPool, ilObjSystemFolder, ilObjAssessmentFolder, ilObjTest, ilObjQuestionPool, ilObjLinkResource, ilObjWebResourceAdministration, ilObjWiki, ilObjRole, ilObjRoleFolder, ilObjRoleTemplate, ilObjAccessibilitySettings, ilObjExternalToolsSettings, ilObjRecoveryFolder, ilObjAdvancedEditing, ilObjAuthSettings, ilObjComponentSettings, ilContainerReference, ilObjMediaObject, ilObjMediaObjectsSettings, ilObjNewsSettings, ilObjNotificationAdmin, ilObject2, ilObjObjectFolder, ilObjPersonalDesktopSettings, ilObjRepositorySettings, ilObjSkillManagement, ilObjStyleSettings, ilObjStyleSheet, ilObjTaggingSettings, ilObjTaxonomyAdministration, ilObjUser, and ilObjUserFolder.

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

        {
                global $rbacadmin, $log, $ilDB;
 
                $remove = false;
 
                // delete object_data entry
                if ((!$this->referenced) || ($this->countReferences() == 1))
                {
                        // check type match
                        $db_type = ilObject::_lookupType($this->getId());
                        if ($this->type != $db_type)
                        {
                                $message = "ilObject::delete(): Type mismatch. Object with obj_id: ".$this->id." ".
                                        "was instantiated by type '".$this->type."'. DB type is: ".$db_type;
                                        
                                // write log entry
                                $log->write($message);
                                        
                                // raise error
                                $this->ilias->raiseError("ilObject::delete(): Type mismatch. (".$this->type."/".$this->id.")",$this->ilias->error_obj->WARNING);
                        }
                        
                        // delete entry in object_data
                        $q = "DELETE FROM object_data ".
                                "WHERE obj_id = ".$ilDB->quote($this->getId(), "integer");
                        $ilDB->manipulate($q);
 
                        // delete long description
                        $query = "DELETE FROM object_description WHERE obj_id = ".
                                $ilDB->quote($this->getId(), "integer");
                        $ilDB->manipulate($query);
 
                        // write log entry
                        $log->write("ilObject::delete(), deleted object, obj_id: ".$this->getId().", type: ".
                                $this->getType().", title: ".$this->getTitle());
                        
                        // remove news
                        include_once("./Services/News/classes/class.ilNewsItem.php");
                        $news_item = new ilNewsItem();
                        $news_item->deleteNewsOfContext($this->getId(), $this->getType());
                        include_once("./Services/Block/classes/class.ilBlockSetting.php");
                        ilBlockSetting::_deleteSettingsOfBlock($this->getId(), "news");
 
                        include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateObjSettings.php';
                        ilDidacticTemplateObjSettings::deleteByObjId($this->getId());
 
                        /* remove notes (see infoscreen gui)
                           as they can be seen as personal data we are keeping them for now
                        include_once("Services/Notes/classes/class.ilNote.php");
                        foreach(array(IL_NOTE_PRIVATE, IL_NOTE_PUBLIC) as $note_type)
                        {
                                foreach(ilNote::_getNotesOfObject($this->id, 0, $this->type, $note_type) as $note)
                                {
                                        $note->delete();
                                }
                        }
                    */
                                                
                        // BEGIN WebDAV: Delete WebDAV properties
                        $query = "DELETE FROM dav_property ".
                                "WHERE obj_id = ".$ilDB->quote($this->getId(),'integer');
                        $res = $ilDB->manipulate($query);
                        // END WebDAV: Delete WebDAV properties
 
                        include_once './Services/WebServices/ECS/classes/class.ilECSImport.php';
                        ilECSImport::_deleteByObjId($this->getId());
                        
                        include_once("Services/AdvancedMetaData/classes/class.ilAdvancedMDValues.php");
                        ilAdvancedMDValues::_deleteByObjId($this->getId());
 
                        $remove = true;
                }
                else
                {
                        // write log entry
                        $log->write("ilObject::delete(), object not deleted, number of references: ".
                                $this->countReferences().", obj_id: ".$this->getId().", type: ".
                                $this->getType().", title: ".$this->getTitle());
                }
 
                // delete object_reference entry
                if ($this->referenced)
                {                       
                        include_once "Services/Object/classes/class.ilObjectActivation.php";
                        ilObjectActivation::deleteAllEntries($this->getRefId());
                        
                        // delete entry in object_reference
                        $query = "DELETE FROM object_reference ".
                                "WHERE ref_id = ".$ilDB->quote($this->getRefId(),'integer');
                        $res = $ilDB->manipulate($query);
                        
                        // write log entry
                        $log->write("ilObject::delete(), reference deleted, ref_id: ".$this->getRefId().
                                ", obj_id: ".$this->getId().", type: ".
                                $this->getType().", title: ".$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
                        $rbacadmin->revokePermission($this->getRefId(),0,false);
 
                        include_once "Services/AccessControl/classes/class.ilRbacLog.php";
                        ilRbacLog::delete($this->getRefId());
 
                        // Remove applied didactic template setting
                        include_once './Services/DidacticTemplate/classes/class.ilDidacticTemplateObjSettings.php';
                        ilDidacticTemplateObjSettings::deleteByRefId($this->getRefId());
 
                        // Remove desktop items
                        ilUtil::removeItemFromDesktops($this->getRefId());
                }
 
                // remove conditions
                if ($this->referenced)
                {
                        $ch =& new ilConditionHandler();
                        $ch->delete($this->getRefId());
                        unset($ch);
                }
 
                return $remove;
        }

References $ilDB, $log, $query, $res, ilAdvancedMDValues\_deleteByObjId(), ilECSImport\_deleteByObjId(), ilBlockSetting\_deleteSettingsOfBlock(), _lookupType(), countReferences(), ilRbacLog\delete(), ilObjectActivation\deleteAllEntries(), ilDidacticTemplateObjSettings\deleteByObjId(), ilDidacticTemplateObjSettings\deleteByRefId(), getId(), getRefId(), getTitle(), getType(), and ilUtil\removeItemFromDesktops().

Here is the call graph for this function:

◆ deleteMetaData()

ilObject::deleteMetaData ( )

delete meta data entry

Reimplemented in ilObjMediaObject, and ilObject2.

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

        {
                // Delete meta data
                include_once('Services/MetaData/classes/class.ilMD.php');
                $md = new ilMD($this->getId(), 0, $this->getType());
                $md->deleteAll();
        }

References getId(), and getType().

Referenced by ilObjCourse\delete(), ilObjGlossary\delete(), ilObjFileBasedLM\delete(), ilObjContentObject\delete(), ilObjAICCLearningModule\delete(), ilObjSAHSLearningModule\delete(), ilObjSurvey\delete(), ilObjSurveyQuestionPool\delete(), ilObjTest\delete(), ilObjQuestionPool\delete(), and ilObjLinkResource\delete().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllOwnedRepositoryObjects()

static ilObject::getAllOwnedRepositoryObjects ( $a_user_id )

static

Get all ids of objects user owns.

Parameters

int $a_user_id

Returns: array

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

        {
                global $ilDB, $objDefinition;
                                
                $all = array();
                
                // restrict to repository
                $types = array_keys($objDefinition->getSubObjectsRecursively("root"));  
                        
                $sql = "SELECT od.obj_id,od.type,od.title FROM object_data od";
                
                if($a_user_id)
                {
                        $sql .= " WHERE od.owner = ".$ilDB->quote($a_user_id, "integer");                               
                }
                else
                {
                        $sql .= " LEFT JOIN usr_data ud ON (ud.usr_id = od.owner)".
                                " WHERE (od.owner < ".$ilDB->quote(1, "integer").
                                " OR od.owner IS NULL OR ud.login IS NULL)".
                                " AND od.owner <> ".$ilDB->quote(-1, "integer");
                }
                
                $sql .= " AND ".$ilDB->in("od.type", $types, "", "text");
                        
                $res = $ilDB->query($sql);
                while($row = $ilDB->fetchAssoc($res))
                {
                        $all[$row["type"]][$row["obj_id"]] = $row["title"];
                }
                
                return $all;
        }

References $ilDB, $res, and $row.

Referenced by ilObjectOwnershipManagementGUI\listObjects().

Here is the caller graph for this function:

◆ getCreateDate()

ilObject::getCreateDate ( )

get create date @access public

Returns: string creation date

Reimplemented in ilObject2.

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

        {
                return $this->create_date;
        }

References $create_date.

◆ getDeletionDependencies()

static ilObject::getDeletionDependencies ( $a_obj_id )

static

Get deletion dependencies.

Reimplemented in ilObjGlossary.

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

        {
                return false;   
        }

◆ getDescription()

ilObject::getDescription ( )

get object description

@access public

Returns: string object description

Reimplemented in ilObjGlossary, ilObjContentObject, ilObjQuestionPool, ilObjMediaObject, and ilObject2.

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

        {
                return $this->desc;
        }

References $desc.

Referenced by ilObjCategoryGUI\afterSave(), ilObjFileBasedLM\cloneObject(), ilObjMediaPool\cloneObject(), ilObjSAHSLearningModule\cloneObject(), create(), ilObjCourseVerification\createFromCourse(), ilObjExerciseVerification\createFromExercise(), ilObjSCORMVerification\createFromSCORMLM(), ilObjTestVerification\createFromTest(), ilObjStyleSheet\getXML(), ilObjStyleSheet\ilClone(), ilObjRoleGUI\readRoleProperties(), ilObjSurvey\toXML(), ilObjTest\toXML(), ilObjiLincClassroom\update(), and update().

Here is the caller graph for this function:

◆ getDiskUsage()

ilObject::getDiskUsage ( )

Gets the disk usage of the object in bytes.

Returns null, if the object does not use disk space at all.

The implementation of class ilObject always returns null.
Subclasses which use disk space can override this method to return a
non-null value.

@access     public
@return     integer         the disk usage in bytes or null

Reimplemented in ilObjFile, ilObjForum, ilObjFileBasedLM, ilObjMediaCast, and ilObjSAHSLearningModule.

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

        {
                return null;
        }

◆ getHTMLDirectory()

ilObject::getHTMLDirectory ( )

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

        {
                return false;
        }

◆ getId()

ilObject::getId ( )

get object id @access public

Returns: integer object id

Reimplemented in ilCourseStart, ilObjMediaObject, and ilObject2.

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

        {
                return $this->id;
        }

References $id.

Here is the caller graph for this function:

◆ getImportId()

ilObject::getImportId ( )

get import id

@access public

Returns: string import id

Reimplemented in ilObjContentObject, ilObjMediaObject, and ilObject2.

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

        {
                return $this->import_id;
        }

References $import_id.

Referenced by create(), and update().

Here is the caller graph for this function:

◆ getLastUpdateDate()

ilObject::getLastUpdateDate ( )

get last update date @access public

Returns: string date of last update

Reimplemented in ilObject2.

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

        {
                return $this->last_update;
        }

References $last_update.

◆ getLongDescription()

ilObject::getLongDescription ( )

get object long description (stored in object_description)

@access public

Returns: string object description

Reimplemented in ilObjOrgUnit, ilObjLanguageExt, and ilObject2.

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

        {
                return strlen($this->long_desc) ? $this->long_desc : $this->desc;
        }

References $desc.

Referenced by cloneObject(), create(), createMetaData(), ilObjCourse\prepareAppointments(), ilObjGroup\prepareAppointments(), ilObjSession\prepareCalendarAppointments(), update(), and updateMetaData().

Here is the caller graph for this function:

◆ getLongDescriptions()

static ilObject::getLongDescriptions ( array $a_obj_ids )

static

Get long description data.

Parameters

array $a_obj_ids

Returns: array

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

        {
                global $ilDB;
                
                $res = $ilDB->query("SELECT * FROM object_description".
                        " WHERE ".$ilDB->in("obj_id", $a_obj_ids, "", "integer"));
                $all = array();
                while($row = $ilDB->fetchAssoc($res))
                {
                        $all[$row["obj_id"]] = $row["description"];
                }
                return $all;
        }

References $ilDB, $res, and $row.

Referenced by ilContainer\getCompleteDescriptions().

Here is the caller graph for this function:

◆ getOwner()

ilObject::getOwner ( )

get object owner

@access public

Returns: integer owner id

Reimplemented in ilObject2.

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

        {
                return $this->owner;
        }

References $owner.

Referenced by create(), getOwnerName(), ilObjTest\sendAdvancedNotification(), ilObjSurvey\sendCodes(), ilObjTest\sendSimpleNotification(), and updateOwner().

Here is the caller graph for this function:

◆ getOwnerName()

ilObject::getOwnerName ( )

Reimplemented in ilObject2.

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

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

References _lookupOwnerName(), and getOwner().

Here is the call graph for this function:

◆ getPresentationTitle()

ilObject::getPresentationTitle ( )

get presentation title Normally same as title Overwritten for sessions

@access public

Parameters

return

Reimplemented in ilObjSession, ilObjRole, ilContainerReference, and ilObject2.

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

        {
                return $this->getTitle();
        }

References getTitle().

Here is the call graph for this function:

◆ getRefId()

ilObject::getRefId ( )

get reference id @access public

Returns: integer reference id

Reimplemented in ilCourseStart, ilObjMediaObject, ilObject2, and ilObjStyleSheet.

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

        {
                return $this->ref_id;
        }

References $ref_id.

Here is the caller graph for this function:

◆ getTitle()

ilObject::getTitle ( )

get object title @access public

Returns: string object title

Reimplemented in ilObjGlossary, ilObjContentObject, ilObjOrgUnit, ilObjSurveyQuestionPool, ilObjQuestionPool, ilObjMediaObject, and ilObject2.

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

        {
                return $this->title;
        }

References $title.

Referenced by ilObjExercise\__formatSubject(), ilObjCategoryGUI\afterSave(), appendCopyInfo(), ilObjFileBasedLM\cloneObject(), ilObjMediaPool\cloneObject(), ilObjSAHSLearningModule\cloneObject(), ilObjWiki\cloneObject(), cloneObject(), create(), ilObjCourseVerification\createFromCourse(), ilObjExerciseVerification\createFromExercise(), ilObjSCORMVerification\createFromSCORMLM(), ilObjTestVerification\createFromTest(), createMetaData(), delete(), ilObjTest\deliverPDFfromFO(), ilObjTest\deliverPDFfromHTML(), ilObjFolder\downloadFolder(), ilObjExercise\exportGradesExcel(), ilObjSCORM2004LearningModule\exportHTML(), ilObjSCORMLearningModule\exportSelected(), ilObjRoleTemplate\getFilterOfInternalTemplate(), ilObjSession\getPresentationTitle(), ilObjRole\getPresentationTitle(), ilContainerReference\getPresentationTitle(), getPresentationTitle(), ilObjStyleSheet\getXML(), ilObjStyleSheet\ilClone(), ilObjSurvey\isComplete(), ilObjRoleTemplate\isInternalTemplate(), ilObjCourse\prepareAppointments(), ilObjGroup\prepareAppointments(), ilObjSession\prepareCalendarAppointments(), putInTree(), ilObjRoleGUI\readRoleProperties(), ilObjTest\sendAdvancedNotification(), ilObjTest\sendSimpleNotification(), ilObjSurvey\sendTutorNotification(), ilObjSurvey\sentReminder(), ilObjSurvey\toXML(), ilObjiLincClassroom\update(), update(), updateMetaData(), ilObjCourse\validate(), ilObjGroup\validate(), and ilObjRole\validate().

Here is the caller graph for this function:

◆ getType()

ilObject::getType ( )

get object type @access public

Returns: string object type

Reimplemented in ilObject2.

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

        {
                return $this->type;
        }

References $type.

Here is the caller graph for this function:

◆ getUntranslatedTitle()

ilObject::getUntranslatedTitle ( )

get untranslated object title @access public

Returns: string object title

Reimplemented in ilObject2.

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

        {
                return $this->untranslatedTitle;
        }

References $untranslatedTitle.

◆ getXMLZip()

ilObject::getXMLZip ( )

Reimplemented in ilObjFile, ilObjGlossary, ilObjContentObject, ilObjDlBook, and ilObjTest.

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

        {
                return false;
        }

◆ hasAutoRating()

static ilObject::hasAutoRating	(	$a_type,
		$a_ref_id
	)

static

Check if auto rating is active for parent group/course.

Parameters

string	$a_type
int	$a_ref_id

Returns: bool

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

        {
                global $tree;
                
                if(!$a_ref_id ||
                        !in_array($a_type, array("file", "lm", "wiki")))
                {
                        return false;
                }
 
                // find parent container
                $parent_ref_id = $tree->checkForParentType($a_ref_id, "grp");
                if(!$parent_ref_id)
                {                                       
                        $parent_ref_id = $tree->checkForParentType($a_ref_id, "crs");
                }                               
                if($parent_ref_id)
                {
                        include_once './Services/Object/classes/class.ilObjectServiceSettingsGUI.php';
                        
                        // get auto rate setting
                        $parent_obj_id = ilObject::_lookupObjId($parent_ref_id);                
                        return ilContainer::_lookupContainerSetting(
                                $parent_obj_id,
                                ilObjectServiceSettingsGUI::AUTO_RATING_NEW_OBJECTS,
                                false
                        );
                }
                return false;
        }       

References ilContainer\_lookupContainerSetting(), _lookupObjId(), and ilObjectServiceSettingsGUI\AUTO_RATING_NEW_OBJECTS.

Referenced by ilObjWikiGUI\getSettingsFormValues(), and ilObjectGUI\handleAutoRating().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ ilObject()

ilObject::ilObject	(	$a_id = `0`,
		$a_reference = `true`
	)

Constructor @access public.

Parameters

integer	reference_id or object_id
boolean	treat the id as reference_id (true) or object_id (false)

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

        {
                global $ilias, $lng, $ilBench;
 
                $ilBench->start("Core", "ilObject_Constructor");
 
                if (DEBUG)
                {
                        echo "<br/><font color=\"red\">type(".$this->type.") id(".$a_id.") referenced(".$a_reference.")</font>";
                }
 
                $this->ilias =& $ilias;
                $this->lng =& $lng;
 
                $this->max_title = self::TITLE_LENGTH;
                $this->max_desc = self::DESC_LENGTH;
                $this->add_dots = true;
 
                $this->referenced = $a_reference;
                $this->call_by_reference = $a_reference;
 
                if ($a_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 = $a_id;
                }
                else
                {
                        $this->id = $a_id;
                }
                // read object data
                if ($a_id != 0)
                {
                        $this->read();
                }
 
                $ilBench->stop("Core", "ilObject_Constructor");
        }

References $ilBench, $ilias, $lng, DEBUG, DESC_LENGTH, read(), and TITLE_LENGTH.

Referenced by ilObjBibliographicAdmin\__construct(), ilObjBlogAdministration\__construct(), ilObjBookingPool\__construct(), ilObjChatroom\__construct(), ilObjChatroomAdmin\__construct(), ilObjGroup\__construct(), ilObjPortfolioAdministration\__construct(), ilObjTest\__construct(), ilObjCalendarSettings\__construct(), ilObjObjectTemplateAdministration\__construct(), ilObjNotificationAdmin\__construct(), ilObjPaymentSettings\__construct(), ilObjECSSettings\__construct(), ilObjAccessibilitySettings\ilObjAccessibilitySettings(), ilObjAdvancedEditing\ilObjAdvancedEditing(), ilObjAssessmentFolder\ilObjAssessmentFolder(), ilObjAuthSettings\ilObjAuthSettings(), ilObjCertificateSettings\ilObjCertificateSettings(), ilObjComponentSettings\ilObjComponentSettings(), ilObjContentObject\ilObjContentObject(), ilObjDiskQuotaSettings\ilObjDiskQuotaSettings(), ilObjExercise\ilObjExercise(), ilObjExternalFeed\ilObjExternalFeed(), ilObjExternalToolsSettings\ilObjExternalToolsSettings(), ilObjFileAccessSettings\ilObjFileAccessSettings(), ilObjFileBasedLM\ilObjFileBasedLM(), ilObjGlossary\ilObjGlossary(), ilObjiLincCourse\ilObjiLincCourse(), ilObjLanguage\ilObjLanguage(), ilObjLanguageFolder\ilObjLanguageFolder(), ilObjLearningResourcesSettings\ilObjLearningResourcesSettings(), ilObjMDSettings\ilObjMDSettings(), ilObjMediaCast\ilObjMediaCast(), ilObjMediaCastSettings\ilObjMediaCastSettings(), ilObjMediaObjectsSettings\ilObjMediaObjectsSettings(), ilObjMediaPool\ilObjMediaPool(), ilObjNewsSettings\ilObjNewsSettings(), ilObjNull\ilObjNull(), ilObjObjectFolder\ilObjObjectFolder(), ilObjPersonalDesktopSettings\ilObjPersonalDesktopSettings(), ilObjQuestionPool\ilObjQuestionPool(), ilObjRecoveryFolder\ilObjRecoveryFolder(), ilObjRole\ilObjRole(), ilObjRoleFolder\ilObjRoleFolder(), ilObjRoleTemplate\ilObjRoleTemplate(), ilObjRootFolder\ilObjRootFolder(), ilObjSearchSettings\ilObjSearchSettings(), ilObjSkillManagement\ilObjSkillManagement(), ilObjStyleSettings\ilObjStyleSettings(), ilObjSurveyAdministration\ilObjSurveyAdministration(), ilObjSurveyQuestionPool\ilObjSurveyQuestionPool(), ilObjSystemFolder\ilObjSystemFolder(), ilObjTaggingSettings\ilObjTaggingSettings(), ilObjTypeDefinition\ilObjTypeDefinition(), ilObjUserFolder\ilObjUserFolder(), ilObjUserTracking\ilObjUserTracking(), and ilObjWiki\ilObjWiki().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initDefaultRoles()

ilObject::initDefaultRoles ( )

init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) @access public

Returns: array empty array

Reimplemented in ilObjBlog, ilObjChatroom, ilObjCourse, ilObjForum, ilObjGroup, ilObjOrgUnit, and ilObject2.

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

        {
                return array();
        }

Referenced by setPermissions().

Here is the caller graph for this function:

◆ isUserRegistered()

ilObject::isUserRegistered ( $a_user_id = 0 )

Reimplemented in ilObject2.

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

        {
                return false;
        }

◆ MDUpdateListener()

ilObject::MDUpdateListener ( $a_element )

Meta data 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.

Parameters

string $a_element

Reimplemented in ilObjCourse, ilObjLinkResource, ilObjMediaObject, and ilObject2.

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

        {
                include_once 'Services/MetaData/classes/class.ilMD.php';
 
                $GLOBALS['ilAppEventHandler']->raise(
                        'Services/Object',
                        'update',
                        array('obj_id' => $this->getId(),
                                'obj_type' => $this->getType(),
                                'ref_id' => $this->getRefId()));
 
                switch($a_element)
                {
                        case 'General':
 
                                // Update Title and description
                                $md = new ilMD($this->getId(),0, $this->getType());
                                if(!is_object($md_gen = $md->getGeneral()))
                                {
                                        return false;
                                }
                                $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();
                                break;
 
                        default:
                }
                
                return true;
        }

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

Referenced by ilObjContentObject\importFromDirectory().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ notify()

ilObject::notify	(	$a_event,
		$a_ref_id,
		$a_parent_non_rbac_id,
		$a_node_id,
		$a_params = `0`
	)

notifys an object about an event occured Based on the event passed, each object may decide how it reacts.

TODO: add optional array to pass parameters

@access public

Parameters

string	event
integer	reference id of object where the event occured
integer	reference id of node in the tree which is actually notified
array	passes optional parameters if required

Returns: boolean

Reimplemented in ilObjBookingPool, ilObjExternalFeed, ilObjGlossary, ilObjGroup, ilObjFileBasedLM, ilObjiLincCourse, ilObjContentObject, ilObjLearningResourcesSettings, ilObjMediaCast, ilObjMediaCastSettings, ilObjMediaPool, ilObjRootFolder, ilObjSAHSLearningModule, ilObjSurvey, ilObjSurveyAdministration, ilObjSurveyQuestionPool, ilObjAssessmentFolder, ilObjTest, ilObjQuestionPool, ilObjWiki, ilObjWorkspaceRootFolder, ilObjAccessibilitySettings, ilObjExternalToolsSettings, ilObjRecoveryFolder, ilObjAdvancedEditing, ilObjAuthSettings, ilObjComponentSettings, ilObjMediaObjectsSettings, ilObjNewsSettings, ilObject2, ilObjPersonalDesktopSettings, ilObjSkillManagement, ilObjStyleSettings, and ilObjTaggingSettings.

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

        { 
                global $tree;
                
                $parent_id = (int) $tree->getParentId($a_node_id);
                
                if ($parent_id != 0)
                {
                        $obj_data =& $this->ilias->obj_factory->getInstanceByRefId($a_node_id);
                        $obj_data->notify($a_event,$a_ref_id,$a_parent_non_rbac_id,$parent_id,$a_params);
                }
                                
                return true;
        }

Referenced by ilObjContentObjectGUI\afterSave().

Here is the caller graph for this function:

◆ putInTree()

ilObject::putInTree ( $a_parent_ref )

maybe this method should be in tree object!?

Todo:: role/rbac stuff

Reimplemented in ilObjFolder, ilObjContentObject, and ilObject2.

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

        {
                global $tree, $log;
 
                $tree->insertNode($this->getRefId(), $a_parent_ref);
                
                // write log entry
                $log->write("ilObject::putInTree(), parent_ref: $a_parent_ref, ref_id: ".
                        $this->getRefId().", obj_id: ".$this->getId().", type: ".
                        $this->getType().", title: ".$this->getTitle());
 
        }

References $log, getId(), getRefId(), getTitle(), and getType().

Referenced by ilObject2GUI\putObjectInTree(), and ilObjectGUI\putObjectInTree().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ read()

ilObject::read ( $a_force_db = false )

read object data from db into object

Parameters

boolean @access public

Reimplemented in ilObjCourse, ilObjSurvey, ilObjSurveyQuestionPool, ilObjTest, ilObjQuestionPool, ilObjRoleFolder, ilObject2, ilObjDiskQuotaSettings, and ilObjFileAccessSettings.

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

        {
                global $objDefinition, $ilBench, $ilDB, $log;
 
                $ilBench->start("Core", "ilObject_read");
                if (isset($this->obj_data_record) && !$a_force_db)
                {
                        $obj = $this->obj_data_record;
                }
                else if ($this->referenced)
                {
                        // check reference id
                        if (!isset($this->ref_id))
                        {
                                $message = "ilObject::read(): No ref_id given! (".$this->type.")";
                                $this->ilias->raiseError($message,$this->ilias->error_obj->WARNING);
                        }
 
                        // read object data
                        $ilBench->start("Core", "ilObject_read_readData");
 
                        $q = "SELECT * FROM object_data, object_reference WHERE object_data.obj_id=object_reference.obj_id ".
                                 "AND object_reference.ref_id= ".$ilDB->quote($this->ref_id, "integer");
                        $object_set = $ilDB->query($q);
                        $ilBench->stop("Core", "ilObject_read_readData");
 
                        // check number of records
                        if ($ilDB->numRows($object_set) == 0)
                        {
                                $message = "ilObject::read(): Object with ref_id ".$this->ref_id." not found! (".$this->type.")";
                                $this->ilias->raiseError($message,$this->ilias->error_obj->WARNING);
                        }
 
                        $obj = $ilDB->fetchAssoc($object_set);
                }
                else
                {
                        // check object id
                        if (!isset($this->id))
                        {
                                $message = "ilObject::read(): No obj_id given! (".$this->type.")";
                                $this->ilias->raiseError($message,$this->ilias->error_obj->WARNING);
                        }
 
                        // read object data
                        $q = "SELECT * FROM object_data ".
                                 "WHERE obj_id = ".$ilDB->quote($this->id, "integer");
                        $object_set = $ilDB->query($q);
 
                        // check number of records
                        if ($ilDB->numRows($object_set) == 0)
                        {
                                include_once("./Services/Object/exceptions/class.ilObjectNotFoundException.php");
                                throw new ilObjectNotFoundException("ilObject::read(): Object with obj_id: ".$this->id.
                                        " (".$this->type.") not found!");
                                return;
                        }
 
                        $obj = $ilDB->fetchAssoc($object_set);
                }
 
                $this->id = $obj["obj_id"];
                
                // check type match (the "xxx" type is used for the unit test)
                if ($this->type != $obj["type"] && $obj["type"] != "xxx")
                {
                        $message = "ilObject::read(): Type mismatch. Object with obj_id: ".$this->id." ".
                                "was instantiated by type '".$this->type."'. DB type is: ".$obj["type"];
 
                        // write log entry
                        $log->write($message);
                                
                        // raise error
                        include_once("./Services/Object/exceptions/class.ilObjectTypeMismatchException.php");
                        throw new ilObjectTypeMismatchException($message);
                        return;
                }
                
                $this->type = $obj["type"];
                $this->title = $obj["title"];
                // BEGIN WebDAV: WebDAV needs to access the untranslated title of an object
                $this->untranslatedTitle = $obj["title"];
                // END WebDAV: WebDAV needs to access the untranslated title of an object
                $this->desc = $obj["description"];
                $this->owner = $obj["owner"];
                $this->create_date = $obj["create_date"];
                $this->last_update = $obj["last_update"];
                $this->import_id = $obj["import_id"];
                
                if($objDefinition->isRBACObject($this->getType()))
                {
                        // Read long description
                        $query = "SELECT * FROM object_description WHERE obj_id = ".$ilDB->quote($this->id,'integer');
                        $res = $this->ilias->db->query($query);
                        while($row = $res->fetchRow(DB_FETCHMODE_OBJECT))
                        {
                                if(strlen($row->description))
                                {
                                        $this->setDescription($row->description);
                                }
                        }
                }
 
                // multilingual support systemobjects (sys) & categories (db)
                $ilBench->start("Core", "ilObject_Constructor_getTranslation");
                $translation_type = $objDefinition->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")
                {
                        $q = "SELECT title,description FROM object_translation ".
                                 "WHERE obj_id = ".$ilDB->quote($this->id,'integer')." ".
                                 "AND lang_code = ".$ilDB->quote($this->ilias->account->getCurrentLanguage(),'text')." ".
                                 "AND NOT lang_default = 1";
                        $r = $this->ilias->db->query($q);
                        $row = $r->fetchRow(DB_FETCHMODE_OBJECT);
                        if ($row)
                        {
                                $this->title = $row->title;
                                $this->setDescription($row->description);
                                #$this->desc = $row->description;
                        }
                }
 
                $ilBench->stop("Core", "ilObject_Constructor_getTranslation");
 
                $ilBench->stop("Core", "ilObject_read");
        }

References $ilBench, $ilDB, $log, $obj_data_record, $query, $res, $row, DB_FETCHMODE_OBJECT, and setDescription().

Referenced by ilObject().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ requireRegistration()

ilObject::requireRegistration ( )

Reimplemented in ilObject2.

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

        {
                return $this->register;
        }

References $register.

◆ setDeletedDates()

static ilObject::setDeletedDates ( $a_ref_ids )

static

Set deleted date @global type $ilDB.

Parameters

type $a_ref_ids

Returns: type

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

        {
                global $ilDB;
                
                $query = 'UPDATE object_reference SET deleted = '.$ilDB->now().' '.
                                'WHERE '.$ilDB->in('ref_id',(array) $a_ref_ids,false,'integer');
                
                $GLOBALS['ilLog']->write(__METHOD__.': Query is '. $query);
                $ilDB->manipulate($query);
                return;
        }

References $GLOBALS, $ilDB, and $query.

Referenced by ilTree\saveSubTree().

Here is the caller graph for this function:

◆ setDescription()

ilObject::setDescription ( $a_desc )

set object description

@access public

Parameters

string $a_desc object description

Reimplemented in ilObject2, ilObjGlossary, ilObjContentObject, ilObjQuestionPool, and ilObjMediaObject.

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

        {
                // Shortened form is storted in object_data. Long form is stored in object_description
                $this->desc = ilUtil::shortenText($a_desc, $this->max_desc, $this->add_dots);
 
                $this->long_desc = $a_desc;
 
                return true;
        }

References ilUtil\shortenText().

Referenced by ilObjRole\assignData(), shibUser\createFields(), ilObjTest\fromXML(), ilObjLanguage\install(), ilObjRoleGUI\loadRoleProperties(), MDUpdateListener(), ilObjRoleFolder\read(), read(), ilObjiLincClassroom\read(), ilObjLanguage\refresh(), ilObjLanguageExt\setLocal(), ilObjLanguage\uninstall(), and shibUser\updateFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setId()

ilObject::setId ( $a_id )

set object id @access public

Parameters

integer $a_id object id

Reimplemented in ilCourseStart, ilObjMediaObject, and ilObject2.

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

        {
                $this->id = $a_id;
        }

Referenced by ilObjUser\__construct().

Here is the caller graph for this function:

◆ setImportId()

ilObject::setImportId ( $a_import_id )

set import id

@access public

Parameters

string $a_import_id import id

Reimplemented in ilObjContentObject, ilObjMediaObject, and ilObject2.

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

        {
                $this->import_id = $a_import_id;
        }

Referenced by ilCategoryImportParser\handlerBeginTag().

Here is the caller graph for this function:

◆ setObjDataRecord()

ilObject::setObjDataRecord ( $a_record )

set object_data record (note: this method should only be called from the ilObjectFactory class)

Parameters

array $a_record assoc. array from table object_data @access public

Returns: integer object id

Reimplemented in ilObject2.

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

        {
                $this->obj_data_record = $a_record;
        }

◆ setOwner()

ilObject::setOwner ( $a_owner )

set object owner

@access public

Parameters

integer $a_owner owner id

Reimplemented in ilObject2.

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

        {
                $this->owner = $a_owner;
        }

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

Here is the caller graph for this function:

◆ setParentRolePermissions()

ilObject::setParentRolePermissions ( $a_parent_ref )

Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates.

Reimplemented in ilObjCourse.

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

        {
                global $rbacadmin, $rbacreview;
                
                $parent_roles = $rbacreview->getParentRoleIds($a_parent_ref);
                foreach((array) $parent_roles as $parent_role)
                {
                        $operations = $rbacreview->getOperationsOfRole(
                                $parent_role['obj_id'],
                                $this->getType(),
                                $parent_role['parent']
                        );
                        $rbacadmin->grantPermission(
                                $parent_role['obj_id'],
                                $operations,
                                $this->getRefId()
                        );
                }
                return true;
        }

References getRefId(), and getType().

Referenced by setPermissions().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setPermissions()

ilObject::setPermissions ( $a_parent_ref )

set permissions of object

Parameters

integer reference_id of parent object @access public

Reimplemented in ilObject2.

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

        {
                $this->setParentRolePermissions($a_parent_ref);
                $this->initDefaultRoles();
        }

References initDefaultRoles(), and setParentRolePermissions().

Referenced by ilObject2GUI\putObjectInTree(), and ilObjectGUI\putObjectInTree().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setRefId()

ilObject::setRefId ( $a_id )

set reference id @access public

Parameters

integer $a_id reference id

Reimplemented in ilObject2, and ilCourseStart.

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

        {
                $this->ref_id = $a_id;
                $this->referenced = true;
        }

◆ setRegisterMode()

ilObject::setRegisterMode ( $a_bool )

Reimplemented in ilObject2.

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

        {
                $this->register = (bool) $a_bool;
        }

Referenced by ilObjGroup\__construct(), and ilObjiLincCourse\ilObjiLincCourse().

Here is the caller graph for this function:

◆ setTitle()

ilObject::setTitle ( $a_title )

set object title

@access public

Parameters

string $a_title object title

Reimplemented in ilObjGlossary, ilObjContentObject, ilObjSurveyQuestionPool, ilObjQuestionPool, ilObjMediaObject, and ilObject2.

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

        {
                $this->title = ilUtil::shortenText($a_title, $this->max_title, $this->add_dots);
                // BEGIN WebDAV: WebDAV needs to access the untranslated title of an object
                $this->untranslatedTitle = $this->title;
                // END WebDAV: WebDAV needs to access the untranslated title of an object
        }

References $title, and ilUtil\shortenText().

Referenced by ilObjRole\assignData(), shibUser\createFields(), ilObjTest\fromXML(), ilObjRoleGUI\loadRoleProperties(), MDUpdateListener(), ilObjRoleFolder\read(), ilObjiLincClassroom\read(), ilObjLanguage\refresh(), ilObjLanguage\uninstall(), and shibUser\updateFields().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setType()

ilObject::setType ( $a_type )

set object type @access public

Parameters

integer $a_type object type

Reimplemented in ilObject2.

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

        {
                $this->type = $a_type;
        }

◆ update()

ilObject::update ( )

update object in db

@access public

Returns: boolean true on success

Reimplemented in ilObjBlogAdministration, ilObjBookingPool, ilObjCourse, ilObjExercise, ilObjExternalFeed, ilObjForumAdministration, ilObjGlossary, ilObjGroup, ilObjFileBasedLM, ilObjiLincCourse, ilObjContentObject, ilObjLearningResourcesSettings, ilObjMediaCast, ilObjMediaCastSettings, ilObjMediaPool, ilObjOrgUnit, ilObjPortfolioAdministration, ilObjSAHSLearningModule, ilObjSession, ilObjSurvey, ilObjSurveyAdministration, ilObjSurveyQuestionPool, ilObjAssessmentFolder, ilObjTest, ilObjQuestionPool, ilObjLinkResource, ilObjRole, ilObjAccessibilitySettings, ilObjExternalToolsSettings, ilObjRecoveryFolder, ilObjAdvancedEditing, ilObjAuthSettings, ilObjComponentSettings, ilContainer, ilContainerReference, ilObjMediaObjectsSettings, ilObjNewsSettings, ilObject2, ilObjPaymentSettings, ilObjPersonalDesktopSettings, ilObjSearchSettings, ilObjSkillManagement, ilObjStyleSettings, ilObjStyleSheet, ilObjTaggingSettings, ilObjDiskQuotaSettings, ilObjFileAccessSettings, and ilObjNull.

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

        {
                global $objDefinition, $ilDB;
 
                $q = "UPDATE object_data ".
                        "SET ".
                        "title = ".$ilDB->quote($this->getTitle(), "text").",".
                        "description = ".$ilDB->quote($this->getDescription(), "text").", ".
                        "import_id = ".$ilDB->quote($this->getImportId(), "text").",".
                        "last_update = ".$ilDB->now()." ".
                        "WHERE obj_id = ".$ilDB->quote($this->getId(), "integer");
                $ilDB->manipulate($q);
 
                // 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();
                $q = "SELECT last_update FROM object_data".
                         " WHERE obj_id = ".$ilDB->quote($this->getId(), "integer");
                $obj_set = $ilDB->query($q);
                $obj_rec = $ilDB->fetchAssoc($obj_set);
                $this->last_update = $obj_rec["last_update"];
 
                if($objDefinition->isRBACObject($this->getType()))
                {
                        // Update long description
                        $res = $this->ilias->db->query("SELECT * FROM object_description WHERE obj_id = ".
                                $ilDB->quote($this->getId(),'integer'));
                        if($res->numRows())
                        {
                                $values = array(
                                        'description'   => array('clob',$this->getLongDescription())
                                        );
                                $ilDB->update('object_description',$values,array('obj_id' => array('integer',$this->getId())));
                        }
                        else
                        {
                                $values = array(
                                        'description'   => array('clob',$this->getLongDescription()),
                                        'obj_id'                => array('integer',$this->getId()));
                                $ilDB->insert('object_description',$values);
                        }
                }
                $GLOBALS['ilAppEventHandler']->raise(
                        'Services/Object',
                        'update',
                        array('obj_id' => $this->getId(),
                                'obj_type' => $this->getType(),
                                'ref_id' => $this->getRefId()));
 
                return true;
        }

References $GLOBALS, $ilDB, $res, getDescription(), getId(), getImportId(), getLongDescription(), getRefId(), getTitle(), and getType().

Referenced by ilObjBookingPoolGUI\afterSave(), ilObjCourseGUI\afterSave(), ilObjContentObjectGUI\afterSave(), ilContainerReferenceGUI\afterSave(), ilECSAppEventListener\extendAccount(), ilObjectGUI\handleAutoRating(), ilObjLanguage\install(), MDUpdateListener(), ilObjLanguage\refresh(), ilObjUser\removeUserPicture(), ilObjLanguageExt\setLocal(), and ilObjLanguage\uninstall().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateMetaData()

ilObject::updateMetaData ( )

update meta data entry

Reimplemented in ilObjQuestionPool, ilObjMediaObject, and ilObject2.

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

        {
                include_once("Services/MetaData/classes/class.ilMD.php");
                include_once("Services/MetaData/classes/class.ilMDGeneral.php");
                include_once("Services/MetaData/classes/class.ilMDDescription.php");
 
                $md =& new ilMD($this->getId(), 0, $this->getType());
                $md_gen =& $md->getGeneral();
                // BEGIN WebDAV: meta data can be missing sometimes.
                if ($md_gen == null)
                {
                        $this->createMetaData();
                        $md =& new ilMD($this->getId(), 0, $this->getType());
                        $md_gen =& $md->getGeneral();
                }
                // END WebDAV: meta data 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();
 
        }

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

Referenced by ilObjCourse\update(), ilObjGlossary\update(), ilObjFileBasedLM\update(), ilObjContentObject\update(), ilObjSAHSLearningModule\update(), ilObjSurvey\update(), ilObjSurveyQuestionPool\update(), and ilObjLinkResource\update().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateOwner()

ilObject::updateOwner ( )

update owner of object in db

@access public

Returns: boolean true on success

Reimplemented in ilObject2.

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

    {
                global $ilDB;
                
        $q = "UPDATE object_data ".
            "SET ".
            "owner = ".$ilDB->quote($this->getOwner(), "integer").", ".
            "last_update = ".$ilDB->now()." ".
            "WHERE obj_id = ".$ilDB->quote($this->getId(), "integer");
        $ilDB->manipulate($q);
 
        $q = "SELECT last_update FROM object_data".
             " WHERE obj_id = ".$ilDB->quote($this->getId(), "integer");
        $obj_set = $ilDB->query($q);
        $obj_rec = $ilDB->fetchAssoc($obj_set);
        $this->last_update = $obj_rec["last_update"];
 
        return true;
    }

References $ilDB, getId(), and getOwner().

Here is the call graph for this function:

◆ withReferences()

ilObject::withReferences ( )

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

Reimplemented in ilObject2.

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

        {
                // 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.

Referenced by ilObjFolder\putInTree().

Here is the caller graph for this function:

Field Documentation

◆ $add_dots

ilObject::$add_dots

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

◆ $create_date

ilObject::$create_date

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

Referenced by getCreateDate().

◆ $desc

ilObject::$desc

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

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

◆ $id

ilObject::$id

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

Referenced by ilObjStyleSheet\_addMissingStyleClassesToAllStyles(), ilObjStyleSheet\_getClonableContentStyles(), ilObjUser\_getImportedUserId(), ilObjTest\_lookupAuthor(), ilObjStyleSheet\_replaceStylePar(), ilObjStyleSheet\addMediaQuery(), ilObjStyleSheet\addParameter(), ilObjContentObject\autoLinkGlossaryTerms(), ilObjUser\checkUserId(), collectDeletionDependencies(), ilObjLanguageFolderGUI\confirmRefreshSelectedObject(), ilObject2\create(), ilObjStyleSheet\create(), ilObjForum\create(), ilObjRole\create(), create(), ilObjStyleSheet\createFromXMLFile(), ilObjHelpSettings\createHelpModule(), ilObjBookingPool\delete(), ilObjSurvey\deleteUserSettings(), ilObjBlog\deliverRSS(), ilObjFile\doMDUpdateListener(), ilObjSurvey\getAnonymousId(), ilObjSurvey\getAuthor(), ilObjTest\getAuthor(), ilObjPortfolio\getAvailablePortfolioLinksForUserIds(), ilObjAssessmentFolder\getFullPath(), getId(), ilObjSurvey\getPrecondition(), ilObjPoll\getVotePercentages(), ilRemoteObjectBase\importMetadataFromJson(), ilObjLinkResource\MDUpdateListener(), MDUpdateListener(), ilObjUser\preloadIsDesktopItem(), ilObjLanguageFolderGUI\refreshSelectedObject(), ilObjPoll\saveAnswer(), ilObjPoll\saveAnswers(), ilObjTest\setQuestionOrderAndObligations(), ilObjPoll\updateAnswerPositions(), ilObjUser\updateMultiTextFields(), ilObjRepositorySettings\updateNewItemGroupOrder(), ilObjExercise\updateTextSubmission(), and ilObjHelpSettings\uploadHelpModule().

◆ $ilias

ilObject::$ilias

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

Referenced by ilObjTest\_createImportDirectory(), ilObjQuestionPool\_createImportDirectory(), ilObjiLincCourse\_getAKClassValues(), ilObjStyleSheet\_getStandardStyles(), ilObjUserTracking\_hasLearningProgressLearner(), ilObjUserTracking\_hasLearningProgressListGUI(), ilObjiLincCourse\_isActivated(), ilObjContentObject\_moveLMStyles(), ilObjUserFolder\buildExportFile(), ilObjGlossary\cloneObject(), ilObjFileBasedLM\cloneObject(), ilObjContentObject\cloneObject(), ilObjMediaCast\cloneObject(), ilObjMediaPool\cloneObject(), ilObjSAHSLearningModule\cloneObject(), ilObjWiki\cloneObject(), ilObjSCORM2004LearningModule\copyAuthoredContent(), ilObjGlossary\exportHTML(), ilObjContentObject\exportHTML(), ilObjStyleSheet\getContentStylePath(), ilObjFile\getXMLZip(), ilObject(), ilObjiLincClassroom\ilObjiLincClassroom(), ilObjSCORM2004LearningModule\readObject(), and ilObjTest\saveToDb().

◆ $import_id

ilObject::$import_id

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

Referenced by ilObjContentObject\getImportId(), ilObjMediaObject\getImportId(), and getImportId().

◆ $last_update

ilObject::$last_update

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

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

◆ $lng

ilObject::$lng

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

Referenced by ilObjTest\__construct(), ilObjExercise\__formatBody(), ilObjRole\__getPermissionDefinitions(), ilObjTest\_buildName(), ilObjLanguageExt\_deleteValues(), ilObjMediaObject\_determineWidthHeight(), ilObjQuestionPool\_getAvailableQuestionpools(), ilObjiLincClassroom\_getDocent(), ilObjQuestionPool\_getQuestionTypes(), ilObjSurveyQuestionPool\_getQuestiontypes(), ilObjSurveyQuestionPool\_getQuestionTypeTranslations(), ilObjLanguageExt\_getRemarks(), ilObjSCORMLearningModule\_getStatusForUser(), ilObjRole\_getTranslation(), ilObjLanguageExt\_getValues(), ilObjGroup\_importFromFile(), _lookupOwnerName(), ilObjExercise\_lookupStatusTime(), _prepareCloneSelection(), ilObjLanguageExt\_saveValues(), ilObjAdvancedEditing\_setUsedHTMLTags(), ilObjContentObject\addFirstChapterAndPage(), ilObjExercise\addUploadedFile(), ilObjUser\assignData(), ilObjUserFolder\buildExportFile(), ilObjLanguageFolder\checkAllLanguages(), ilObjPortfolioBase\clonePagesAndSettings(), ilObjLanguageFolderGUI\confirmRefreshObject(), ilObjLanguageFolderGUI\confirmRefreshSelectedObject(), ilObjLanguage\countUsers(), ilObjCourseVerification\createFromCourse(), ilObjExerciseVerification\createFromExercise(), ilObjSCORMVerification\createFromSCORMLM(), ilObjTestVerification\createFromTest(), ilObjTest\createQuestionGUI(), ilObjTaxonomy\doCloneObject(), ilObjFolder\downloadFolder(), ilObjWorkspaceFolder\downloadFolder(), ilObjTest\ensureParticipantsLastActivePassFinished(), ilObjGlossary\getAdvMDSubItemTitle(), ilObjWiki\getAdvMDSubItemTitle(), ilObjSAHSLearningModule\getAffectiveLocalization(), ilObjTest\getAnsweredQuestionCount(), ilObjRepositorySettings\getDefaultNewItemGrouping(), ilObjGlossary\getDeletionDependencies(), ilObjLanguageFolder\getLanguages(), ilObjRepositorySettings\getNewItemGroups(), ilObjTest\getQuestionSetTypeTranslation(), ilObjTest\getQuestionTypeTranslations(), ilObjQuestionPool\getQuestionTypeTranslations(), ilObjSurvey\getSurveyCodesForExport(), ilObjSurvey\getSurveySkippedValue(), ilObjTest\getTestResult(), ilObjOrgUnit\getTranslations(), ilObjMediaPool\getUsedFormats(), ilObjStyleSheet\ilClone(), ilObject(), ilObjiLincClassroom\ilObjiLincClassroom(), ilObjLanguage\ilObjLanguage(), ilObjLanguageFolder\ilObjLanguageFolder(), ilObjSurvey\ilObjSurvey(), ilObjContentObject\importFromDirectory(), ilObjContentObject\importFromZipFile(), ilObjSCORMLearningModule\importRaw(), ilObjTest\isParticipantsLastPassActive(), ilObjTaxonomy\loadLanguageModule(), ilObjExercise\processUploadedFile(), ilObjSCORM2004LearningModule\readObject(), ilObjLanguageFolderGUI\refreshSelectedObject(), ilObjTest\removeTestResultsByUserIds(), and ilObjLanguageFolderGUI\viewObject().

◆ $long_desc

ilObject::$long_desc

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

Referenced by ilContainer\getCompleteDescriptions().

◆ $max_desc

ilObject::$max_desc

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

◆ $max_title

ilObject::$max_title

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

◆ $obj_data_record

ilObject::$obj_data_record

object_data record

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

Referenced by read().

◆ $objectList

ilObject::$objectList

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

◆ $owner

ilObject::$owner

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

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

◆ $ref_id

ilObject::$ref_id

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

Referenced by ilObjUser\_getAllUserData(), ilObjSurveyQuestionPool\_getAvailableQuestionpools(), ilObjQuestionPool\_getAvailableQuestionpools(), ilObjTest\_getAvailableTests(), ilObjStyleSheet\_getClonableContentStyles(), ilObjQuestionPool\_getFullPathToQpl(), ilObjGroup\_getMembers(), ilObjUser\_getUsersForFolder(), ilObjUserTracking\_hasLearningProgressOtherUsers(), _hasUntrashedReference(), ilObjQuestionPool\_isWriteable(), ilObjDlBook\addTranslations(), ilContainer\cloneAllObject(), createReference(), ilObjDlBook\deleteTranslations(), ilObjPortfolioTemplate\getAvailablePortfolioTemplates(), ilObjAssessmentFolder\getFullPath(), ilObjSurvey\getGroupData(), ilObjTest\getGroupData(), ilObjDiskQuotaSettings\getInstance(), getRefId(), ilRemoteObjectBase\handleDelete(), ilObjForum\lookupForumIdByRefId(), and ilObjUser\searchUsers().

◆ $referenced

ilObject::$referenced

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

Referenced by withReferences().

◆ $register

ilObject::$register = false

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

Referenced by requireRegistration().

◆ $title

ilObject::$title

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

Referenced by ilObjSurvey\_addQuestionblock(), ilObjTest\_buildName(), ilObjQuestionPool\_getAvailableQuestionpools(), _getIdsForTitle(), ilObject2\_getIdsForTitle(), ilObjDataCollection\_hasTableByTitle(), ilObjUser\_lookupDesktopItems(), _prepareCloneSelection(), appendCopyInfo(), ilObjFile\beforeMDUpdateListener(), ilObjTest\buildName(), cloneObject(), ilObjSurvey\createQuestionblock(), ilObjMediaPool\deleteChild(), ilObjTest\deliverPDFfromFO(), ilObjTest\deliverPDFfromHTML(), ilObjUser\exportPersonalData(), ilObjPortfolio\getAvailablePortfolioLinksForUserIds(), ilObjCourse\getDefaultMemberRole(), ilObjRepositorySettings\getDefaultNewItemGrouping(), ilObjRepositorySettings\getNewItemGroups(), ilObjTest\getQuestionTitle(), getTitle(), ilObjSCORM2004LearningModule\getTrackingDataAgg(), ilObjLanguage\ilObjLanguage(), ilObjSurvey\insertQuestionblock(), ilObjLinkResource\MDUpdateListener(), ilObjSurvey\modifyQuestionblock(), ilObjFolder\recurseFolder(), ilObjWorkspaceFolder\recurseFolder(), ilObjSurvey\saveUserSettings(), setTitle(), and ilObjContentObject\validatePages().

◆ $type

ilObject::$type

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

Referenced by _getIdsForTitle(), ilObject2\_getIdsForTitle(), ilObjAssessmentFolder\_getLog(), ilObjSurveyQuestionPool\_getQuestiontypes(), ilObjRole\createPermissionIntersection(), ilObjMediaPool\deleteChild(), ilObjTest\fromXML(), ilObjQuestionPool\getExportDirectory(), ilObjContentObject\getExportFiles(), ilObjSCORM2004LearningModule\getExportFiles(), ilObjRepositorySettings\getNewItemGroupSubItems(), ilObjMediaObject\getParentObjectIdForUsage(), ilContainer\getSubItems(), ilObjStyleSheet\getTemplateXML(), getType(), ilRemoteObjectBase\importMetadataFromJson(), ilCourseStart\isFullfilled(), ilObjGroup\lookupGroupStatusTemplateId(), ilVerificationObject\saveProperties(), ilObjExercise\sendFeedbackFileNotification(), ilContainerReference\setTitleType(), and ilObjBibliographic\writeSourcefileEntriesToDb().

◆ $untranslatedTitle

ilObject::$untranslatedTitle

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

Referenced by getUntranslatedTitle().

◆ DESC_LENGTH

const ilObject::DESC_LENGTH = 128

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

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

◆ TITLE_LENGTH

const ilObject::TITLE_LENGTH = 255

max length of object title

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

Referenced by ilContainerSelectionExplorer\__construct(), ilCopyWizardExplorer\__construct(), ilObject(), ilRepositoryCopySelector\ilRepositoryCopySelector(), ilRepositoryLinkSelector\ilRepositoryLinkSelector(), ilRoleDesktopItemSelector\ilRoleDesktopItemSelector(), ilSearchRootSelector\ilSearchRootSelector(), ilObjCloudGUI\initCreateForm(), ilObjGlossaryGUI\initCreateForm(), ilObjPortfolioGUI\initCreateForm(), ilObjectGUI\initCreateForm(), ilObjectPluginGUI\initCreateForm(), ilObjSAHSLearningModuleGUI\initCreationForm(), ilObjCategoryGUI\initEditForm(), ilObjCourseGUI\initEditForm(), ilObjPortfolioGUI\initEditForm(), ilObjectGUI\initEditForm(), ilObjectPluginGUI\initEditForm(), ilRemoteObjectBaseGUI\initEditForm(), ilObjGroupGUI\initForm(), ilContainerReferenceGUI\initFormTitle(), ilObjForumGUI\initForumCreateForm(), ilObjFileBasedLMGUI\initSettingsForm(), and ilObjFileGUI\initSingleUploadForm().

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

Detailed Description

Member Function Documentation

◆ _exists()

◆ _getAllReferences()

◆ _getIcon()

◆ _getIdForImportId()

◆ _getIdsForTitle()

◆ _getLastUpdateOfObjects()

◆ _getObjectsByType()

◆ _getObjectsDataForType()

◆ _hasUntrashedReference()

◆ _isInTrash()

◆ _lookupCreationDate()

◆ _lookupDeletedDate()

◆ _lookupDescription()

◆ _lookupLastUpdate()

◆ _lookupObjectId()

◆ _lookupObjId()

◆ _lookupObjIdByImportId()

◆ _lookupOwner()

◆ _lookupOwnerName()

◆ _lookupTitle()

◆ _lookupType()

◆ _prepareCloneSelection()

◆ _resetDeletedDate()

◆ _setDeletedDate()

◆ _writeDescription()

◆ _writeImportId()

◆ _writeTitle()

◆ appendCopyInfo()

◆ applyDidacticTemplate()

◆ cloneDependencies()

◆ cloneMetaData()

◆ cloneObject()

◆ collectDeletionDependencies()

◆ countReferences()

◆ create()

◆ createMetaData()

◆ createReference()

◆ delete()

◆ deleteMetaData()

◆ getAllOwnedRepositoryObjects()

◆ getCreateDate()

◆ getDeletionDependencies()

◆ getDescription()

◆ getDiskUsage()

◆ getHTMLDirectory()

◆ getId()

◆ getImportId()

◆ getLastUpdateDate()

◆ getLongDescription()

◆ getLongDescriptions()

◆ getOwner()

◆ getOwnerName()

◆ getPresentationTitle()

◆ getRefId()

◆ getTitle()

◆ getType()

◆ getUntranslatedTitle()

◆ getXMLZip()

◆ hasAutoRating()

◆ ilObject()

◆ initDefaultRoles()

◆ isUserRegistered()

◆ MDUpdateListener()

◆ notify()

◆ putInTree()

◆ read()

◆ requireRegistration()

◆ setDeletedDates()

◆ setDescription()

◆ setId()

◆ setImportId()

◆ setObjDataRecord()

◆ setOwner()

◆ setParentRolePermissions()

◆ setPermissions()