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 public.
	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not)
	read ($a_force_db=false)
	read object data from db into object
	getId ()
	get object id public
	setId ($a_id)
	set object id public
	setRefId ($a_id)
	set reference id public
	getRefId ()
	get reference id public
	getType ()
	get object type public
	setType ($a_type)
	set object type public
	getPresentationTitle ()
	get presentation title Normally same as title Overwritten for sessions
	getTitle ()
	get object title public
	getUntranslatedTitle ()
	get untranslated object title public
	setTitle ($a_title)
	set object title
	getDescription ()
	get object description
	setDescription ($a_desc)
	set object description
	getLongDescription ()
	get object long description (stored in object_description)
	getImportId ()
	get import id
	setImportId ($a_import_id)
	set import id
	getOwner ()
	get object owner
	getOwnerName ()
	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id
	setOwner ($a_owner)
	set object owner
	getCreateDate ()
	get create date public
	getLastUpdateDate ()
	get last update date public
	getDiskUsage ()
	Gets the disk usage of the object in bytes.
	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class)
	create ()
	create
	update ()
	update object in db
	MDUpdateListener ($a_element)
	Meta data update listener.
	createMetaData ()
	create meta data entry
	updateMetaData ()
	update meta data entry
	deleteMetaData ()
	delete meta data entry
	updateOwner ()
	update owner of object in db
	_getIdForImportId ($a_import_id)
	get current object id for import id (static)
	_lookupOwner ($a_id)
	lookup object owner
	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update
	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects.
	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree
	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes
	_writeTitle ($a_obj_id, $a_title)
	write title to db (static)
	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static)
	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static)
	_isInTrash ($a_ref_id)
	checks wether object is in trash
	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash
	_lookupObjectId ($a_ref_id)
	lookup object id
	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type
	putInTree ($a_parent_ref)
	maybe this method should be in tree object!?
	setPermissions ($a_parent_ref)
	set permissions of object
	createReference ()
	creates reference for object
	countReferences ()
	count references of object
	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!!
	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) public
	createRoleFolder ()
	creates a local role folder
	applyDidacticTemplate ($a_tpl_id)
	Apply template.
	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.
	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 ...
	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container.
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies.
	cloneMetaData ($target_obj)
	Copy meta data.

Static Public Member Functions
static	_lookupObjIdByImportId ($a_import_id)
static	_getAllReferences ($a_id)
	get all reference ids of object
static	_lookupTitle ($a_id)
	lookup object title
static	_getIdsForTitle ($title, $type= '', $partialmatch=false)
static	_lookupDescription ($a_id)
	lookup object description
static	_lookupObjId ($a_id)
static	_lookupType ($a_id, $a_reference=false)
	lookup object type
	_exists ($a_id, $a_reference=false)
	checks if an object exists in object_data
static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type.
static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection.
static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item.
static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies.
static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies.

Data Fields
const	TITLE_LENGTH = 128
	max length of object title
	$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

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:: class.ilObject.php 44275 2013-08-19 14:50:10Z jluetzen

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

Member Function Documentation

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

static

checks if an object exists in object_data

public

Parameters

integer	object id or reference id
boolean	ture if id is a reference, else false (default)

Returns: boolean true if object exists

Reimplemented in ilObject2.

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

References $ilDB, and $ilias.

Referenced by ilShopUtils\_createRandomUserAccount(), _lookupOwnerName(), ilNavigationHistory\addItem(), ilSoapObjectAdministration\addObject(), ilSoapAdministration\checkObjectAccess(), ilPageObject\collectMediaObjects(), ilObjRole\delete(), ilNewsItem\delete(), ilPageObject\delete(), ilObjSCORMLearningModuleGUI\deleteTrackingForUser(), ilObjSCORM2004LearningModuleGUI\deleteTrackingForUser(), ilPublicUserProfileGUI\deliverVCard(), ilObjExerciseGUI\downloadAllObject(), ilSCORM2004Asset\exportFileItems(), ilObjContentObject\exportHTML(), ilCOPageHTMLExport\exportPageElements(), ilObjSCORM2004LearningModule\exportSelected(), ilForum\fetchPostNodeData(), ilPageHistoryTableGUI\fillRow(), ilMediaCastTableGUI\fillRow(), ilLinksTableGUI\fillRow(), ilWikiContributorsTableGUI\fillRow(), ilPDNewsTableGUI\fillRow(), ilPageObject\getContentObject(), ilObjStyleSheet\getContentStylePath(), ilSoapCourseAdministration\getCoursesForUser(), ilPublicUserProfileGUI\getEmbeddable(), ilSCORM2004ScoGUI\getExportResources(), ilSoapGroupAdministration\getGroupsForUser(), ilGoogleMapGUI\getHtml(), ilObjMediaObject\getLinkedMediaObjects(), ilExAssignment\getMemberListData(), ilNoteGUI\getNoteListHTML(), ilTagging\getObjectsForTagAndUser(), ilExAssignmentGUI\getOverviewBody(), ilObjSCORM2004LearningModule\getTrackedUsers(), ilForum\getUser(), ilForumPost\getUserData(), ilForum\getUserData(), ilGoogleMapGUI\getUserListHtml(), ilObjectFeedWriter\ilObjectFeedWriter(), ilNewsForContextBlockGUI\showNews(), ilPageObjectGUI\showPage(), ilObjSCORM2004LearningModuleGUI\showTrackingItems(), ilObjectTest\testCreationDeletion(), ilPageObject\update(), and ilContObjectManifestBuilder\writeResources().

        {
                global $ilias, $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");
                }
                
                $r = $ilDB->query($q);
                return $ilDB->numRows($r) ? true : false;
        }

Here is the caller graph for this function:

static ilObject::_getAllReferences ( $a_id )

static

get all reference ids of object

Parameters

int $a_id object id

Reimplemented in ilObject2.

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

References $ilDB, $query, and $res.

