Inheritance diagram for ilObjStudyProgrammeReference:

Collaboration diagram for ilObjStudyProgrammeReference:

Public Member Functions
	__construct ($a_id=0, $a_call_by_reference=true)
	Constructor. More...

	putInTree ($a_parent_ref)
	Overwritten from ilObject. More...

	getParent ()

	getReferencedObject ()

Public Member Functions inherited from ilContainerReference
	__construct ($a_id=0, $a_call_by_reference=true)
	Constructor. More...

	getTargetId ()
	get target id More...

	setTargetId ($a_target_id)
	set target id More...

	setTargetRefId ($a_id)
	set target ref_id More...

	getTargetRefId ()
	get Target ref_id More...

	getTitleType ()
	get title type More...

	setTitleType ($type)
	Set title type. More...

	read ()
	read More...

	getPresentationTitle ()
	Get presentation title. More...

	update ()

	delete ()
	delete More...

	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	Clone course reference. More...

Public Member Functions inherited from ilObject
	__construct ($a_id=0, $a_reference=true)
	Constructor public. More...

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

	read ()
	read object data from db into object More...

	getId ()
	get object id public More...

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

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

	getRefId ()
	get reference id public More...

	getType ()
	get object type public More...

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

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

	getTitle ()
	get object title public More...

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

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

	getDescription ()
	get object description More...

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

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

	getImportId ()
	get import id More...

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

	setOfflineStatus ($a_status)
	Set offline status. More...

	getOfflineStatus ()
	Get offline status. More...

	supportsOfflineHandling ()
	Check whether object supports offline handling. More...

	getOwner ()
	get object owner More...

	getOwnerName ()

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

	getCreateDate ()
	get create date public More...

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

	getDiskUsage ()
	Gets the disk usage of the object in bytes. More...

	create ()
	create More...

	update ()
	update object in db More...

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

	createMetaData ()
	create meta data entry More...

	updateMetaData ()
	update meta data entry More...

	deleteMetaData ()
	delete meta data entry More...

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

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

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

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

	createReference ()
	creates reference for object More...

	countReferences ()
	count references of object More...

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

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

	setRegisterMode ($a_bool)

	isUserRegistered ($a_user_id=0)

	requireRegistration ()

	getXMLZip ()

	getHTMLDirectory ()

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

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

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

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

Protected Attributes
	$referenced_object

Protected Attributes inherited from ilContainerReference
	$user

	$db = null

	$target_id = null

	$target_ref_id = null

	$title_type = self::TITLE_TYPE_REUSE

Protected Attributes inherited from ilObject
	$objDefinition

	$db

	$log

	$error

	$tree

	$app_event_handler

	$rbacadmin

	$rbacreview

Additional Inherited Members
Static Public Member Functions inherited from ilContainerReference
static	_lookupTargetId ($a_obj_id)
	lookup target id More...

static	_lookupTargetRefId ($a_obj_id)
	Lookup target ref_id. More...

static	_lookupTitle ($a_obj_id)
	Overwitten from base class. More...

static	_lookupTargetTitle ($a_obj_id)
	Lookup target title. More...

static	_lookupSourceId ($a_target_id)
	lookup source id More...

static	_lookupSourceIds ($a_target_id)
	Get ids of all container references that target the object with the given id. More...

Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)

static	_lookupImportId ($a_obj_id)

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

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

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

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

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

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

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

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

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

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

static	_lookupObjId ($a_id)

static	_setDeletedDate ($a_ref_id, $a_deleted_by)

static	setDeletedDates ($a_ref_ids, $a_user_id)
	Set deleted date. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Data Fields inherited from ilContainerReference
const	TITLE_TYPE_REUSE = 1

const	TITLE_TYPE_CUSTOM = 2

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

const	DESC_LENGTH = 128

	$lng

	$id

	$ref_id

	$type

	$title

	$untranslatedTitle

	$desc

	$long_desc

	$owner

	$create_date

	$last_update

	$import_id

	$register = false

	$referenced

	$objectList

	$max_title

	$max_desc

	$add_dots

Detailed Description

Definition at line 3 of file class.ilObjStudyProgrammeReference.php.

Constructor & Destructor Documentation

◆ __construct()

ilObjStudyProgrammeReference::__construct	(	$a_id = `0`,
		$a_call_by_reference = `true`
	)

Constructor.

Parameters

int	$a_id	reference id
bool	$a_call_by_reference

Definition at line 11 of file class.ilObjStudyProgrammeReference.php.

References $DIC, and ILIAS\GlobalScreen\Provider\__construct().

     {
         global $DIC;
         $this->type = 'prgr';
         $this->tree = $DIC['tree'];
         parent::__construct($a_id, $a_call_by_reference);
     }

Here is the call graph for this function:

Member Function Documentation

◆ getParent()

ilObjStudyProgrammeReference::getParent ( )

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

References ilObjStudyProgramme\getInstanceByRefId(), and ilObject\getRefId().

                                 : ?\ilObjStudyProgramme
     {
         $parent_data = $this->tree->getParentNodeData($this->getRefId());
         if ($parent_data["type"] === "prg" && !$parent_data["deleted"]) {
             return ilObjStudyProgramme::getInstanceByRefId($parent_data["ref_id"]);
         }
         return null;
     }

Here is the call graph for this function:

◆ getReferencedObject()

ilObjStudyProgrammeReference::getReferencedObject ( )

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

References $referenced_object, and ilObjStudyProgramme\getInstanceByRefId().

Referenced by putInTree().

     {
         if (!$this->referenced_object) {
             $this->referenced_object = ilObjStudyProgramme::getInstanceByRefId($this->target_ref_id);
         }
         return $this->referenced_object;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ putInTree()

ilObjStudyProgrammeReference::putInTree ( $a_parent_ref )

Overwritten from ilObject.

Calls nodeInserted on parent object if parent object is a program.

Definition at line 24 of file class.ilObjStudyProgrammeReference.php.

References $res, ilObject\_lookupType(), ilObjStudyProgramme\getInstanceByRefId(), and getReferencedObject().

     {
         $res = parent::putInTree($a_parent_ref);
 
         if (ilObject::_lookupType($a_parent_ref, true) == "prg") {
             $par = ilObjStudyProgramme::getInstanceByRefId($a_parent_ref);
             $par->nodeInserted($this->getReferencedObject());
         }
 
         return $res;
     }

Here is the call graph for this function:

Field Documentation

◆ $referenced_object

ilObjStudyProgrammeReference::$referenced_object

protected

Definition at line 5 of file class.ilObjStudyProgrammeReference.php.

Referenced by getReferencedObject().

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

Modules/StudyProgrammeReference/classes/class.ilObjStudyProgrammeReference.php

Public Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getParent()

◆ getReferencedObject()

◆ putInTree()

Field Documentation

◆ $referenced_object