Referenced by ilObjectXMLWriter\__appendObject(), ilParticipant\__construct(), ilObjectCustomUserFieldsGUI\__construct(), ilParticipants\__construct(), ilAdminUserSearchGUI\__fillGroupTable(), ilLPListOfProgressGUI\__initDetails(), ilCourseObjectiveMaterials\__read(), ilLPCollections\__read(), ilCourseObjectiveQuestion\__read(), ilObjGlossaryAccess\_checkGoto(), ilObjContentObjectAccess\_checkGoto(), ilObjStyleSheet\_getClonableContentStyles(), ilLPStatusCollection\_getCompleted(), ilLPStatusCollection\_getFailed(), ilInternalLink\_getIdForImportId(), ilLPStatusCollection\_getInProgress(), ilLPCollections\_getItems(), ilObjGroup\_getMembers(), ilLPStatusCollection\_getNotAttempted(), ilNote\_getRelatedObjectsOfUser(), ilLPStatusEvent\_getStatusInfo(), ilLMPageObjectGUI\_goto(), ilGlossaryTermGUI\_goto(), ilObjForumGUI\_goto(), ilStructureObjectGUI\_goto(), _hasUntrashedReference(), ilContainerReferenceAccess\_isAccessible(), ilObjSurveyQuestionPool\_isWriteable(), ilObjQuestionPool\_isWriteable(), ilInfoScreenGUI\addObjectSections(), ilCalendarCategoryGUI\addReferenceLinks(), ilObjGlossaryGUI\addUsagesToInfo(), ilSoapCourseAdministration\assignCourseMember(), ilSoapGroupAdministration\assignGroupMember(), ilUserImportParser\assignToRole(), ilCalendarExport\buildAppointmentUrl(), ilWebAccessChecker\checkAccessLM(), ilWebAccessChecker\checkAccessObject(), ilSearchAutoComplete\checkObjectPermission(), ilDAVLocks\cleanUp(), ilSoapCourseAdministration\deleteCourse(), ilContainerReferenceAppEventListener\deleteReferences(), ilUserImportParser\detachFromRole(), ilObjGroup\determineViewMode(), ilCalendarAppointmentGUI\distributeNotifications(), ilSurveyPageGUI\editQuestion(), ilSoapCourseAdministration\excludeCourseMember(), ilSoapGroupAdministration\excludeGroupMember(), ilECSImportedContentTableGUI\fillRow(), ilTestQuestionsTableGUI\fillRow(), ilLuceneSearchResultFilter\filter(), ilSearchResult\filter(), ilSoapCourseAdministration\getCoursesForUser(), ilMail\getEmailsOfRecipients(), ilObjBlogGUI\getExerciseInfo(), ilObjPortfolioGUI\getExerciseInfo(), ilSoapExerciseAdministration\getExerciseXML(), ilSoapFileAdministration\getFileXML(), ilTermUsagesTableGUI\getFirstWritableRefId(), ilMediaPoolPageUsagesTableGUI\getFirstWritableRefId(), ilMediaObjectUsagesTableGUI\getFirstWritableRefId(), ilSoapGroupAdministration\getGroupsForUser(), ilCalendarAppointmentPanelGUI\getHTML(), ilSoapSCORMAdministration\getIMSManifestXML(), assQuestion\getInstances(), ilPDSelectedItemsBlockGUI\getObjectsByMembership(), ilSoapObjectAdministration\getRefIdsByImportId(), ilSoapObjectAdministration\getRefIdsByObjId(), ilSoapTestAdministration\getTestResults(), ilMail\getUserIds(), ilSurveyQuestionPoolExporter\getXmlRepresentation(), ilSurveyExporter\getXmlRepresentation(), ilContainerExporter\getXmlRepresentation(), ilCourseExporter\getXmlRepresentation(), ilGroupExporter\getXmlRepresentation(), ilECSTaskScheduler\handleDelete(), ilTaggingAppEventListener\handleEvent(), ilTrackingAppEventListener\handleEvent(), ilECSCategoryMapping\handleUpdate(), ilSoapTestAdministration\hasWritePermissionForTest(), ilSurveySyncTableGUI\importData(), ilSurveyQuestionTableGUI\importData(), ilSessionDataSet\importRecord(), ilGroupImporter\importXmlRepresentation(), ilCourseImporter\importXmlRepresentation(), ilObjCourseReferenceListGUI\initItem(), ilObjCategoryReferenceListGUI\initItem(), ilSoapCourseAdministration\isAssignedToCourse(), ilSoapGroupAdministration\isAssignedToGroup(), ilGlossaryPresentationGUI\listDefinitions(), ilContainerSortingSettings\lookupSortModeFromParentContainer(), ilMailSearchCoursesGUI\mailCourses(), ilMailSearchGroupsGUI\mailGroups(), ilObjPortfolioGUI\pages(), ilCalendarCategoryTableGUI\parse(), ilECSReleasedContentTableGUI\parse(), ilCalendarManageTableGUI\parse(), ilSearchResultPresentation\parseResultReferences(), ilContainerReference\read(), ilCalendarCategoryGUI\readPermissions(), ilCalendarCategories\readSelectedCategories(), ilSoapWebLinkAdministration\readWebLink(), ilSoapObjectAdministration\removeFromSystemByImportId(), ilObjBlogGUI\render(), ilObjUserGUI\roleassignmentObject(), ilTrQuery\searchObjects(), ilForum\sendForumNotifications(), ilCronForumNotification\sendMails(), ilForum\sendThreadNotifications(), ilCalendarAppointmentGUI\showInfoScreen(), ilMailSearchGroupsGUI\showMembers(), ilMailSearchCoursesGUI\showMyCourses(), ilMailSearchGroupsGUI\showMyGroups(), ilPDTaggingBlockGUI\showResourcesForTag(), ilPageEditorGUI\showSnippetInfo(), ilNoteGUI\showTargets(), SurveyQuestionGUI\syncCopies(), ilObjectTest\testObjectReference(), ilObjectTest\testSetGetLookup(), ilSoapCourseAdministration\updateCourse(), ilSoapExerciseAdministration\updateExercise(), ilSoapFileAdministration\updateFile(), ilSoapObjectAdministration\updateObjects(), and ilSoapWebLinkAdministration\updateWebLink().

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

Here is the caller graph for this function:

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

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

Referenced by ilObject2GUI\deleteConfirmation(), ilForumLocatorGUI\display(), ilObjectPluginGUI\executeCommand(), ilSubItemSelectionTableGUI\fillRow(), ilTrashTableGUI\fillRow(), ilSearchResultTableGUI\fillRow(), ilAdminSubItemsTableGUI\fillRow(), ilNewsForContextBlockGUI\fillRow(), ilPasteIntoMultipleItemsExplorer\formatHeader(), ilForumMoveTopicsExplorer\formatHeader(), ilWorkspaceExplorer\formatHeader(), ilShopRepositoryExplorer\formatHeader(), ilRepositoryExplorer\formatHeader(), ilNavigationHistoryGUI\getHTML(), ilLocatorGUI\getHTML(), ilTaggingGUI\getHTML(), ilNavigationHistoryGUI\getHTMLOld(), ilShopRepositoryExplorer\getImage(), ilRepositoryExplorer\getImage(), ilLPObjectStatisticsTypesTableGUI\getItems(), ilNoteGUI\getNoteListHTML(), ilObjectListGUI\insertIconsAndCheckboxes(), ilMainMenuGUI\renderEntry(), ilPersonalWorkspaceGUI\renderToolbar(), ilRepUtilGUI\showDeleteConfirmation(), ilNewsForContextBlockGUI\showNews(), ilContainerGUI\showPossibleSubObjects(), ilShopGUI\showShopExplorer(), ilNoteGUI\showTargets(), and ilRepositoryGUI\showTree().

        {
                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")))
                {
                        require_once("./Services/Container/classes/class.ilContainer.php");
                        if (ilContainer::_lookupContainerSetting($a_obj_id, "icon_".$a_size))
                        {
                                $cont_dir = ilContainer::_getContainerDirectory($a_obj_id);
                                $file_name = $cont_dir."/icon_".$a_size.".gif";
        
                                if (is_file($file_name))
                                {
                                        return $file_name;
                                }
                        }
                }
                
                switch($a_size)
                {
                        case "small": $suff = ""; break;
                        case "tiny": $suff = "_s"; break;
                        default: $suff = "_b"; break;
                }
                if (!$a_offline)
                {
                        if ($objDefinition->isRBACObject($a_type))
                        {
                                if (!$objDefinition->isPlugin($a_type))
                                {
                                        return ilUtil::getImagePath("icon_".$a_type.$suff.".gif");
                                }
                                else
                                {
                                        include_once("./Services/Repository/classes/class.ilRepositoryObjectPlugin.php");
                                        return ilRepositoryObjectPlugin::_getIcon($a_type, $a_size);
                                }
                        }
                        return ilUtil::getImagePath("icon_".$a_type.$suff.".gif");
                }
                else
                {
                        return "./images/icon_".$a_type.$suff.".gif";
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

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

References $ilDB.

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

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

static

Reimplemented in ilObject2.

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

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

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

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

Here is the caller graph for this function:

ilObject::_getLastUpdateOfObjects ( $a_objs )

Get last update for a set of media objects.

Parameters

array

Reimplemented in ilObject2.

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

References $ilDB.

Referenced by ilPageObject\getLastUpdateOfIncludedElements().

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

Here is the caller graph for this function:

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

static

Get objects by type.

Reimplemented in ilObject2.

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

References $ilDB, and $row.

Referenced by ilLanguage\getInstalledLanguages(), ilObjLanguageFolder\getLanguages(), ilObjLanguage\refreshAll(), and ilObjectTest\testSetGetLookup().

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

Here is the caller graph for this function:

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

References $ilDB, and _hasUntrashedReference().

Referenced by ilObjStyleSheet\_addMissingStyleClassesToAllStyles().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

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

Referenced by ilLMObject\_getAllObjectsForImportId(), ilGlossaryTerm\_getIdForImportId(), ilSCORM2004Node\_getIdForImportId(), ilLMObject\_getIdForImportId(), _getObjectsDataForType(), ilObjSurveyQuestionPool\_isWriteable(), ilObjQuestionPool\_isWriteable(), ilChatroomViewTask\forcePublicRoom(), ilSoapObjectAdministration\getObjIdsByRefIds(), ilObjSAHSLearningModule\getScormModulesForGlossary(), ilTaggingAppEventListener\handleEvent(), ilMailSearchCoursesGUI\showMyCourses(), ilMailSearchGroupsGUI\showMyGroups(), ilObjectTest\testTreeTrash(), ilBasicSkill\updateAllUserSkillLevels(), and ilBasicSkill\updateSkillLevelsByTriggerRef().

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilObject::_isInTrash ( $a_ref_id )

checks wether object is in trash

Reimplemented in ilObject2.

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

Referenced by _hasUntrashedReference(), ilSoapCourseAdministration\addCourse(), ilSoapExerciseAdministration\addExercise(), ilSoapFileAdministration\addFile(), ilSoapGroupAdministration\addGroup(), ilSoapObjectAdministration\addObject(), ilSoapRBACAdministration\addRole(), ilSoapRBACAdministration\addRoleFromTemplate(), ilSoapAdministration\checkObjectAccess(), ilSoapWebLinkAdministration\createWebLink(), ilObjWorkspaceFolder\downloadFolder(), ilObjFolder\downloadFolder(), ilPaymentObjectGUI\editDetails(), 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(), ilObjWorkspaceFolder\recurseFolder(), ilObjFolder\recurseFolder(), ilSoapTestAdministration\removeTestResults(), ilObjectTest\testTreeTrash(), ilSoapExerciseAdministration\updateExercise(), ilSoapFileAdministration\updateFile(), ilSoapGroupAdministration\updateGroup(), ilSoapObjectAdministration\updateObjects(), and ilSoapWebLinkAdministration\updateWebLink().

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

Here is the caller graph for this function:

ilObject::_lookupDeletedDate ( $a_ref_id )

only called in ilObjectGUI::insertSavedNodes

Reimplemented in ilObject2.

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

References $ilDB, and $query.

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

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

Here is the caller graph for this function:

static ilObject::_lookupDescription ( $a_id )

static

lookup object description

Parameters

int $a_id object id

Reimplemented in ilObject2.

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

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

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

Here is the caller graph for this function:

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

lookup last update

Parameters

int $a_id object id

Reimplemented in ilObject2.

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

References ilDatePresentation\formatDate(), and IL_CAL_DATETIME.

Referenced by ilObjFileListGUI\getProperties(), and ilObjectTest\testSetGetLookup().

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilObject::_lookupObjectId ( $a_ref_id )

lookup object id

Parameters

int $a_id object id

Reimplemented in ilObject2.

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

Referenced by ilObject2GUI\__construct(), ilSCORM13Player\__construct(), ilShopUtils\_assignPurchasedCourseMemberRole(), ilObjSurveyQuestionPool\_getAvailableQuestionpools(), ilObjForumGUI\_goto(), ilObjContentObjectGUI\addMenuEntry(), ilLPListOfProgressGUI\details(), ilContainerGUI\editPageContentObject(), ilSAHSPresentationGUI\executeCommand(), ilSAHSEditGUI\executeCommand(), ilObjiLincClassroomGUI\getDefaultValues(), ilSoapExerciseAdministration\getExerciseXML(), ilSoapFileAdministration\getFileXML(), ilSoapSCORMAdministration\getIMSManifestXML(), ilObjiLincClassroomGUI\getObjectValues(), ilSoapObjectAdministration\getObjIdsByRefIds(), ilTrQuery\getParticipantsForObject(), ilSoapSCORMAdministration\getSCORMCompletionStatus(), ilTrQuery\getSummaryDataForObject(), ilSoapTestAdministration\getTestResults(), ilTrQuery\getUserDataForObject(), ilTrQuery\getUserObjectMatrix(), ilSoapSCORMAdministration\hasSCORMCertificate(), ilObjGroupGUI\initForm(), ilShopRepositoryExplorer\isClickable(), ilRepositoryExplorer\isClickable(), ilTestScoringGUI\manscoring(), ilForum\moveThreads(), ilObjSCORMLearningModuleGUI\newModuleVersion(), assTextQuestionGUI\outQuestionForTest(), ilRbacLogTableGUI\parseChangesFaPa(), ilSoapWebLinkAdministration\readWebLink(), ilObjiLincClassroomGUI\save(), ilObjectTest\testSetGetLookup(), ilObjiLincClassroomGUI\updateClassroom(), ilSoapExerciseAdministration\updateExercise(), ilSoapFileAdministration\updateFile(), ilSoapObjectAdministration\updateObjects(), and ilSoapWebLinkAdministration\updateWebLink().

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

Here is the caller graph for this function:

static ilObject::_lookupObjId ( $a_id )

static

Reimplemented in ilObject2.

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

Referenced by ilObjCategoryGUI\__buildFilterSelect(), ilTrSummaryTableGUI\__construct(), ilTrMatrixTableGUI\__construct(), ilWikiPageGUI\__construct(), ilCopySelfAssQuestionTableGUI\__construct(), ilMainMenuSearchGUI\__construct(), ilAuthShibbolethSettingsGUI\__construct(), ilTrObjectUsersPropsTableGUI\__construct(), ilSessionOverviewGUI\__construct(), ilObjRoleGUI\__construct(), ilRegistrationGUI\__construct(), ilContainerContentGUI\__forwardToColumnGUI(), ilCourseContentGUI\__forwardToColumnGUI(), ilCourseItems\__sort(), ilObjCourseReferenceAccess\_checkAccess(), ilObjQuestionPool\_getAvailableQuestionpools(), ilObjTest\_getAvailableTests(), ilLPStatusCollection\_getCompleted(), ilLPStatusCollection\_getFailed(), ilLPStatusCollection\_getInProgress(), ilObjContentObjectAccess\_getLastAccessedPage(), ilNewsItem\_getNewsItemsOfUser(), ilLPStatusCollection\_getNotAttempted(), ilLPStatusEvent\_getStatusInfo(), ilObjRemoteCourseGUI\_goto(), ilObjCourseReferenceGUI\_goto(), ilObjCategoryReferenceGUI\_goto(), ilObjMailGUI\_goto(), ilObjectPluginGUI\_goto(), ilObjSAHSLearningModuleGUI\_goto(), ilObjWikiGUI\_goto(), ilObjBookingPoolGUI\_goto(), ilObjFileGUI\_goto(), ilObjFileBasedLMGUI\_goto(), ilObjSurveyQuestionPoolGUI\_goto(), ilObjForumGUI\_goto(), ilObjMediaCastGUI\_goto(), ilObjQuestionPoolGUI\_goto(), ilObjCategoryGUI\_goto(), ilObjMediaPoolGUI\_goto(), ilObjLinkResourceGUI\_goto(), ilObjGlossaryGUI\_goto(), ilObjExerciseGUI\_goto(), ilObjGroupGUI\_goto(), ilObjUserFolderGUI\_goto(), ilObjContentObjectGUI\_goto(), ilObjSystemFolderGUI\_goto(), ilObjSurveyGUI\_goto(), ilObjCourseGUI\_goto(), ilObjTestGUI\_goto(), ilContainerReferenceAccess\_isAccessible(), ilChangeEvent\_recordReadEvent(), ilObjRoleTemplateGUI\addAdminLocatorItems(), ilObjStyleSheetGUI\addAdminLocatorItems(), ilObjRoleGUI\addAdminLocatorItems(), ilObjUserGUI\addAdminLocatorItems(), ilNavigationHistory\addItem(), ilObjContentObjectGUI\addLocations(), ilPDSelectedItemsBlockGUI\addParentRow(), ilCalendarCategoryGUI\addReferenceLinks(), ilPaymentStatisticGUI\addStatisticWorksheet(), ilObjPaymentSettingsGUI\addStatisticWorksheet(), ilExportContainer\addSubitems(), ilContainerReferenceGUI\afterSave(), ilObjCourseGUI\askDeleteStarterObject(), ilSoapCourseAdministration\assignCourseMember(), ilSoapGroupAdministration\assignGroupMember(), ilDataLoader\assignUsersAsCourseMembers(), ilTableOfContentsExplorer\buildTitle(), ilLearningProgressAccess\checkAccess(), ilAccessHandler\checkAccessOfUser(), ilPrivacySettings\checkExportAccess(), ilContainer\cloneAllObject(), cloneDependencies(), ilContainerSorting\cloneSorting(), ilObjectCopyGUI\copyContainer(), ilContainerGUI\copyObject(), SurveyQuestion\createNewQuestion(), assQuestion\createNewQuestion(), ilObjRole\createPermissionIntersection(), ilObjectRolePermissionTableGUI\createTooltip(), ilAdministrationCommandGUI\delete(), ilSoapCourseAdministration\deleteCourse(), ilObjRole\deleteLocalPolicies(), ilRepUtil\deleteObjects(), ilObjGroup\determineViewMode(), ilLMEditorGUI\displayLocator(), ilSCORMPresentationGUI\downloadCertificate(), ilPCResourcesGUI\edit(), ilPaymentStatisticGUI\editStatistic(), ilObjPaymentSettingsGUI\editStatisticObject(), ilSoapCourseAdministration\excludeCourseMember(), ilSoapGroupAdministration\excludeGroupMember(), ilObjectPluginGUI\executeCommand(), ilWikiHandlerGUI\executeCommand(), ilShopGUI\executeCommand(), ilObjSurveyGUI\executeCopyQuestionsToPoolObject(), ilObjDlBook\export(), ilLMPresentationGUI\exportbibinfo(), ilWikiImportantPagesBlockGUI\fillDataSection(), ilRegistrationGUI\fillMembershipLimitation(), ilContentStylesTableGUI\fillRow(), ilLinksTableGUI\fillRow(), ilECSImportedContentTableGUI\fillRow(), ilPDNewsTableGUI\fillRow(), ilNewsForContextBlockGUI\fillRow(), ilUserTableGUI\fillRow(), ilChatroomViewTask\forcePublicRoom(), ilObjFolderGUI\forwardToTimingsView(), ilDataLoader\generateCalendarEntries(), ilCourseObjectiveMaterialAssignmentTableGUI\getAllSubObjects(), ilContainerGUI\getAsynchItemListObject(), ilObjectGUI\getCenterColumnHTML(), ilParticipants\getDefaultMemberRole(), ilObjWikiGUI\getGotoLink(), ilObjSurvey\getGroupData(), ilObjTest\getGroupData(), ilNavigationHistoryGUI\getHTML(), ilCalendarAppointmentPanelGUI\getHTML(), ilPathGUI\getHTML(), ilLocatorGUI\getHTML(), ilNavigationHistoryGUI\getHTMLOld(), ilCourseGroupingAssignmentTableGUI\getItems(), ilNavigationHistory\getItems(), ilLMPageObjectGUI\getLinkXML(), ilGlossaryPresentationGUI\getLinkXML(), ilLMPresentationGUI\getLinkXML(), ilImageMapEditorGUI\getMapAreaLinkString(), ilMainMenuGUI\getMemberViewHTML(), ilNewsItem\getNewsForRefId(), ilTrUserObjectsPropsTableGUI\getObjectHierarchy(), ilTrQuery\getObjectIds(), ilObjectRolePermissionTableGUI\getObjId(), ilObjectRoleTemplatePermissionTableGUI\getObjId(), ilObjSurvey\getQuestionblocksTable(), ilContainerContentGUI\getRightColumnHTML(), ilCourseContentGUI\getRightColumnHTML(), ilObjectGUI\getRightColumnHTML(), ilSoapUserAdministration\getUsersForContainer(), ilObjWorkspaceFolder\getViewMode(), ilObjFolder\getViewMode(), ilObjGroup\getViewMode(), ilSessionDataSet\getXmlRecord(), ilMembershipRegistrationCodeUtils\handleCode(), ilECSCategoryMapping\handleUpdate(), ilLMPresentationGUI\ilLocator(), ilObjectFeedWriter\ilObjectFeedWriter(), ilObjForumGUI\ilObjForumGUI(), ilUserFeedWriter\ilUserFeedWriter(), ilObjSessionGUI\infoScreen(), ilObjectCopyGUI\init(), ilSubItemListGUI\init(), ilUserTableGUI\initFilter(), ilCalendarAppointmentGUI\initForm(), ilObjGroupGUI\initForm(), ilConditionHandlerInterface\initFormCondition(), ilLuceneSearchGUI\initFormSearch(), ilCalendarCategories\initialize(), ilWikiPageGUI\initPrintViewSelectionForm(), ilLPCollectionSettingsTableGUI\initTable(), ilObjectCopyGUI\initTargetSelection(), ilPCContentIncludeGUI\insertFromPool(), ilPCMediaObjectGUI\insertFromPool(), ilPCQuestionGUI\insertFromPool(), ilPageObject\insertInstIntoIDs(), ilObjectListGUI\insertSubscribeCommand(), ilSoapCourseAdministration\isAssignedToCourse(), ilSoapGroupAdministration\isAssignedToGroup(), ilAdministrationGUI\jump(), ilHACPPresentationGUI\launchSahs(), ilAICCPresentationGUI\launchSahs(), ilSAHSPresentationGUI\launchSahs(), ilSCORMPresentationGUI\launchSahs(), ilContainerSortingSettings\lookupSortModeFromParentContainer(), ilObjExerciseGUI\membersObject(), ilObjSessionGUI\membersObject(), ilObjSessionGUI\modifyItemGUI(), ilObjGroupGUI\modifyItemGUI(), ilObjFolderGUI\modifyItemGUI(), ilLMPresentationGUI\offlineexport(), ilECSCategoryMappingTableGUI\parse(), ilCourseObjectivesTableGUI\parse(), ilLPCollectionSettingsTableGUI\parseCollection(), ilLPCollectionSettingsTableGUI\parseCollectionItem(), ilLPCollectionSettingsTableGUI\parseScormCollection(), ilAdministrationCommandGUI\paste(), ilAdministrationCommandGUI\performPasteIntoMultipleObjects(), ilObjWorkspaceFolderGUI\performPasteIntoMultipleObjects(), ilObjRoleGUI\perm2Object(), ilObjSessionGUI\printAttendanceListObject(), ilObjSessionGUI\printViewMembersObject(), ilStartUpGUI\processStartingPage(), ilPurchase\purchase(), ilObjHACPTracking\putparam(), ilObjTest\randomSelectQuestions(), ilBookingScheduleGUI\render(), ilMainMenuGUI\renderEntry(), ilUtil\replaceLinkProperties(), ilAccountMail\replacePlaceholders(), ilRepUtil\restoreObjects(), ilExportGUI\saveItemSelection(), ilObjSCORM2004LearningModuleGUI\selectGlossary(), ilCronCourseGroupNotification\sendMail(), ilHACPResponse\sendParam(), ilPageObjectGUI\setDefaultLinkXml(), ilContainerContentGUI\setOutput(), ilQuestionEditGUI\setPoolRefId(), ilMailNotification\setRefId(), ilMainMenuGUI\setTemplateVars(), ilCalendarBlockGUI\showCalendarSubscription(), ilShopGUI\showContainerContent(), ilRepUtilGUI\showDeleteConfirmation(), ilInternalLinkGUI\showLinkHelp(), ilAdministrationCommandGUI\showLinkIntoMultipleObjectsTree(), ilMemberViewGUI\showMemberViewSwitch(), ilAdministrationCommandGUI\showMoveIntoObjectTree(), ilNewsForContextBlockGUI\showNews(), ilMailSearchGUI\showResults(), ilShopGUI\showShopExplorer(), ilShopGUI\showSpecialContent(), ilPaymentStatisticGUI\showStatistics(), ilNoteGUI\showTargets(), ilRepositoryGUI\showTree(), ilObjPaymentSettingsGUI\statisticObject(), ilObjSCORMTracking\store(), ilObjSCORMTracking\storeJsApi(), ilObjectTest\testSetGetLookup(), ilObjectTest\testTreeTrash(), ilSoapCourseAdministration\updateCourse(), ilObjSessionGUI\updateMembersObject(), ilContainerReferenceGUI\updateObject(), ilMembershipRegistrationCodeUtils\useCode(), ilECSCategoryMappingRule\validate(), ilSoapObjectAdministration\validateReferences(), ilPDNewsGUI\view(), ilCourseContentGUI\view(), ilBasicSkill\writeLevelTrigger(), and ilContainerXmlWriter\writeSubitems().

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

Here is the caller graph for this function:

static ilObject::_lookupObjIdByImportId ( $a_import_id )

static

Reimplemented in ilObject2.

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

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

Referenced by ilSoapObjectAdministration\addObject(), ilSoapObjectAdministration\getObjIdByImportId(), ilSoapObjectAdministration\getRefIdsByImportId(), ilRoleXmlImporter\initRole(), ilAuthContainerECS\loginObserver(), ilSoapObjectAdministration\removeFromSystemByImportId(), and ilObjectTest\testSetGetLookup().

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

Here is the caller graph for this function:

ilObject::_lookupOwner ( $a_id )

lookup object owner

Parameters

int $a_id object id

Reimplemented in ilObject2.

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

References $owner.

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

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

Here is the caller graph for this function:

ilObject::_lookupOwnerName ( $a_owner_id )

lookup owner name for owner id

Reimplemented in ilObject2.

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

static ilObject::_lookupTitle ( $a_id )

static

lookup object title

Parameters

int $a_id object id

Reimplemented in ilObject2, and ilContainerReference.

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

        {
                global $ilObjDataCache;
                $tit = $ilObjDataCache->lookupTitle($a_id);     
                return $tit;
        }

Here is the caller graph for this function:

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

static

lookup object type

Parameters

int $a_id object id

Reimplemented in ilObject2.

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

References $ilDB.

        {
                global $ilObjDataCache;
                if($a_reference)
                {
                        return $ilObjDataCache->lookupType($ilObjDataCache->lookupObjId($a_id));
                }
                return $ilObjDataCache->lookupType($a_id);
                global $ilDB;
                if ($a_reference === true)
                {
                        $q = "SELECT type FROM object_reference obr, object_data obd ".
                                "WHERE obr.ref_id = ".$ilDB->quote($a_id, "integer")." ".
                                "AND obr.obj_id = obd.obj_id ";
                }
                else
                {
                        $q = "SELECT type FROM object_data WHERE obj_id = ".$ilDB->quote($a_id, "integer");
                }
                $obj_set = $ilDB->query($q);
                $obj_rec = $ilDB->fetchAssoc($obj_set);
                return $obj_rec["type"];
        }

Here is the caller graph for this function:

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

static

Prepare copy wizard object selection.

public

Parameters

array int array of ref ids

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilObject::_resetDeletedDate ( $a_ref_id )

only called in ilObjectGUI::insertSavedNodes

Reimplemented in ilObject2.

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

References $ilDB, $query, and $res.

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

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

Here is the caller graph for this function:

ilObject::_setDeletedDate ( $a_ref_id )

only called in ilTree::saveSubTree

Reimplemented in ilObject2.

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

References $ilDB, $query, and $res.

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

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

Here is the caller graph for this function:

ilObject::_writeDescription	(	$a_obj_id,
		$a_desc
	)

write description to db (static)

Parameters

int	$a_obj_id	object id
string	$a_desc	description public

Reimplemented in ilObject2.

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

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

Referenced by ilObjMediaObject\MDUpdateListener().

        {
                global $ilDB,$objDefinition;
                $desc = ilUtil::shortenText($a_desc,MAXLENGTH_OBJ_DESC,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($this->getType()))
                {
                        // 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',$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);
                        }
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

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 public

Reimplemented in ilObject2.

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

References $ilDB.

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

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

Here is the caller graph for this function:

ilObject::_writeTitle	(	$a_obj_id,
		$a_title
	)

write title to db (static)

Parameters

int	$a_obj_id	object id
string	$a_title	title public

Reimplemented in ilObject2.

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

References $ilDB.

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

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

Here is the caller graph for this function:

ilObject::appendCopyInfo	(	$a_target_id,
		$a_copy_id
	)

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

public

Parameters

int copy_id

Reimplemented in ilObject2.

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

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

Referenced by cloneObject().

        {
                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;
                $title = ilObjFileAccess::_appendNumberOfCopyToFilename($this->getTitle(), $numberOfCopy);
                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);
                        }
                        else
                        {
                                break;
                        }
                }
                return $title;
        }       

Here is the call graph for this function:

Here is the caller graph for this function:

ilObject::applyDidacticTemplate ( $a_tpl_id )

Apply template.

Parameters

int $a_tpl_id

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

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

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

Here is the call graph for this function:

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.

public

Parameters

int	ref_id of target object
int	copy_id

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

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

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

        {
                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->storeCondition();
                        }
                }
                return true;
        }

Here is the call graph for this function:

ilObject::cloneMetaData ( $target_obj )

Copy meta data.

public

Parameters

object target object

Reimplemented in ilObject2.

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

References getId(), and getType().

Referenced by ilObjLinkResource\cloneObject(), ilObjCourse\cloneObject(), ilObjContentObject\cloneObject(), ilObjSurvey\cloneObject(), and ilObjTest\cloneObject().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

Clone object permissions, put in tree ...

public

Parameters

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

Returns: object new object

Reimplemented in ilObject2, and ilObjChatroom.

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

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

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

Here is the call graph for this function:

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

staticfinal

Collect deletion dependencies.

E.g.

Parameters

@return

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

References $id, $location, and $type.

Referenced by ilRepUtilGUI\showDeleteConfirmation().

        {
                global $objDefinition, $tree;
                if ($a_depth == 0)
                {
                        $deps["dep"] = array();
                }
                
                $deps["del_ids"][$a_obj_id] = $a_obj_id;
                
                if (!$objDefinition->isPlugin($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"];
                }               
        }

Here is the caller graph for this function:

ilObject::countReferences ( )

count references of object

public

Returns: integer number of references for this object

Reimplemented in ilObject2.

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

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

Referenced by delete().

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

Here is the caller graph for this function:

ilObject::create ( )

create

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

public

Returns: integer object id

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

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

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

Referenced by ilObjGlossary\create(), ilObjSAHSLearningModule\create(), ilObjQuestionPool\create(), ilObjContentObject\create(), ilObjLinkResource\create(), ilObjSurveyQuestionPool\create(), ilObject2\create(), ilObjSurvey\create(), ilObjWiki\create(), ilObjRemoteCourse\create(), ilObjMediaObject\create(), ilObjTest\create(), ilObjStyleSheet\create(), ilObjStyleSheet\createFromXMLFile(), and ilObjStyleSheet\import().

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilObject::createMetaData ( )

create meta data entry

Reimplemented in ilObjTest, ilObjSurvey, ilObjMediaObject, and ilObject2.

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

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

Referenced by ilObjGlossary\create(), ilObjSAHSLearningModule\create(), ilObjQuestionPool\create(), ilObjContentObject\create(), ilObjLinkResource\create(), ilObjSurveyQuestionPool\create(), ilObjFileBasedLM\create(), ilObjCourse\create(), and updateMetaData().

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilObject::createReference ( )

creates reference for object

public

Returns: integer reference_id of object

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

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

References $ilDB, $query, and $ref_id.

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

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

Here is the caller graph for this function:

ilObject::createRoleFolder ( )

creates a local role folder

public

Parameters

string	rolefolder title
string	rolefolder description
object	parent object where the rolefolder is attached to

Returns: object rolefolder object

Reimplemented in ilObject2.

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

References getId(), and getRefId().

Referenced by ilObjChatroom\initDefaultRoles(), ilObjContentObject\initDefaultRoles(), ilObjiLincCourse\initDefaultRoles(), ilObjForum\initDefaultRoles(), ilObjCourse\initDefaultRoles(), and ilObjGroup\initDefaultRoles().

        {
                global $rbacreview;
                
                // does a role folder already exists?
                // (this check is only 'to be sure' that no second role folder is created under one object.
                // the if-construct should never return true)
                if ($rolf_data = $rbacreview->getRoleFolderofObject($this->getRefId()))
                {
                        $rfoldObj = $this->ilias->obj_factory->getInstanceByRefId($rolf_data["ref_id"]);
                }
                else
                {
                        include_once ("./Services/AccessControl/classes/class.ilObjRoleFolder.php");
                        $rfoldObj = new ilObjRoleFolder();
                        $rfoldObj->setTitle($this->getId());
                        $rfoldObj->setDescription(" (ref_id ".$this->getRefId().")");
                        $rfoldObj->create();
                        $rfoldObj->createReference();
                        $rfoldObj->putInTree($this->getRefId());
                        $rfoldObj->setPermissions($this->getRefId());
                }
                
                return $rfoldObj;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

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

public

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

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

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

References $ilDB, $log, $query, $res, ilBlockSetting\_deleteSettingsOfBlock(), _lookupType(), countReferences(), ilDidacticTemplateObjSettings\deleteByObjId(), ilDidacticTemplateObjSettings\deleteByRefId(), getId(), getRefId(), getTitle(), getType(), and ilUtil\removeItemFromDesktops().

        {
                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
                        $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)
                {
                        // 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;
        }

Here is the call graph for this function:

ilObject::deleteMetaData ( )

delete meta data entry

Reimplemented in ilObjMediaObject, and ilObject2.

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

References getId(), and getType().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilObject::getCreateDate ( )

get create date public

Returns: string creation date

Reimplemented in ilObject2.

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

References $create_date.

Referenced by ilObjUser\getProfileAsString().

        {
                return $this->create_date;
        }

Here is the caller graph for this function:

static ilObject::getDeletionDependencies ( $a_obj_id )

static

Get deletion dependencies.

Reimplemented in ilObjGlossary.

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

        {
                return false;   
        }

ilObject::getDescription ( )

get object description

public

Returns: string object description

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

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

References $desc.

Referenced by ilObjCategoryGUI\afterSave(), create(), ilObjExerciseVerification\createFromExercise(), ilObjTestVerification\createFromTest(), ilObjStyleSheet\getXML(), ilObjStyleSheet\ilClone(), ilObjRoleGUI\readRoleProperties(), ilObjForum\saveData(), ilObjSurvey\toXML(), ilObjTest\toXML(), ilObjiLincClassroom\update(), ilObjForum\update(), and update().

        {
                return $this->desc;
        }

Here is the caller graph for this function:

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, ilObjSAHSLearningModule, ilObjMediaCast, ilObjFileBasedLM, and ilObjForum.

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

        {
                return null;
        }

ilObject::getHTMLDirectory ( )

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

        {
                return false;
        }

ilObject::getId ( )

get object id public

Returns: integer object id

Reimplemented in ilObjMediaObject, ilCourseStart, and ilObject2.

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

References $id.

        {
                return $this->id;
        }

Here is the caller graph for this function:

ilObject::getImportId ( )

get import id

public

Returns: string import id

Reimplemented in ilObjMediaObject, ilObjContentObject, and ilObject2.

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

References $import_id.

Referenced by create(), and update().

        {
                return $this->import_id;
        }

Here is the caller graph for this function:

ilObject::getLastUpdateDate ( )

get last update date public

Returns: string date of last update

Reimplemented in ilObject2.

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

References $last_update.

        {
                return $this->last_update;
        }

ilObject::getLongDescription ( )

get object long description (stored in object_description)

public

Returns: string object description

Reimplemented in ilObjLanguageExt, and ilObject2.

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

References $desc.

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

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

Here is the caller graph for this function:

ilObject::getOwner ( )

get object owner

public

Returns: integer owner id

Reimplemented in ilObject2.

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

References $owner.

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

        {
                return $this->owner;
        }

Here is the caller graph for this function:

ilObject::getOwnerName ( )

Reimplemented in ilObject2.

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

References _lookupOwnerName(), and getOwner().

Referenced by ilObjUserTracking\getAccessTotalPerObj().

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilObject::getPresentationTitle ( )

get presentation title Normally same as title Overwritten for sessions

public

Parameters

@return

Reimplemented in ilObjSession, ilObjRole, and ilObject2.

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

References getTitle().

        {
                return $this->getTitle();
        }

Here is the call graph for this function:

ilObject::getRefId ( )

get reference id public

Returns: integer reference id

Reimplemented in ilObjStyleSheet, ilCourseStart, ilObjMediaObject, and ilObject2.

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

References $ref_id.

Referenced by ilObjCourse\__getLocalRoles(), ilObjCourse\__setCourseStatus(), ilObjFolder\addAdditionalSubItemInformation(), ilObjGroup\addAdditionalSubItemInformation(), ilObjBookingPoolGUI\afterSave(), ilObjLinkResourceGUI\afterSave(), ilObjiLincCourseGUI\afterSave(), ilObjSurveyGUI\afterSave(), ilObjCategoryGUI\afterSave(), ilObjSurveyQuestionPoolGUI\afterSave(), ilObjTestGUI\afterSave(), ilObjExerciseGUI\afterSave(), ilObjQuestionPoolGUI\afterSave(), ilObjForumGUI\afterSave(), ilObjContentObjectGUI\afterSave(), ilObjCourseGUI\afterSave(), applyDidacticTemplate(), ilObjForum\cloneAutoGeneratedRoles(), ilObjGroup\cloneAutoGeneratedRoles(), ilObjCourse\cloneAutoGeneratedRoles(), ilObjFolder\cloneDependencies(), ilObjGroup\cloneDependencies(), ilObjCourse\cloneDependencies(), cloneDependencies(), ilObjForum\cloneObject(), cloneObject(), ilObjTest\cloneObject(), ilDidacticTemplateLocalPolicyAction\createLocalPolicy(), ilObjTest\createRandomSolutions(), ilObjRoleFolder\createRole(), createRoleFolder(), ilObjTest\createTestSession(), ilObjRoleFolder\delete(), delete(), ilObjSurvey\disinviteUser(), ilObjFolder\downloadFolder(), ilObjSCORMLearningModule\exportSelected(), ilObjSCORMLearningModule\exportSelectedRaw(), ilDidacticTemplateAction\filterRoles(), ilObjiLincCourse\getAdminIds(), ilObjGlossary\getAllGlossaryIds(), ilObjCourse\getDefaultCourseRoles(), ilObjGroup\getDefaultGroupRoles(), ilObjiLincCourse\getDefaultRoles(), ilObjGroup\getGroupAdminIds(), ilObjCourse\getLocalCourseRoles(), ilObjGroup\getLocalGroupRoles(), ilObjiLincCourse\getLocalRoles(), ilContainer\getSubItems(), ilObjSurvey\getSurveyCodesForExport(), ilObjSurvey\getSurveyCodesTableData(), ilObjContentObject\importFromDirectory(), ilObjCourse\initCourseItemObject(), ilObjChatroom\initDefaultRoles(), ilObjiLincCourse\initDefaultRoles(), ilObjForum\initDefaultRoles(), ilObjCourse\initDefaultRoles(), ilObjGroup\initDefaultRoles(), ilObjGroup\initGroupStatus(), ilObjSurvey\inviteGroup(), ilObjSurvey\inviteRole(), ilObjSurvey\inviteUser(), ilObjRoleFolder\isDeleted(), ilObjGroup\leaveGroup(), ilObjTest\logAction(), MDUpdateListener(), ilObjRoleFolder\purge(), ilObjFolder\putInTree(), putInTree(), ilObject2GUI\putObjectInTree(), ilObjectGUI\putObjectInTree(), ilObjGroup\readGroupStatus(), ilObjCourse\register(), ilObjGroup\register(), ilDidacticTemplateLocalPolicyAction\revertLocalPolicy(), ilObjSurvey\sendCodes(), ilObjSCORMLearningModule\sendExportFile(), ilObjExercise\sendFeedbackFileNotification(), setPermissions(), ilObjTest\setTestSession(), update(), and ilObjGroup\updateGroupType().

        {
                return $this->ref_id;
        }

Here is the caller graph for this function:

ilObject::getTitle ( )

get object title public

Returns: string object title

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

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

References $title.

Referenced by ilObjExercise\__formatSubject(), ilObjCategoryGUI\afterSave(), appendCopyInfo(), cloneObject(), create(), ilObjExerciseVerification\createFromExercise(), ilObjTestVerification\createFromTest(), createMetaData(), delete(), ilObjTest\deliverPDFfromFO(), ilObjTest\deliverPDFfromHTML(), ilObjFolder\downloadFolder(), ilObjExercise\exportGradesExcel(), ilObjSCORM2004LearningModule\exportHTML(), ilTermUsagesTableGUI\fillRow(), ilObjRoleTemplate\getFilterOfInternalTemplate(), ilObjRole\getPresentationTitle(), ilObjSession\getPresentationTitle(), getPresentationTitle(), ilObjStyleSheet\getXML(), ilObjStyleSheet\ilClone(), ilObjSurvey\isComplete(), ilObjRole\isDeletable(), ilObjRoleTemplate\isInternalTemplate(), ilObjCourse\prepareAppointments(), ilObjGroup\prepareAppointments(), ilObjSession\prepareCalendarAppointments(), putInTree(), ilObjRoleGUI\readRoleProperties(), ilObjForum\saveData(), ilObjTest\sendAdvancedNotification(), ilObjSurvey\sendNotificationMail(), ilObjTest\sendSimpleNotification(), ilObjSurvey\toXML(), ilObjTest\toXML(), ilObjiLincClassroom\update(), ilObjForum\update(), update(), updateMetaData(), ilObjRole\validate(), ilObjGroup\validate(), and ilObjCourse\validate().

        {
                return $this->title;
        }

Here is the caller graph for this function:

ilObject::getType ( )

get object type public

Returns: string object type

Reimplemented in ilObject2.

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

References $type.

Referenced by ilObjExercise\__formatBody(), appendCopyInfo(), ilObjSurvey\cleanupMediaobjectUsage(), ilObjTest\cleanupMediaobjectUsage(), cloneMetaData(), ilObjSurveyQuestionPool\cloneObject(), ilContainer\cloneObject(), ilObjQuestionPool\cloneObject(), cloneObject(), ilObjGlossary\createExportDirectory(), ilObjMediaObject\createMetaData(), createMetaData(), ilObjExternalFeed\delete(), delete(), ilObjMediaObject\deleteMetaData(), deleteMetaData(), ilObjContentObject\executeDragDrop(), ilObjGlossary\exportHTML(), ilObjContentObject\exportHTML(), ilObjContentObject\exportHTMLPages(), ilObjContentObject\exportSCORM(), ilObjContentObject\exportXML(), ilObjQuestionPool\exportXMLMetaData(), ilObjGlossary\exportXMLMetaData(), ilObjContentObject\exportXMLMetaData(), ilObjSCORM2004LearningModule\exportXMLMetaData(), ilObjTest\exportXMLMetaData(), ilObjContentObject\exportXMLPageObjects(), ilObjSurvey\getAuthor(), ilObjTest\getAuthor(), ilObjGlossary\getExportDirectory(), ilObjGlossary\getExportFiles(), ilObjSCORM2004LearningModule\getExportFiles(), ilObjExternalFeed\getFeedBlock(), ilContainer\getGroupedObjTypes(), ilObjMediaObject\getXML(), ilObjStyleSheet\ilClone(), ilObjContentObject\importFromDirectory(), ilObjLinkResource\MDUpdateListener(), ilObjMediaObject\MDUpdateListener(), MDUpdateListener(), ilObj< module_name >\notify(), ilObjSkillManagement\notify(), ilObjAssessmentFolder\notify(), ilObjAccessibilitySettings\notify(), ilObjMediaObjectsSettings\notify(), ilObjExternalToolsSettings\notify(), ilObjRecoveryFolder\notify(), ilObjAdvancedEditing\notify(), ilObjSurveyAdministration\notify(), ilObjComponentSettings\notify(), ilObjNewsSettings\notify(), ilObjMediaCastSettings\notify(), ilObjTaggingSettings\notify(), ilObjLearningResourcesSettings\notify(), ilObjPersonalDesktopSettings\notify(), ilObjExternalFeed\notify(), ilObjStyleSheetFolder\notify(), ilObjAuthSettings\notify(), ilObjBookingPool\notify(), ilObjQuestionPool\notify(), ilObjStyleSettings\notify(), ilObjFileBasedLM\notify(), ilObjMediaPool\notify(), ilObjSurveyQuestionPool\notify(), ilObjMediaCast\notify(), ilObjWiki\notify(), ilObjSurvey\notify(), ilObjTest\notify(), ilObjSAHSLearningModule\notify(), ilObjGlossary\notify(), ilObjContentObject\notify(), putInTree(), ilObjMediaCast\readItems(), ilObjSurvey\saveAuthorToMetadata(), ilObjTest\saveAuthorToMetadata(), setPermissions(), ilObjSurveyQuestionPool\toXML(), ilObjSurvey\toXML(), ilObjNull\update(), update(), ilObjQuestionPool\updateMetaData(), ilObjMediaObject\updateMetaData(), updateMetaData(), and ilObjContentObject\validatePages().

        {
                return $this->type;
        }

Here is the caller graph for this function:

ilObject::getUntranslatedTitle ( )

get untranslated object title public

Returns: string object title

Reimplemented in ilObject2.

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

References $untranslatedTitle.

        {
                return $this->untranslatedTitle;
        }

ilObject::getXMLZip ( )

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

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

        {
                return false;
        }

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

Constructor public.

Parameters

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

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

References $ilBench, $ilias, $lng, and read().

        {
                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 = MAXLENGTH_OBJ_TITLE;
                $this->max_desc = MAXLENGTH_OBJ_DESC;
                $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");
        }

Here is the call graph for this function:

Here is the caller graph for this function:

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

Returns: array empty array

Reimplemented in ilObjGroup, ilObjCourse, ilObjForum, ilObjTest, ilObjWiki, ilObjMediaCast, ilObjiLincCourse, ilObject2, ilObjMediaPool, ilObjFileBasedLM, ilObjStyleSettings, ilObjQuestionPool, ilObjBookingPool, ilObjAuthSettings, ilObjExternalFeed, ilObjStyleSheetFolder, ilObjLearningResourcesSettings, ilObjMediaCastSettings, ilObjNewsSettings, ilObjPersonalDesktopSettings, ilObjTaggingSettings, ilObjComponentSettings, ilObjSurveyAdministration, ilObjAssessmentFolder, ilObjAdvancedEditing, ilObjRecoveryFolder, ilObjExternalToolsSettings, ilObjAccessibilitySettings, ilObjMediaObjectsSettings, ilObjSkillManagement, ilObj< module_name >, ilObjContentObject, and ilObjChatroom.

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

Referenced by setPermissions().

        {
                return array();
        }

Here is the caller graph for this function:

ilObject::isUserRegistered ( $a_user_id = 0 )

Reimplemented in ilObject2.

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

        {
                return false;
        }

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, ilObjMediaObject, ilObject2, and ilObjLinkResource.

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

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

Referenced by ilObjContentObject\importFromDirectory().

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

Here is the call graph for this function:

Here is the caller graph for this function:

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

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 ilObjGroup, ilObjContentObject, ilObjGlossary, ilObjSAHSLearningModule, ilObjTest, ilObjSurvey, ilObjWiki, ilObjiLincCourse, ilObjMediaCast, ilObjSurveyQuestionPool, ilObjMediaPool, ilObjFileBasedLM, ilObject2, ilObjStyleSettings, ilObjQuestionPool, ilObjBookingPool, ilObjAuthSettings, ilObjExternalFeed, ilObjStyleSheetFolder, ilObjLearningResourcesSettings, ilObjMediaCastSettings, ilObjNewsSettings, ilObjPersonalDesktopSettings, ilObjTaggingSettings, ilObjComponentSettings, ilObjSurveyAdministration, ilObjAdvancedEditing, ilObjRecoveryFolder, ilObjExternalToolsSettings, ilObjAccessibilitySettings, ilObjMediaObjectsSettings, ilObjAssessmentFolder, ilObjSkillManagement, ilObj< module_name >, ilObjRootFolder, and ilObjWorkspaceRootFolder.

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

Referenced by ilObjContentObjectGUI\afterSave().

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

Here is the caller graph for this function:

ilObject::putInTree ( $a_parent_ref )

maybe this method should be in tree object!?

Todo:: role/rbac stuff

Reimplemented in ilObjContentObject, ilObject2, and ilObjFolder.

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilObject::read ( $a_force_db = false )

read object data from db into object

Parameters

boolean public

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

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

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

Referenced by ilObject().

        {
                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)
                        {
                                $message = "ilObject::read(): Object with obj_id: ".$this->id." (".$this->type.") not found!";
                                $this->ilias->raiseError($message,$this->ilias->error_obj->WARNING);
                        }
                        $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
                        $this->ilias->raiseError("ilObject::read(): Type mismatch. (".$this->type."/".$this->id.")",$this->ilias->error_obj->WARNING);
                }
                
                $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->desc = $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");
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObject::requireRegistration ( )

Reimplemented in ilObject2.

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

References $register.

        {
                return $this->register;
        }

ilObject::setDescription ( $a_desc )

set object description

public

Parameters

string $a_desc object description

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

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

References ilUtil\shortenText().

Referenced by ilObjRole\assignData(), ilObjTest\fromXML(), ilObjLanguage\install(), ilObjRoleGUI\loadRoleProperties(), MDUpdateListener(), ilObjRoleFolder\read(), ilObjiLincClassroom\read(), read(), ilObjLanguageExt\setLocal(), ilObjLanguage\uninstall(), and ilObjRemoteCourse\updateFromECSContent().

        {
                // 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;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObject::setId ( $a_id )

set object id public

Parameters

integer $a_id object id

Reimplemented in ilObjMediaObject, ilCourseStart, and ilObject2.

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

Referenced by ilObjUser\ilObjUser().

        {
                $this->id = $a_id;
        }

Here is the caller graph for this function:

ilObject::setImportId ( $a_import_id )

set import id

public

Parameters

string $a_import_id import id

Reimplemented in ilObjMediaObject, ilObjContentObject, and ilObject2.

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

Referenced by ilCategoryImportParser\handlerBeginTag().

        {
                $this->import_id = $a_import_id;
        }

Here is the caller graph for this function:

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 public

Returns: integer object id

Reimplemented in ilObject2.

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

        {
                $this->obj_data_record = $a_record;
        }

ilObject::setOwner ( $a_owner )

set object owner

public

Parameters

integer $a_owner owner id

Reimplemented in ilObject2.

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

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

        {
                $this->owner = $a_owner;
        }

Here is the caller graph for this function:

ilObject::setPermissions ( $a_parent_ref )

set permissions of object

Parameters

integer reference_id of parent object public

Reimplemented in ilObject2.

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

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

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

        {
                global $rbacadmin, $rbacreview;
                $parentRoles = $rbacreview->getParentRoleIds($a_parent_ref);
                foreach ($parentRoles as $parRol)
                {
                        $ops = $rbacreview->getOperationsOfRole($parRol["obj_id"], $this->getType(), $parRol["parent"]);
                        $rbacadmin->grantPermission($parRol["obj_id"], $ops, $this->getRefId());
                }
                $this->initDefaultRoles();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObject::setRefId ( $a_id )

set reference id public

Parameters

integer $a_id reference id

Reimplemented in ilCourseStart, and ilObject2.

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

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

ilObject::setRegisterMode ( $a_bool )

Reimplemented in ilObject2.

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

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

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

Here is the caller graph for this function:

ilObject::setTitle ( $a_title )

set object title

public

Parameters

string $a_title object title

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

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

References $title, and ilUtil\shortenText().

Referenced by ilObjRole\assignData(), ilObjTest\fromXML(), ilObjRoleGUI\loadRoleProperties(), MDUpdateListener(), ilObjRoleFolder\read(), ilObjiLincClassroom\read(), ilObjLanguage\uninstall(), and ilObjRemoteCourse\updateFromECSContent().

        {
                $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
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilObject::setType ( $a_type )

set object type public

Parameters

integer $a_type object type

Reimplemented in ilObject2.

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

        {
                $this->type = $a_type;
        }

ilObject::update ( )

update object in db

public

Returns: boolean true on success

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

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

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

Referenced by ilObjBookingPoolGUI\afterSave(), ilContainerReferenceGUI\afterSave(), ilObjContentObjectGUI\afterSave(), ilObjCourseGUI\afterSave(), ilObjLanguage\install(), MDUpdateListener(), ilObjLanguageExt\setLocal(), ilObjLanguage\uninstall(), and ilObjMediaObject\update().

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilObject::updateMetaData ( )

update meta data entry

Reimplemented in ilObjMediaObject, ilObject2, and ilObjQuestionPool.

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilObject::updateOwner ( )

update owner of object in db

public

Returns: boolean true on success

Reimplemented in ilObject2.

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

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

Referenced by ilObjUser\update().

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

Here is the call graph for this function:

Here is the caller graph for this function:

ilObject::withReferences ( )

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

Reimplemented in ilObject2.

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

References $referenced.

Referenced by ilObjFolder\putInTree().

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

Here is the caller graph for this function: