ilObjStudyProgramme Class Reference

Class ilObjStudyProgramme. More...

Inheritance diagram for ilObjStudyProgramme:

Collaboration diagram for ilObjStudyProgramme:

Public Member Functions
	__construct ($a_id=0, $a_call_by_reference=true)
	ATTENTION: After using the constructor the object won't be in the cache. More...
	read ()
	create ()
	update ()
	delete ()
	Delete Study Programme and all related data. More...
	getLastChange ()
	Get the timestamp of the last change on this program or sub program. More...
	getPoints ()
	Get the amount of points. More...
	setPoints ($a_points)
	Set the amount of points. More...
	getLPMode ()
	Get the lp mode. More...
	adjustLPMode ()
	Adjust the lp mode to match current state of tree: More...
	getStatus ()
	Get the status. More...
	setStatus ($a_status)
	Set the status of the node. More...
	isActive ()
	Check whether this programme is active. More...
	getSubtypeId ()
	Gets the meta-data subtype id (allows to add additional meta-data based on a type) More...
	setSubtypeId ($a_subtype_id)
	Sets the meta-data subtype id. More...
	getSubType ()
	Gets the SubType Object. More...
	getChildren ()
	Get all ilObjStudyProgrammes that are direct children of this object. More...
	getParent ()
	Get the parent ilObjStudyProgramme of this object. More...
	getParents ()
	Get all parents of the node, where the root of the program comes first. More...
	hasChildren ()
	Does this StudyProgramme have other ilObjStudyProgrammes as children? More...
	getAmountOfChildren ()
	Get the amount of other StudyProgrammes this StudyProgramme has as children. More...
	getDepth ()
	Get the depth of this StudyProgramme in the tree starting at the topmost StudyProgramme (not root node of the repo tree!). More...
	getRoot ()
	Get the ilObjStudyProgramme that is the root node of the tree this programme is in. More...
	getLPChildren ()
	Get the leafs the study programme contains. More...
	getLPChildrenIds ()
	Get the ids of the leafs the program contains. More...
	getAmountOfLPChildren ()
	Get the amount of leafs, the study programme contains. More...
	hasLPChildren ()
	Does this StudyProgramme has leafs? More...
	applyToSubTreeNodes (Closure $fun)
	Apply the given Closure to every node in the subtree starting at this object. More...
	getCompletedCourses ($a_user_id)
	Get courses in this program that the given user already completed. More...
	addNode (ilObjStudyProgramme $a_prg)
	Inserts another ilObjStudyProgramme in this object. More...
	putInTree ($a_parent_ref)
	Overwritten from ilObject. More...
	removeNode (ilObjStudyProgramme $a_prg)
	Remove a node from this object. More...
	canBeRemoved ()
	Check weather a node can be removed. More...
	addLeaf ( $a_leaf)
	Insert a leaf in this object. More...
	removeLeaf ( $a_leaf)
	Remove a leaf from this object. More...
	moveTo (ilObjStudyProgramme $a_new_parent)
	Move this tree node to a new parent. More...
	assignUser ($a_usr_id, $a_assigning_usr_id=null)
	Assign a user to this node at the study program. More...
	removeAssignment (ilStudyProgrammeUserAssignment $a_assignment)
	Remove an assignment from this program. More...
	hasAssignmentOf ($a_user_id)
	Check whether user is assigned to this program or any node above. More...
	getAmountOfAssignmentsOf ($a_user_id)
	Get the amount of assignments a user has on this program node or any node above. More...
	getAssignmentsOf ($a_user_id)
	Get the assignments of user at this program or any node above. More...
	getAssignments ()
	Get all assignments to this program or any node above. More...
	hasAssignments ()
	Are there any assignments on this node or any node above? More...
	updateAllAssignments ()
	Update all assignments to this program node. More...
	createProgressForAssignment (ilStudyProgrammeAssignment $ass)
	Create a progress on this programme for the given assignment. More...
	getProgressesOf ($a_user_id)
	Get the progresses the user has on this node. More...
	getProgressForAssignment ($a_assignment_id)
	Get the progress for an assignment on this node. More...
	addMissingProgresses ()
	Add missing progress records for all assignments of this programm. More...
	getProgresses ()
	Get all progresses on this node. More...
	hasProgresses ()
	Are there any users that have a progress on this programme? More...
	hasRelevantProgresses ()
	Are there any users that have a relevant progress on this programme? More...
	getIdsOfUsersWithRelevantProgress ()
	Get the ids of all users that have a relevant progress at this programme. More...
	getIdsOfUsersWithCompletedProgress ()
	Get the ids of all users that have completed this programme. More...
	getIdsOfUsersWithNotCompletedAndRelevantProgress ()
	Get the ids of all users that have not completed this programme but have a relevant progress on it. More...
	getRawSettings ()
	Get the underlying model of this program. More...
	updateCustomIcon ()
	updates the selected custom icon in container folder by type More...
	saveIcons ($a_custom_icon)
	save container icons More...
Public Member Functions inherited from ilContainer
	ilContainer ($a_id=0, $a_call_by_reference=true)
	Constructor public. More...
	createContainerDirectory ()
	Create directory for the container. More...
	getContainerDirectory ()
	Get the container directory. More...
	_getContainerDirectory ($a_id)
	Get the container directory. More...
	getBigIconPath ()
	Get path for big icon. More...
	getSmallIconPath ()
	Get path for small icon. More...
	getTinyIconPath ()
	Get path for tiny icon. More...
	getCustomIconPath ()
	Get path for custom icon. More...
	setHiddenFilesFound ($a_hiddenfilesfound)
	Set Found hidden files (set by getSubItems). More...
	getHiddenFilesFound ()
	Get Found hidden files (set by getSubItems). More...
	getStyleSheetId ()
	get ID of assigned style sheet object More...
	setStyleSheetId ($a_style_id)
	set ID of assigned style sheet object More...
	_lookupContainerSetting ($a_id, $a_keyword, $a_default_value=NULL)
	Lookup a container setting. More...
	_writeContainerSetting ($a_id, $a_keyword, $a_value)
	_lookupIconPath ($a_id, $a_size="big")
	lookup icon path More...
	saveIcons ($a_custom_icon)
	save container icons More...
	removeCustomIcon ()
	remove small icon More...
	cloneObject ($a_target_id, $a_copy_id=0)
	Clone container settings. More...
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies (container sorting) More...
	cloneAllObject ($session_id, $client_id, $new_type, $ref_id, $clone_source, $options, $soap_call=false, $a_submode=1)
	clone all objects according to this container More...
	getViewMode ()
	Get container view mode. More...
	getOrderType ()
	Get order type default implementation. More...
	setOrderType ($a_value)
	getSubItems ($a_admin_panel_enabled=false, $a_include_side_block=false, $a_get_single=0)
	Get subitems of container. More...
	gotItems ()
	Check whether we got any items. More...
	addAdditionalSubItemInformation (&$object)
	Add additional information to sub item, e.g. More...
	getGroupedObjTypes ()
	Get grouped repository object types. More...
	enablePageEditing ()
	Check whether page editing is allowed for container. More...
	create ()
	Create. More...
	update ()
	Update. More...
	read ()
	read More...
Public Member Functions inherited from ilObject
	ilObject ($a_id=0, $a_reference=true)
	Constructor public. More...
	withReferences ()
	determines wehter objects are referenced or not (got ref ids or not) More...
	read ($a_force_db=false)
	read object data from db into object More...
	getId ()
	get object id 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...
	getOwner ()
	get object owner More...
	getOwnerName ()
	_lookupOwnerName ($a_owner_id)
	lookup owner name for owner id More...
	setOwner ($a_owner)
	set object owner More...
	getCreateDate ()
	get create date public More...
	getLastUpdateDate ()
	get last update date public More...
	getDiskUsage ()
	Gets the disk usage of the object in bytes. More...
	setObjDataRecord ($a_record)
	set object_data record (note: this method should only be called from the ilObjectFactory class) More...
	create ()
	create More...
	update ()
	update object in db More...
	MDUpdateListener ($a_element)
	Meta data update listener. More...
	createMetaData ()
	create meta data entry More...
	updateMetaData ()
	update meta data entry More...
	deleteMetaData ()
	delete meta data entry More...
	updateOwner ()
	update owner of object in db More...
	_getIdForImportId ($a_import_id)
	get current object id for import id (static) More...
	_lookupOwner ($a_id)
	lookup object owner More...
	_lookupLastUpdate ($a_id, $a_as_string=false)
	lookup last update More...
	_getLastUpdateOfObjects ($a_objs)
	Get last update for a set of media objects. More...
	_setDeletedDate ($a_ref_id)
	only called in ilTree::saveSubTree More...
	_resetDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...
	_lookupDeletedDate ($a_ref_id)
	only called in ilObjectGUI::insertSavedNodes More...
	_writeTitle ($a_obj_id, $a_title)
	write title to db (static) More...
	_writeDescription ($a_obj_id, $a_desc)
	write description to db (static) More...
	_writeImportId ($a_obj_id, $a_import_id)
	write import id to db (static) More...
	_isInTrash ($a_ref_id)
	checks wether object is in trash More...
	_hasUntrashedReference ($a_obj_id)
	checks wether an object has at least one reference that is not in trash More...
	_getObjectsDataForType ($a_type, $a_omit_trash=false)
	get all objects of a certain type More...
	putInTree ($a_parent_ref)
	maybe this method should be in tree object!? More...
	setPermissions ($a_parent_ref)
	set permissions of object More...
	setParentRolePermissions ($a_parent_ref)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g courses, groups for building permission intersections with non_member templates. More...
	createReference ()
	creates reference for object More...
	countReferences ()
	count references of object More...
	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...
	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type If you want to setup default local roles you MUST overwrite this method in derived object classes (see ilObjForum for an example) public More...
	applyDidacticTemplate ($a_tpl_id)
	Apply template. More...
	notify ($a_event, $a_ref_id, $a_parent_non_rbac_id, $a_node_id, $a_params=0)
	notifys an object about an event occured Based on the event passed, each object may decide how it reacts. More...
	setRegisterMode ($a_bool)
	isUserRegistered ($a_user_id=0)
	requireRegistration ()
	getXMLZip ()
	getHTMLDirectory ()
	cloneObject ($a_target_id, $a_copy_id=0, $a_omit_tree=false)
	Clone object permissions, put in tree ... More...
	appendCopyInfo ($a_target_id, $a_copy_id)
	Prepend Copy info if object with same name exists in that container. More...
	cloneDependencies ($a_target_id, $a_copy_id)
	Clone object dependencies. More...
	cloneMetaData ($target_obj)
	Copy meta data. More...
	_lookupCreationDate ($a_id)
	Lookup creation date. More...
	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...

Static Public Member Functions
static	initStudyProgrammeCache ()
static	getInstanceByRefId ($a_ref_id)
	Get an instance of ilObjStudyProgramme, use cache. More...
static	createInstance ()
	Create an instance of ilObjStudyProgramme, put in cache. More...
static	getAllChildren ($a_ref_id)
	Get a list of all ilObjStudyProgrammes in the subtree starting at $a_ref_id. More...
static	setProgressesCompletedFor ($a_obj_id, $a_user_id)
	Set all progresses to completed where the object with given id is a leaf and that belong to the user. More...
static	getCreatableSubObjects ($a_subobjects, $a_ref_id)
	Filter the list of possible subobjects for the objects that actually could be created on a concrete node. More...
Static Public Member Functions inherited from ilContainer
static	_getContainerSettings ($a_id)
static	_deleteContainerSettings ($a_id, $a_keyword=null, $a_keyword_like=false)
static	_exportContainerSettings (ilXmlWriter $a_xml, $a_obj_id)
static	getCompleteDescriptions (array $objects)
	overwrites description fields to long or short description in an assoc array keys needed (obj_id and description) More...
Static Public Member Functions inherited from ilObject
static	_lookupObjIdByImportId ($a_import_id)
static	_lookupImportId ($a_obj_id)
static	_getAllReferences ($a_id)
	get all reference ids of object More...
static	_lookupTitle ($a_id)
	lookup object title More...
static	_getIdsForTitle ($title, $type='', $partialmatch=false)
static	_lookupDescription ($a_id)
	lookup object description More...
static	_lookupObjId ($a_id)
static	setDeletedDates ($a_ref_ids)
	Set deleted date type $ilDB. More...
static	_lookupType ($a_id, $a_reference=false)
	lookup object type More...
static	_lookupObjectId ($a_ref_id)
	lookup object id More...
static	_exists ($a_id, $a_reference=false, $a_type=null)
	checks if an object exists in object_data More...
static	_getObjectsByType ($a_obj_type="", $a_owner="")
	Get objects by type. More...
static	_prepareCloneSelection ($a_ref_ids, $new_type, $show_path=true)
	Prepare copy wizard object selection. More...
static	_getIcon ($a_obj_id="", $a_size="big", $a_type="", $a_offline=false)
	Get icon for repository item. More...
static	collectDeletionDependencies (&$deps, $a_ref_id, $a_obj_id, $a_type, $a_depth=0)
	Collect deletion dependencies. More...
static	getDeletionDependencies ($a_obj_id)
	Get deletion dependencies. More...
static	getLongDescriptions (array $a_obj_ids)
	Get long description data. More...
static	getAllOwnedRepositoryObjects ($a_user_id)
	Get all ids of objects user owns. More...
static	fixMissingTitles ($a_type, array &$a_obj_title_map)
	Try to fix missing object titles. More...
static	hasAutoRating ($a_type, $a_ref_id)
	Check if auto rating is active for parent group/course. More...

Data Fields
	$tree
	$ilUser
	$object_factory
Data Fields inherited from ilContainer
const	VIEW_SESSIONS = 0
const	VIEW_OBJECTIVE = 1
const	VIEW_TIMING = 2
const	VIEW_ARCHIVE = 3
const	VIEW_SIMPLE = 4
const	VIEW_BY_TYPE = 5
const	VIEW_INHERIT = 6
const	VIEW_DEFAULT = self::VIEW_BY_TYPE
const	SORT_TITLE = 0
const	SORT_MANUAL = 1
const	SORT_ACTIVATION = 2
const	SORT_INHERIT = 3
const	SORT_CREATION = 4
const	SORT_DIRECTION_ASC = 0
const	SORT_DIRECTION_DESC = 1
const	SORT_NEW_ITEMS_POSITION_TOP = 0
const	SORT_NEW_ITEMS_POSITION_BOTTOM = 1
const	SORT_NEW_ITEMS_ORDER_TITLE = 0
const	SORT_NEW_ITEMS_ORDER_CREATION = 1
const	SORT_NEW_ITEMS_ORDER_ACTIVATION = 2
Data Fields inherited from ilObject
const	TITLE_LENGTH = 255
	max length of object title More...
const	DESC_LENGTH = 128
	$ilias
	$lng
	$id
	$ref_id
	$type
	$title
	$untranslatedTitle
	$desc
	$long_desc
	$owner
	$create_date
	$last_update
	$import_id
	$register = false
	$referenced
	$objectList
	$max_title
	$max_desc
	$add_dots
	$obj_data_record
	object_data record More...

Static Public Attributes
static	$study_programme_cache = null
Static Public Attributes inherited from ilContainer
static	$data_preloaded = false

Protected Member Functions
	clearParentCache ()
	Clear the cached parent to query it again at the tree. More...
	clearChildrenCache ()
	Clear the cached children. More...
	clearLPChildrenCache ()
	Clear the cached lp children. More...
	readSettings ()
	Load Settings from DB. More...
	createSettings ()
	Create new settings object. More...
	updateSettings ()
	Update settings in DB. More...
	deleteSettings ()
	Delete settings from DB. More...
	deleteAssignments ()
	Delete all assignments from the DB. More...
	throwIfNotInTree ()
	Helper function to check, weather object is in tree. More...
	nodeInserted (ilObjStudyProgramme $a_prg)
	Clears child chache and adds progress for new node. More...
	updateLastChange ()
	Update last change timestamp on this node and its parents. More...
	getIdsFromNodesOnPathFromRootToHere ()
	Get the ids from the nodes in the path leading from the root node of this program to this node, including the id of this node. More...
	getAssignmentsRaw ()
	Get model objects for the assignments on this programm. More...

Static Protected Member Functions
static	setProgressesCompletedIfParentIsProgrammeInLPCompletedMode ($a_ref_id, $a_obj_id, $a_user_id)
static	getParentId (ilObject $a_object)
	Get the obj id of the parent object for the given object. More...

Protected Attributes
	$settings
	$parent
	$children
	$lp_children
Protected Attributes inherited from ilContainer
	$order_type = 0
	$hiddenfilesfound = false

Detailed Description

Class ilObjStudyProgramme.

Author

: Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

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

Constructor & Destructor Documentation

__construct()

ilObjStudyProgramme::__construct	(		$a_id = 0,
			$a_call_by_reference = true
	)

ATTENTION: After using the constructor the object won't be in the cache.

This could lead to unexpected behaviour when using the tree navigation.

Parameters

int	$a_id
bool	$a_call_by_reference

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

References $ilUser, $tree, clearChildrenCache(), clearLPChildrenCache(), clearParentCache(), ilContainer\ilContainer(), and ilObjectFactoryWrapper\singleton().

                                                                            {
                $this->type = "prg";
                $this->settings = null;
                $this->ilContainer($a_id, $a_call_by_reference);
                
                $this->clearParentCache();
                $this->clearChildrenCache();
                $this->clearLPChildrenCache();

                global $tree, $ilUser;
                $this->tree = $tree;
                $this->ilUser = $ilUser;

                $this->object_factory = ilObjectFactoryWrapper::singleton();
                self::initStudyProgrammeCache();
        }

Here is the call graph for this function:

Member Function Documentation

addLeaf()

ilObjStudyProgramme::addLeaf

(

$a_leaf

)

Insert a leaf in this object.

Throws when object already contain ilObjStudyProgrammes as children. Throws when this object is not in tree.

Exceptions

ilStudyProgrammeTreeException

Returns

$this

Definition at line 759 of file class.ilObjStudyProgramme.php.

References clearLPChildrenCache(), ilObject\getRefId(), hasChildren(), ilStudyProgramme\MODE_LP_COMPLETED, throwIfNotInTree(), and update().

                                           {
                $this->throwIfNotInTree();
                
                if ($this->hasChildren()) {
                        throw new ilStudyProgrammeTreeException("Program already contains other programm nodes.");
                }
                
                if ($a_leaf->getRefId() === null) {
                        $a_leaf->createReference();
                }
                $a_leaf->putInTree($this->getRefId());
                $this->clearLPChildrenCache();
                
                $this->settings->setLPMode(ilStudyProgramme::MODE_LP_COMPLETED);
                $this->update();
                
                return $this;
        }

Here is the call graph for this function:

addMissingProgresses()

ilObjStudyProgramme::addMissingProgresses

(

)

Add missing progress records for all assignments of this programm.

Use this after the structure of the programme was modified.

Returns

null

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

References getAssignments().

Referenced by nodeInserted().

                                               {
                foreach ($this->getAssignments() as $ass) {
                        $ass->addMissingProgresses();
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

addNode()

ilObjStudyProgramme::addNode

(

ilObjStudyProgramme

$a_prg

)

Inserts another ilObjStudyProgramme in this object.

Throws when object already contains non ilObjStudyProgrammes as children. Throws when $a_prg already is in the tree. Throws when this object is not in tree.

Exceptions

ilStudyProgrammeTreeException

Returns

$this

Definition at line 653 of file class.ilObjStudyProgramme.php.

References ilObject\createReference(), getLPMode(), ilObject\getRefId(), ilStudyProgramme\MODE_LP_COMPLETED, putInTree(), and throwIfNotInTree().

                                                            {
                $this->throwIfNotInTree();
                
                if ($this->getLPMode() == ilStudyProgramme::MODE_LP_COMPLETED) {
                        throw new ilStudyProgrammeTreeException("Program already contains leafs.");
                }
                
                if ($this->tree->isInTree($a_prg->getRefId())) {
                        throw new ilStudyProgrammeTreeException("Other program already is in tree.");
                }
                
                if ($a_prg->getRefId() === null) {
                        $a_prg->createReference();
                }
                $a_prg->putInTree($this->getRefId());
                return $this;
        }

Here is the call graph for this function:

adjustLPMode()

ilObjStudyProgramme::adjustLPMode

(

)

Adjust the lp mode to match current state of tree:

If there are any non programme children, the mode is MODE_LP_COMPLETED, otherwise its MODE_POINTS.

Exceptions

ilException

when programme is not in draft mode.

Definition at line 279 of file class.ilObjStudyProgramme.php.

References getAmountOfChildren(), getAmountOfLPChildren(), ilStudyProgramme\MODE_LP_COMPLETED, ilStudyProgramme\MODE_POINTS, and ilStudyProgramme\MODE_UNDEFINED.

                                       {
                if ($this->getAmountOfLPChildren() > 0) {
                        $this->settings->setLPMode(ilStudyProgramme::MODE_LP_COMPLETED)
                                                   ->update();
                }
                else {
                        if ($this->getAmountOfChildren() > 0) {
                                $this->settings->setLPMode(ilStudyProgramme::MODE_POINTS)
                                                           ->update();
                        }
                        else {
                                $this->settings->setLPMode(ilStudyProgramme::MODE_UNDEFINED)
                                                           ->update();
                        }
                }
        }

Here is the call graph for this function:

applyToSubTreeNodes()

ilObjStudyProgramme::applyToSubTreeNodes

(

Closure

$fun

)

Apply the given Closure to every node in the subtree starting at this object.

When the closure returns false, the underlying nodes won't be visited.

Throws when this object is not in tree.

Parameters

Closure

$fun

- An anonymus function taking an ilObjStudyProgramme as parameter.

Definition at line 600 of file class.ilObjStudyProgramme.php.

References getChildren(), and throwIfNotInTree().

Referenced by assignUser().

                                                          {
                $this->throwIfNotInTree();
                
                if ($fun($this) !== false) {
                        foreach($this->getChildren() as $child) {
                                $child->applyToSubTreeNodes($fun);
                        }
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

assignUser()

ilObjStudyProgramme::assignUser	(		$a_usr_id,
			$a_assigning_usr_id = null
	)

Assign a user to this node at the study program.

Throws when node is in DRAFT or OUTDATED status. Throws when there are no settings for the program.

TODO: Should it be allowed to assign inactive users?

Exceptions

ilException

Parameters

int	$a_usr_id
int  |  null	$a_assigning_usr_id	- defaults to global ilUser

Returns

ilStudyProgrammeUserAssignment

Definition at line 853 of file class.ilObjStudyProgramme.php.

References applyToSubTreeNodes(), ilStudyProgrammeAssignment\createFor(), createProgressForAssignment(), ilObject\getId(), getStatus(), ilStudyProgramme\STATUS_ACTIVE, ilStudyProgrammeProgress\STATUS_NOT_RELEVANT, and ilStudyProgrammeEvents\userAssigned().

                                                                          {
                require_once("./Modules/StudyProgramme/classes/class.ilStudyProgrammeUserAssignment.php");
                require_once("./Modules/StudyProgramme/classes/model/class.ilStudyProgrammeAssignment.php");
                require_once("./Modules/StudyProgramme/classes/model/class.ilStudyProgrammeProgress.php");
                require_once("./Modules/StudyProgramme/classes/class.ilStudyProgrammeEvents.php");
                
                if ($this->settings === null) {
                        throw new ilException("ilObjStudyProgramme::assignUser: Program was not properly created.'");
                }
                
                if ($this->getStatus() != ilStudyProgramme::STATUS_ACTIVE) {
                        throw new ilException("ilObjStudyProgramme::assignUser: Can't assign user to program '"
                                                                 .$this->getId()."', since it's not in active status.");
                }
                
                if ($a_assigning_usr_id === null) {
                        $a_assigning_usr_id = $this->ilUser->getId();
                }

                $ass_mod = ilStudyProgrammeAssignment::createFor($this->settings, $a_usr_id, $a_assigning_usr_id);
                $ass = new ilStudyProgrammeUserAssignment($ass_mod);
                
                $this->applyToSubTreeNodes(function(ilObjStudyProgramme $node) use ($ass_mod, $a_assigning_usr_id) {
                        $progress = $node->createProgressForAssignment($ass_mod);
                        if ($node->getStatus() != ilStudyProgramme::STATUS_ACTIVE) {
                                $progress->setStatus(ilStudyProgrammeProgress::STATUS_NOT_RELEVANT)
                                                 ->update();
                        }
                });
                
                ilStudyProgrammeEvents::userAssigned($ass);
                
                return $ass;
        }

Here is the call graph for this function:

canBeRemoved()

ilObjStudyProgramme::canBeRemoved

(

)

Check weather a node can be removed.

This is allowed when all progresses on the node are marked as not relevant programmatically.

Returns

bool

Definition at line 738 of file class.ilObjStudyProgramme.php.

References getProgresses(), and ilStudyProgrammeProgress\STATUS_NOT_RELEVANT.

Referenced by removeNode().

                                       {
                foreach($this->getProgresses() as $progress) {
                        if ($progress->getStatus() != ilStudyProgrammeProgress::STATUS_NOT_RELEVANT) {
                                return false;
                        }
                        if ($progress->getLastChangeBy() !== null) {
                                return false;
                        }
                }
                return true;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

clearChildrenCache()

ilObjStudyProgramme::clearChildrenCache ( )

protected

Clear the cached children.

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

Referenced by __construct(), moveTo(), nodeInserted(), and removeNode().

                                                {
                $this->children = null;
        }

Here is the caller graph for this function:

clearLPChildrenCache()

ilObjStudyProgramme::clearLPChildrenCache ( )

protected

Clear the cached lp children.

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

Referenced by __construct(), addLeaf(), moveTo(), and removeLeaf().

                                                  {
                $this->lp_children = null;
        }

Here is the caller graph for this function:

clearParentCache()

ilObjStudyProgramme::clearParentCache ( )

protected

Clear the cached parent to query it again at the tree.

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

Referenced by __construct(), moveTo(), and removeNode().

                                              {
                // This is not initialized, but we need null if there is no parent.
                $this->parent = false;
        }

Here is the caller graph for this function:

create()

ilObjStudyProgramme::create

(

)

Definition at line 184 of file class.ilObjStudyProgramme.php.

References ilObject\$id, and createSettings().

                                 {
                $id = parent::create();
                $this->createSettings();

                return $id;
        }

Here is the call graph for this function:

createInstance()

static ilObjStudyProgramme::createInstance ( )

static

Create an instance of ilObjStudyProgramme, put in cache.

Definition at line 103 of file class.ilObjStudyProgramme.php.

Referenced by ilObjStudyProgrammeTest\createSmallTree(), ilStudyProgrammeLPTest\setUp(), ilStudyProgrammeUserAssignmentTest\setUp(), ilStudyProgrammeUserProgressTest\setUp(), ilStudyProgrammeProgressCalculationTest\setUp(), ilStudyProgrammeEventsTest\setUp(), ilObjStudyProgrammeTest\setUp(), ilStudyProgrammeProgressCalculationTest\setUpNodes(), ilStudyProgrammeUserProgressTest\testCanBeCompleted3(), ilStudyProgrammeUserProgressTest\testCompletionOnDeeplyNestedProgresses(), ilStudyProgrammeLPTest\testNewNodesAreNotRelevant(), ilStudyProgrammeUserProgressTest\testNewNodesAreNotRelevant(), and ilObjStudyProgrammeTest\testTreeGetParents().

                                                {
                $obj =  new ilObjStudyProgramme();
                $obj->create();
                $obj->createReference();
                self::$study_programme_cache->addInstance($obj);
                return $obj;
        }

Here is the caller graph for this function:

createProgressForAssignment()

ilObjStudyProgramme::createProgressForAssignment

(

ilStudyProgrammeAssignment

$ass

)

Create a progress on this programme for the given assignment.

Parameters

ilStudyProgrammeAssignment

Returns

ilStudyProgrammeProgress

Definition at line 998 of file class.ilObjStudyProgramme.php.

References ilStudyProgrammeProgress\createFor().

Referenced by assignUser().

                                                                                     {
                return ilStudyProgrammeProgress::createFor($this->settings, $ass);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

createSettings()

ilObjStudyProgramme::createSettings ( )

protected

Create new settings object.

Throws when settings are already loaded or id is null.

Definition at line 135 of file class.ilObjStudyProgramme.php.

References ilObject\$id, ilStudyProgramme\createForObject(), and ilObject\getId().

Referenced by create().

                                            {
                if ($this->settings !== null) {
                        throw new ilException("ilObjStudyProgramme::createSettings: already loaded.");
                }
                
                $id = $this->getId();
                if (!$id) {
                        throw new ilException("ilObjStudyProgramme::loadSettings: no id.");
                }
                $this->settings = ilStudyProgramme::createForObject($this);
        }

Here is the call graph for this function:

Here is the caller graph for this function:

delete()

ilObjStudyProgramme::delete

(

)

Delete Study Programme and all related data.

Returns

boolean true if all object data were removed; false if only a references were removed

Definition at line 211 of file class.ilObjStudyProgramme.php.

References deleteAssignments(), and deleteSettings().

                                 {
                // always call parent delete function first!!
                if (!parent::delete()) {
                        return false;
                }

                $this->deleteSettings();
                try {
                        $this->deleteAssignments();
                } catch(ilStudyProgrammeTreeException $e) {
                // This would be the case when SP is in trash (#17797)
                }
                
                return true;
        }

Here is the call graph for this function:

deleteAssignments()

ilObjStudyProgramme::deleteAssignments ( )

protected

Delete all assignments from the DB.

Definition at line 172 of file class.ilObjStudyProgramme.php.

References getAssignments().

Referenced by delete().

                                               {
                foreach ($this->getAssignments() as $ass) {
                        $ass->delete();
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteSettings()

ilObjStudyProgramme::deleteSettings ( )

protected

Delete settings from DB.

Throws when settings are not loaded.

Definition at line 162 of file class.ilObjStudyProgramme.php.

Referenced by delete().

                                            {
                if ($this->settings === null) {
                        throw new Exception("ilObjStudyProgramme::deleteSettings: no settings loaded.");
                }
                $this->settings->delete();
        }

Here is the caller graph for this function:

getAllChildren()

static ilObjStudyProgramme::getAllChildren (   $a_ref_id )

static

Get a list of all ilObjStudyProgrammes in the subtree starting at $a_ref_id.

Throws when object is not in tree.

Parameters

int

$a_ref_id

Returns

[ilObjStudyProgramme]

Definition at line 375 of file class.ilObjStudyProgramme.php.

References $ret.

Referenced by ilObjStudyProgrammeTreeGUI\confirmedDelete(), ilObjStudyProgrammeTest\testMoveTo(), and ilObjStudyProgrammeTest\testTreeGetChildren().

                                                         {
                $ret = array();
                $root = self::getInstanceByRefId($a_ref_id);
                $root_id = $root->getId();
                $root->applyToSubTreeNodes(function($prg) use (&$ret, $root_id) {
                        // exclude root node of subtree.
                        if ($prg->getId() == $root_id) {
                                return;
                        }
                        $ret[] = $prg;
                });
                return $ret;
        }

Here is the caller graph for this function:

getAmountOfAssignmentsOf()

ilObjStudyProgramme::getAmountOfAssignmentsOf

(

$a_user_id

)

Get the amount of assignments a user has on this program node or any node above.

Parameters

int

$a_user_id

Returns

int

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

References getAssignmentsOf().

Referenced by hasAssignmentOf().

                                                             {
                return count($this->getAssignmentsOf($a_user_id));
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getAmountOfChildren()

ilObjStudyProgramme::getAmountOfChildren

(

)

Get the amount of other StudyProgrammes this StudyProgramme has as children.

Throws when this object is not in tree.

Returns

int

Definition at line 474 of file class.ilObjStudyProgramme.php.

References getChildren().

Referenced by adjustLPMode(), and hasChildren().

                                              {
                return count($this->getChildren());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getAmountOfLPChildren()

ilObjStudyProgramme::getAmountOfLPChildren

(

)

Get the amount of leafs, the study programme contains.

Throws when this object is not in tree.

Definition at line 561 of file class.ilObjStudyProgramme.php.

References getLPChildren().

Referenced by adjustLPMode(), and hasLPChildren().

                                                {
                return count($this->getLPChildren());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getAssignments()

ilObjStudyProgramme::getAssignments

(

)

Get all assignments to this program or any node above.

Returns

[ilStudyProgrammeUserAssignment]

Definition at line 960 of file class.ilObjStudyProgramme.php.

References getAssignmentsRaw().

Referenced by addMissingProgresses(), deleteAssignments(), and hasAssignments().

                                         {
                return array_map(function($ass) {
                        return new ilStudyProgrammeUserAssignment($ass);
                }, array_values($this->getAssignmentsRaw())); // use array values since we want keys 0...
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getAssignmentsOf()

ilObjStudyProgramme::getAssignmentsOf

(

$a_user_id

)

Get the assignments of user at this program or any node above.

The assignments are ordered by last_change, where the most recently changed assignments is the first one.

Parameters

int

$a_user_id

Returns

[ilStudyProgrammeUserAssignment]

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

References getIdsFromNodesOnPathFromRootToHere(), and ActiveRecord\where().

Referenced by getAmountOfAssignmentsOf().

                                                     {
                require_once("./Modules/StudyProgramme/classes/class.ilStudyProgrammeUserAssignment.php");
                
                $prg_ids = $this->getIdsFromNodesOnPathFromRootToHere();
                $assignments = ilStudyProgrammeAssignment::where(array( "usr_id" => $a_user_id
                                                                                                                                 , "root_prg_id" => $prg_ids
                                                                                                                   ))
                                                                                                        ->orderBy("last_change", "DESC")
                                                                                                        ->get();
                return array_map(function($ass) {
                        return new ilStudyProgrammeUserAssignment($ass);
                }, array_values($assignments)); // use array values since we want keys 0...
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getAssignmentsRaw()

ilObjStudyProgramme::getAssignmentsRaw ( )

protected

Get model objects for the assignments on this programm.

Definition at line 1149 of file class.ilObjStudyProgramme.php.

References getIdsFromNodesOnPathFromRootToHere(), and ActiveRecord\where().

Referenced by getAssignments().

                                               {
                require_once("./Modules/StudyProgramme/classes/class.ilStudyProgrammeUserAssignment.php");
                $prg_ids = $this->getIdsFromNodesOnPathFromRootToHere();
                return ilStudyProgrammeAssignment::where(array( "root_prg_id" => $prg_ids))
                                                                                                ->orderBy("last_change", "DESC")
                                                                                                ->get();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getChildren()

ilObjStudyProgramme::getChildren

(

)

Get all ilObjStudyProgrammes that are direct children of this object.

Throws when this object is not in tree.

Returns

[ilObjStudyProgramme]

Definition at line 397 of file class.ilObjStudyProgramme.php.

References $children, ilContainerSorting\_getInstance(), ilObject\getId(), getInstanceByRefId(), ilObject\getRefId(), and throwIfNotInTree().

Referenced by applyToSubTreeNodes(), and getAmountOfChildren().

                                      {
                $this->throwIfNotInTree();
                
                if ($this->children === null) {
                        $ref_ids = $this->tree->getChildsByType($this->getRefId(), "prg");

                        // apply container sorting to tree
                        $sorting = ilContainerSorting::_getInstance($this->getId());
                        $ref_ids = $sorting->sortItems(array('prg'=>$ref_ids));
                        $ref_ids = $ref_ids['prg'];

                        $this->children = array_map(function($node_data) {
                                return ilObjStudyProgramme::getInstanceByRefId($node_data["child"]);
                        }, $ref_ids);
                }

                return $this->children;
        } 

Here is the call graph for this function:

Here is the caller graph for this function:

getCompletedCourses()

ilObjStudyProgramme::getCompletedCourses

(

$a_user_id

)

Get courses in this program that the given user already completed.

Parameters

int

$a_user_id

Returns

array $obj_id => $ref_id

Definition at line 616 of file class.ilObjStudyProgramme.php.

References ilLPStatus\_hasUserCompleted(), ilContainerReference\_lookupTargetId(), ilContainerReference\_lookupTargetTitle(), and ilObject\getRefId().

                                                        {
                require_once("Services/ContainerReference/classes/class.ilContainerReference.php");
                require_once("Services/Tracking/classes/class.ilLPStatus.php");

                $node_data = $this->tree->getNodeData($this->getRefId());
                $crsrs = $this->tree->getSubTree($node_data, true, "crsr");

                $completed_crss = array();
                foreach ($crsrs as $ref) {
                        $crs_id = ilContainerReference::_lookupTargetId($ref["obj_id"]);
                        if (ilLPStatus::_hasUserCompleted($crs_id, $a_user_id)) {
                                $completed_crss[] = array( "crs_id" => $crs_id
                                                                                 , "prg_ref_id" => $ref["parent"]
                                                                                 , "crsr_ref_id" => $ref["child"]
                                                                                 , "crsr_id" => $ref["obj_id"]
                                                                                 , "title" => ilContainerReference::_lookupTargetTitle($ref["obj_id"])
                                                                                 );
                        }
                }

                return $completed_crss;
        }

Here is the call graph for this function:

getCreatableSubObjects()

static ilObjStudyProgramme::getCreatableSubObjects (   $a_subobjects,   $a_ref_id  )

static

Filter the list of possible subobjects for the objects that actually could be created on a concrete node.

Will be called by ilObjDefinition::getCreatableSubObjects.

Parameters

array	$a_subobjects
int	$a_ref_id

Returns

array

Definition at line 1256 of file class.ilObjStudyProgramme.php.

References $parent, ilObject\_lookupType(), getInstanceByRefId(), ilStudyProgramme\MODE_LP_COMPLETED, ilStudyProgramme\MODE_POINTS, and ilStudyProgramme\MODE_UNDEFINED.

Referenced by ilObjectDefinition\getCreatableSubObjects(), ilObjStudyProgrammeTest\testCreatableSubObjectsRaisesOnNonProgramRef(), ilObjStudyProgrammeTest\testCreatableSubObjectsWithoutRef(), and ilObjStudyProgrammeTest\testCreateableSubObjects().

                                                                                {
                if ($a_ref_id === null) {
                        return $a_subobjects;
                }
                
                if (ilObject::_lookupType($a_ref_id, true) != "prg") {
                        throw new ilException("Ref-Id '$a_ref_id' does not belong to a study programme object.");
                }
                
                $parent = ilObjStudyProgramme::getInstanceByRefId($a_ref_id);

                $mode = $parent->getLPMode();

                switch ($mode) {
                        case ilStudyProgramme::MODE_UNDEFINED:
                                return $a_subobjects;
                        case ilStudyProgramme::MODE_POINTS:
                                return array("prg" => $a_subobjects["prg"]);
                        case ilStudyProgramme::MODE_LP_COMPLETED:
                                unset($a_subobjects["prg"]);
                                return $a_subobjects;
                }

                throw new ilException("Undefined mode for study programme: '$mode'");
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getDepth()

ilObjStudyProgramme::getDepth

(

)

Get the depth of this StudyProgramme in the tree starting at the topmost StudyProgramme (not root node of the repo tree!).

Root node has depth = 0.

Throws when this object is not in tree.

Returns

int

Definition at line 486 of file class.ilObjStudyProgramme.php.

                                   {
                $cur = $this;
                $count = 0;
                while ($cur = $cur->getParent()) {
                        $count++;
                }
                return $count;
        }

getIdsFromNodesOnPathFromRootToHere()

ilObjStudyProgramme::getIdsFromNodesOnPathFromRootToHere ( )

protected

Get the ids from the nodes in the path leading from the root node of this program to this node, including the id of this node.

Definition at line 1138 of file class.ilObjStudyProgramme.php.

References ilObject\getId(), and getParents().

Referenced by getAssignmentsOf(), and getAssignmentsRaw().

                                                                 {
                $prg_ids =array_map(function($par) {
                        return $par->getId();
                }, $this->getParents());
                $prg_ids[] = $this->getId();
                return $prg_ids;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getIdsOfUsersWithCompletedProgress()

ilObjStudyProgramme::getIdsOfUsersWithCompletedProgress

(

)

Get the ids of all users that have completed this programme.

Returns

int[]

Definition at line 1093 of file class.ilObjStudyProgramme.php.

References getProgresses().

                                                             {
                $returns = array();
                foreach ($this->getProgresses() as $progress) {
                        if ($progress->isSuccessful()) {
                                $returns[] = $progress->getUserId();
                        }
                }
                return array_unique($returns);
        }

Here is the call graph for this function:

getIdsOfUsersWithNotCompletedAndRelevantProgress()

ilObjStudyProgramme::getIdsOfUsersWithNotCompletedAndRelevantProgress

(

)

Get the ids of all users that have not completed this programme but have a relevant progress on it.

Returns

int[]

Definition at line 1109 of file class.ilObjStudyProgramme.php.

References getProgresses().

                                                                           {
                $returns = array();
                foreach ($this->getProgresses() as $progress) {
                        if ($progress->isRelevant() && !$progress->isSuccessful()) {
                                $returns[] = $progress->getUserId();
                        }
                }
                return array_unique($returns);
        }

Here is the call graph for this function:

getIdsOfUsersWithRelevantProgress()

ilObjStudyProgramme::getIdsOfUsersWithRelevantProgress

(

)

Get the ids of all users that have a relevant progress at this programme.

Returns

int[]

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

References getProgresses().

                                                            {
                $returns = array();
                foreach ($this->getProgresses() as $progress) {
                        if ($progress->isRelevant()) {
                                $returns[] = $progress->getUserId();
                        }
                }
                return array_unique($returns);
        }

Here is the call graph for this function:

getInstanceByRefId()

static ilObjStudyProgramme::getInstanceByRefId (   $a_ref_id )

static

Get an instance of ilObjStudyProgramme, use cache.

Parameters

int

$a_ref_id

Returns

ilObjStudyProgramme

Definition at line 92 of file class.ilObjStudyProgramme.php.

Referenced by ilObjStudyProgrammeAccess\_checkAccess(), getChildren(), getCreatableSubObjects(), ilObjStudyProgrammeSettingsGUI\getObject(), getParent(), ilObjStudyProgrammeTreeExplorerGUI\getRootNode(), ilStudyProgrammeUserAssignment\getStudyProgramme(), ilStudyProgrammeAppEventListener\getStudyProgramme(), ilStudyProgrammeUserProgress\getStudyProgramme(), ilObjStudyProgrammeMembersGUI\getStudyProgramme(), putInTree(), setProgressesCompletedIfParentIsProgrammeInLPCompletedMode(), ilObjStudyProgrammeTest\testDelete(), ilObjStudyProgrammeTest\testGetInstanceByRefId(), ilObjStudyProgrammeTest\testLoadByObjId(), and ilObjStudyProgrammeTest\testSettings().

                                                             {
                require_once("Modules/StudyProgramme/classes/class.ilObjStudyProgrammeCache.php");
                if (self::$study_programme_cache === null) {
                        self::initStudyProgrammeCache();
                }
                return self::$study_programme_cache->getInstanceByRefId($a_ref_id);
        }

Here is the caller graph for this function:

getLastChange()

ilObjStudyProgramme::getLastChange

(

)

Get the timestamp of the last change on this program or sub program.

Returns

ilDateTime

Definition at line 236 of file class.ilObjStudyProgramme.php.

                                        {
                return $this->settings->getLastChange();
        }

getLPChildren()

ilObjStudyProgramme::getLPChildren

(

)

Get the leafs the study programme contains.

Throws when this object is not in tree.

Returns

ilStudyProgrammeLeaf[]

Definition at line 515 of file class.ilObjStudyProgramme.php.

References $lp_children, ilContainerSorting\_getInstance(), ilObject\getId(), ilObject\getRefId(), and throwIfNotInTree().

Referenced by getAmountOfLPChildren(), and getLPChildrenIds().

                                        {
                $this->throwIfNotInTree();
                
                if ($this->lp_children === null) {
                        $this->lp_children = array();

                        // TODO: find a better way to get all elements except StudyProgramme-children
                        $ref_ids = $this->tree->getChildsByType($this->getRefId(), "crsr");

                        // apply container sorting to tree
                        $sorting = ilContainerSorting::_getInstance($this->getId());
                        $ref_ids = $sorting->sortItems(array('crs_ref'=>$ref_ids));
                        $ref_ids = $ref_ids['crs_ref'];

                        // TODO: $this could be removed as soon as support for PHP 5.3 is dropped:
                        $self = $this;
                        $lp_children = array_map(function($node_data) use ($self) {
                                $lp_obj = $self->object_factory->getInstanceByRefId($node_data["child"]);

                                // filter out all StudyProgramme instances
                                return ($lp_obj instanceof $self)? null : $lp_obj;
                        }, $ref_ids);

                        $this->lp_children = array_filter($lp_children);
                }
                return $this->lp_children;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getLPChildrenIds()

ilObjStudyProgramme::getLPChildrenIds

(

)

Get the ids of the leafs the program contains.

Throws when object is not in tree.

Returns

ilStudyProgrammeLeaf[]

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

References getLPChildren().

                                           {
                return array_map(function($child) {
                        return $child->getId();
                }, $this->getLPChildren());
        }

Here is the call graph for this function:

getLPMode()

ilObjStudyProgramme::getLPMode

(

)

Get the lp mode.

Returns

integer - one of ilStudyProgramme::$MODES

Definition at line 267 of file class.ilObjStudyProgramme.php.

Referenced by addNode(), and nodeInserted().

                                    {
                return $this->settings->getLPMode();
        }

Here is the caller graph for this function:

getParent()

ilObjStudyProgramme::getParent

(

)

Get the parent ilObjStudyProgramme of this object.

Returns null if parent is no StudyProgramme.

Throws when this object is not in tree.

Returns

ilObjStudyProgramme | null

Definition at line 424 of file class.ilObjStudyProgramme.php.

References $parent, getInstanceByRefId(), ilObject\getRefId(), and throwIfNotInTree().

Referenced by moveTo(), removeNode(), and updateLastChange().

                                    {
                if ($this->parent === false) {
                        $this->throwIfNotInTree();
                        $parent_data = $this->tree->getParentNodeData($this->getRefId());
                        if ($parent_data["type"] != "prg") {
                                $this->parent = null;
                        }
                        else {
                                $this->parent = ilObjStudyProgramme::getInstanceByRefId($parent_data["ref_id"]);
                        }
                }
                return $this->parent;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getParentId()

static ilObjStudyProgramme::getParentId ( ilObject  $a_object )

staticprotected

Get the obj id of the parent object for the given object.

Returns null if object is not in the tree currently.

Returns

int | null

Definition at line 1202 of file class.ilObjStudyProgramme.php.

References $nd, $tree, and ilObject\getRefId().

                                                                  {
                global $tree;
                if (!$tree->isInTree($a_object->getRefId())) {
                        return null;
                }
                
                $nd = $tree->getParentNodeData($a_object->getRefId());
                return $nd["obj_id"];
        }

Here is the call graph for this function:

getParents()

ilObjStudyProgramme::getParents

(

)

Get all parents of the node, where the root of the program comes first.

Returns

[ilObjStudyProgramme]

Definition at line 443 of file class.ilObjStudyProgramme.php.

Referenced by getIdsFromNodesOnPathFromRootToHere(), and getRoot().

                                     {
                $current = $this;
                $parents = array();
                while(true) {
                        $current = $current->getParent();
                        if ($current === null) {
                                return array_reverse($parents);
                        }
                        $parents[] = $current;
                }
        }

Here is the caller graph for this function:

getPoints()

ilObjStudyProgramme::getPoints

(

)

Get the amount of points.

Returns

integer - larger than zero

Definition at line 245 of file class.ilObjStudyProgramme.php.

                                    {
            return $this->settings->getPoints();
        }

getProgresses()

ilObjStudyProgramme::getProgresses

(

)

Get all progresses on this node.

Returns

ilStudyProgrammeUserProgress[]

Definition at line 1045 of file class.ilObjStudyProgramme.php.

References ilObject\getId(), and ilStudyProgrammeUserProgress\getInstancesForProgram().

Referenced by canBeRemoved(), getIdsOfUsersWithCompletedProgress(), getIdsOfUsersWithNotCompletedAndRelevantProgress(), getIdsOfUsersWithRelevantProgress(), hasProgresses(), and hasRelevantProgresses().

                                        {
                require_once("./Modules/StudyProgramme/classes/class.ilStudyProgrammeUserProgress.php");
                return ilStudyProgrammeUserProgress::getInstancesForProgram($this->getId());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getProgressesOf()

ilObjStudyProgramme::getProgressesOf

(

$a_user_id

)

Get the progresses the user has on this node.

Parameters

int

$a_user_id

Returns

ilStudyProgrammUserProgress[]

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

References ilObject\getId(), and ilStudyProgrammeUserProgress\getInstancesForUser().

                                                    {
                require_once("./Modules/StudyProgramme/classes/class.ilStudyProgrammeUserProgress.php");
                return ilStudyProgrammeUserProgress::getInstancesForUser($this->getId(), $a_user_id);
        }

Here is the call graph for this function:

getProgressForAssignment()

ilObjStudyProgramme::getProgressForAssignment

(

$a_assignment_id

)

Get the progress for an assignment on this node.

Throws when assignment does not belong to this program.

Exceptions

ilException

Parameters

int

$a_assignment_id

Returns

ilStudyProgrammUserProgress

Definition at line 1022 of file class.ilObjStudyProgramme.php.

References ilObject\getId(), and ilStudyProgrammeUserProgress\getInstanceForAssignment().

                                                                   {
                require_once("./Modules/StudyProgramme/classes/class.ilStudyProgrammeUserProgress.php");
                return ilStudyProgrammeUserProgress::getInstanceForAssignment($this->getId(), $a_assignment_id);
        }

Here is the call graph for this function:

getRawSettings()

ilObjStudyProgramme::getRawSettings

(

)

Get the underlying model of this program.

ATTENTION: Only use the model object if you know what you are doing.

Returns

ilStudyProgramme

Definition at line 1219 of file class.ilObjStudyProgramme.php.

References $settings.

                                         {
                return $this->settings;
        }

getRoot()

ilObjStudyProgramme::getRoot

(

)

Get the ilObjStudyProgramme that is the root node of the tree this programme is in.

Throws when this object is not in tree.

Returns

ilObjStudyProgramme

Definition at line 503 of file class.ilObjStudyProgramme.php.

References getParents().

                                  {
                $parents = $this->getParents();
                return $parents[0];
        }

Here is the call graph for this function:

getStatus()

ilObjStudyProgramme::getStatus

(

)

Get the status.

Returns

integer - one of ilStudyProgramme::$STATUS

Definition at line 301 of file class.ilObjStudyProgramme.php.

Referenced by assignUser(), and isActive().

                                    {
                return $this->settings->getStatus();
        }

Here is the caller graph for this function:

getSubType()

ilObjStudyProgramme::getSubType

(

)

Gets the SubType Object.

Returns

ilStudyProgrammeType

Definition at line 353 of file class.ilObjStudyProgramme.php.

References getSubtypeId().

Referenced by update(), and updateCustomIcon().

                                     {
                if(!in_array($this->getSubtypeId(), array("-", "0"))) {
                        $subtype_id = $this->getSubtypeId();
                        return new ilStudyProgrammeType($subtype_id);
                }

                return null;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

getSubtypeId()

ilObjStudyProgramme::getSubtypeId

(

)

Gets the meta-data subtype id (allows to add additional meta-data based on a type)

Returns

integer

Definition at line 331 of file class.ilObjStudyProgramme.php.

Referenced by getSubType().

                                       {
                return $this->settings->getSubtypeId();
        }

Here is the caller graph for this function:

hasAssignmentOf()

ilObjStudyProgramme::hasAssignmentOf

(

$a_user_id

)

Check whether user is assigned to this program or any node above.

Parameters

int

$a_user_id

Returns

bool

Definition at line 918 of file class.ilObjStudyProgramme.php.

References getAmountOfAssignmentsOf().

                                                    {
                return $this->getAmountOfAssignmentsOf($a_user_id) > 0;
        }

Here is the call graph for this function:

hasAssignments()

ilObjStudyProgramme::hasAssignments

(

)

Are there any assignments on this node or any node above?

Returns

bool

Definition at line 971 of file class.ilObjStudyProgramme.php.

References getAssignments().

                                         {
                return count($this->getAssignments()) > 0;
        }

Here is the call graph for this function:

hasChildren()

ilObjStudyProgramme::hasChildren

(

)

Does this StudyProgramme have other ilObjStudyProgrammes as children?

Throws when this object is not in tree.

Returns

bool

Definition at line 462 of file class.ilObjStudyProgramme.php.

References getAmountOfChildren().

Referenced by addLeaf().

                                      {
                return $this->getAmountOfChildren() > 0;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

hasLPChildren()

ilObjStudyProgramme::hasLPChildren

(

)

Does this StudyProgramme has leafs?

Throws when this object is not in tree.

Returns

bool

Definition at line 572 of file class.ilObjStudyProgramme.php.

References getAmountOfLPChildren().

                                        {
                return ($this->getAmountOfLPChildren() > 0);
        }

Here is the call graph for this function:

hasProgresses()

ilObjStudyProgramme::hasProgresses

(

)

Are there any users that have a progress on this programme?

Returns

bool

Definition at line 1055 of file class.ilObjStudyProgramme.php.

References getProgresses().

                                        {
                return count($this->getProgresses()) > 0;
        }

Here is the call graph for this function:

hasRelevantProgresses()

ilObjStudyProgramme::hasRelevantProgresses

(

)

Are there any users that have a relevant progress on this programme?

Returns

bool

Definition at line 1064 of file class.ilObjStudyProgramme.php.

References getProgresses().

                                                {
                foreach ($this->getProgresses() as $progress) {
                        if ($progress->isRelevant()) {
                                return true;
                        }
                }
                return false;
        }

Here is the call graph for this function:

initStudyProgrammeCache()

static ilObjStudyProgramme::initStudyProgrammeCache ( )

static

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

References ilObjStudyProgrammeCache\singleton().

                                                         {
                if (self::$study_programme_cache === null) {
                        self::$study_programme_cache = ilObjStudyProgrammeCache::singleton();
                }
        }

Here is the call graph for this function:

isActive()

ilObjStudyProgramme::isActive

(

)

Check whether this programme is active.

Returns

bool

Definition at line 322 of file class.ilObjStudyProgramme.php.

References getStatus(), and ilStudyProgramme\STATUS_ACTIVE.

                                   {
                return $this->getStatus() == ilStudyProgramme::STATUS_ACTIVE;
        }

Here is the call graph for this function:

moveTo()

ilObjStudyProgramme::moveTo

(

ilObjStudyProgramme

$a_new_parent

)

Move this tree node to a new parent.

Throws, when manipulation of tree is not allowed due to invariants that need to hold on the tree.

Exceptions

ilStudyProgrammeTreeException

Parameters

int

$a_new_parent_ref_id

Returns

$this

Definition at line 810 of file class.ilObjStudyProgramme.php.

References $parent, clearChildrenCache(), clearLPChildrenCache(), clearParentCache(), getParent(), and ilObject\getRefId().

                                                                  {
                global $rbacadmin;

                if ($parent = $this->getParent()) {

                        // TODO: check if there some leafs in the new parent

                        $this->tree->moveTree($this->getRefId(), $a_new_parent->getRefId());
                        // necessary to clean up permissions
                        $rbacadmin->adjustMovedObjectPermissions($this->getRefId(), $parent->getRefId());

                        // TODO: lp-progress needs to be updated

                        // clear caches on different nodes
                        $this->clearParentCache();

                        $parent->clearChildrenCache();
                        $parent->clearLPChildrenCache();

                        $a_new_parent->clearChildrenCache();
                        $a_new_parent->clearLPChildrenCache();
                }

                return $this;
        }

Here is the call graph for this function:

nodeInserted()

ilObjStudyProgramme::nodeInserted ( ilObjStudyProgramme  $a_prg )

protected

Clears child chache and adds progress for new node.

Definition at line 674 of file class.ilObjStudyProgramme.php.

References addMissingProgresses(), clearChildrenCache(), getLPMode(), ilStudyProgramme\MODE_LP_COMPLETED, and ilStudyProgramme\MODE_POINTS.

                                                                    {
                if ($this->getLPMode() == ilStudyProgramme::MODE_LP_COMPLETED) {
                        throw new ilStudyProgrammeTreeException("Program already contains leafs.");
                }
                
                if ($this->settings->getLPMode() !== ilStudyProgramme::MODE_POINTS) {
                        $this->settings->setLPMode(ilStudyProgramme::MODE_POINTS)
                                                   ->update();
                }
                
                $this->clearChildrenCache();
                $this->addMissingProgresses();
        }

Here is the call graph for this function:

putInTree()

ilObjStudyProgramme::putInTree

(

$a_parent_ref

)

Overwritten from ilObject.

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

Definition at line 693 of file class.ilObjStudyProgramme.php.

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

Referenced by addNode().

                                                 {
                $res = parent::putInTree($a_parent_ref);

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

Here is the call graph for this function:

Here is the caller graph for this function:

read()

ilObjStudyProgramme::read

(

)

Definition at line 178 of file class.ilObjStudyProgramme.php.

References readSettings().

                               {
                parent::read();
                $this->readSettings();
        }

Here is the call graph for this function:

readSettings()

ilObjStudyProgramme::readSettings ( )

protected

Load Settings from DB.

Throws when settings are already loaded or id is null.

Definition at line 120 of file class.ilObjStudyProgramme.php.

References ilObject\$id, and ilObject\getId().

Referenced by read().

                                          {
                if ($this->settings !== null) {
                        throw new ilException("ilObjStudyProgramme::loadSettings: already loaded.");
                }
                $id = $this->getId();
                if (!$id) {
                        throw new ilException("ilObjStudyProgramme::loadSettings: no id.");
                }
                $this->settings = new ilStudyProgramme($this->getId());
        }

Here is the call graph for this function:

Here is the caller graph for this function:

removeAssignment()

ilObjStudyProgramme::removeAssignment

(

ilStudyProgrammeUserAssignment

$a_assignment

)

Remove an assignment from this program.

Throws when assignment doesn't have this program as root node.

Exceptions

ilException

Returns

$this

Definition at line 896 of file class.ilObjStudyProgramme.php.

References ilStudyProgrammeUserAssignment\delete(), ilStudyProgrammeUserAssignment\getId(), ilObject\getId(), ilStudyProgrammeUserAssignment\getStudyProgramme(), and ilStudyProgrammeEvents\userDeassigned().

                                                                                       {
                require_once("./Modules/StudyProgramme/classes/class.ilStudyProgrammeEvents.php");
                
                if ($a_assignment->getStudyProgramme()->getId() != $this->getId()) {
                        throw new ilException("ilObjStudyProgramme::removeAssignment: Assignment '"
                                                                 .$a_assignment->getId()."' does not belong to study "
                                                                 ."program '".$this->getId()."'.");
                }
                
                ilStudyProgrammeEvents::userDeassigned($a_assignment);
                
                $a_assignment->delete();
                
                return $this;
        }

Here is the call graph for this function:

removeLeaf()

ilObjStudyProgramme::removeLeaf

(

$a_leaf

)

Remove a leaf from this object.

Throws when leaf is not a child of this object. Throws, when manipulation of tree is not allowed due to invariants that need to hold on the tree.

Exceptions

ilException
ilStudyProgrammeTreeException

Returns

$this

Definition at line 788 of file class.ilObjStudyProgramme.php.

References clearLPChildrenCache(), and ilObject\getId().

                                              {
                if (self::getParentId($a_leaf) !== $this->getId()) {
                        throw new ilStudyProgrammeTreeException("This is no parent of the given leaf node.");
                }

                $node_data = $this->tree->getNodeData($a_leaf->getRefId());
                $this->tree->deleteTree($node_data);
                $this->clearLPChildrenCache();

                return $this;
        }

Here is the call graph for this function:

removeNode()

ilObjStudyProgramme::removeNode

(

ilObjStudyProgramme

$a_prg

)

Remove a node from this object.

Throws when node is no child of the object. Throws, when manipulation of tree is not allowed due to invariants that need to hold on the tree.

Exceptions

ilException
ilStudyProgrammTreeException

Returns

$this

Definition at line 714 of file class.ilObjStudyProgramme.php.

References canBeRemoved(), clearChildrenCache(), clearParentCache(), ilObject\getId(), getParent(), and ilObject\getRefId().

                                                               {
                if ($a_prg->getParent()->getId() !== $this->getId()) {
                        throw new ilStudyProgrammeTreeException("This is no parent of the given programm.");
                }
                
                if (!$a_prg->canBeRemoved()) {
                        throw new ilStudyProgrammeTreeException("The node has relevant assignments.");
                }
                
                // *sigh*...
                $node_data = $this->tree->getNodeData($a_prg->getRefId());
                $this->tree->deleteTree($node_data);
                $a_prg->clearParentCache();
                $this->clearChildrenCache();
                
                return $this;
        }

Here is the call graph for this function:

saveIcons()

ilObjStudyProgramme::saveIcons

(

$a_custom_icon

)

save container icons

Definition at line 1289 of file class.ilObjStudyProgramme.php.

References $ilDB, ilContainer\_writeContainerSetting(), ilContainer\createContainerDirectory(), ilContainer\getContainerDirectory(), ilObject\getId(), and ilUtil\moveUploadedFile().

Referenced by updateCustomIcon().

        {
                global $ilDB;

                $this->createContainerDirectory();
                $cont_dir = $this->getContainerDirectory();
                $file_name = "";
                if ($a_custom_icon != "")
                {
                        $file_name = $cont_dir."/icon_custom.svg";

                        ilUtil::moveUploadedFile($a_custom_icon, "icon_custom.svg", $file_name, true, "copy");

                        if ($file_name != "" && is_file($file_name))
                        {
                                ilContainer::_writeContainerSetting($this->getId(), "icon_custom", 1);
                        }
                        else
                        {
                                ilContainer::_writeContainerSetting($this->getId(), "icon_custom", 0);
                        }
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

setPoints()

ilObjStudyProgramme::setPoints

(

$a_points

)

Set the amount of points.

Parameters

integer

$a_points

- larger than zero

Exceptions

ilException

Returns

$this

Definition at line 256 of file class.ilObjStudyProgramme.php.

References updateLastChange().

                                             {
                $this->settings->setPoints($a_points);
                $this->updateLastChange();
                return $this;
        } 

Here is the call graph for this function:

setProgressesCompletedFor()

static ilObjStudyProgramme::setProgressesCompletedFor (   $a_obj_id,   $a_user_id  )

static

Set all progresses to completed where the object with given id is a leaf and that belong to the user.

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

References ilObject\$ref_id, ilObject\$type, ilObject\_getAllReferences(), ilContainerReference\_lookupSourceIds(), and ilObject\_lookupType().

Referenced by ilStudyProgrammeAppEventListener\onServiceTrackingUpdateStatus().

                                                                                {
                // We only use courses via crs_refs
                $type = ilObject::_lookupType($a_obj_id);
                if ($type == "crs") {
                        require_once("Services/ContainerReference/classes/class.ilContainerReference.php");
                        $crs_reference_obj_ids = ilContainerReference::_lookupSourceIds($a_obj_id);
                        foreach ($crs_reference_obj_ids as $obj_id) {
                                foreach(ilObject::_getAllReferences($obj_id) as $ref_id) {
                                        self::setProgressesCompletedIfParentIsProgrammeInLPCompletedMode($ref_id, $obj_id, $a_user_id);
                                }
                        }
                }
                else {
                        foreach (ilObject::_getAllReferences($a_obj_id) as $ref_id) {
                                self::setProgressesCompletedIfParentIsProgrammeInLPCompletedMode($ref_id, $a_obj_id, $a_user_id);
                        }
                }
        }

Here is the call graph for this function:

Here is the caller graph for this function:

setProgressesCompletedIfParentIsProgrammeInLPCompletedMode()

static ilObjStudyProgramme::setProgressesCompletedIfParentIsProgrammeInLPCompletedMode (   $a_ref_id,   $a_obj_id,   $a_user_id  )

staticprotected

Definition at line 1180 of file class.ilObjStudyProgramme.php.

References $tree, getInstanceByRefId(), and ilStudyProgramme\MODE_LP_COMPLETED.

                                                                                                                               {
                global $tree; // TODO: replace this by a settable static for testing purpose?
                $node_data = $tree->getParentNodeData($a_ref_id);
                if ($node_data["type"] !== "prg") {
                        return;
                }
                self::initStudyProgrammeCache();
                $prg = ilObjStudyProgramme::getInstanceByRefId($node_data["child"]);
                if ($prg->getLPMode() != ilStudyProgramme::MODE_LP_COMPLETED) {
                        return;
                }
                foreach ($prg->getProgressesOf($a_user_id) as $progress) {
                        $progress->setLPCompleted($a_obj_id, $a_user_id);
                }
        }

Here is the call graph for this function:

setStatus()

ilObjStudyProgramme::setStatus

(

$a_status

)

Set the status of the node.

Parameters

integer

$a_status

- one of ilStudyProgramme::$STATUS

Returns

$this

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

References updateLastChange().

                                             {
                $this->settings->setStatus($a_status);
                $this->updateLastChange();
                return $this;
        }

Here is the call graph for this function:

setSubtypeId()

ilObjStudyProgramme::setSubtypeId

(

$a_subtype_id

)

Sets the meta-data subtype id.

Parameters

$a_subtype_id

Returns

$this

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

                                                    {
                $this->settings->setSubtypeId($a_subtype_id);
                return $this;
        }

throwIfNotInTree()

ilObjStudyProgramme::throwIfNotInTree ( )

protected

Helper function to check, weather object is in tree.

Throws ilStudyProgrammeTreeException if object is not in tree.

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

Referenced by addLeaf(), addNode(), applyToSubTreeNodes(), getChildren(), getLPChildren(), and getParent().

                                              {
                if (!$this->tree->isInTree($this->getRefId())) {
                        throw new ilStudyProgrammeTreeException("This program is not in tree.");
                }
        }

Here is the caller graph for this function:

update()

ilObjStudyProgramme::update

(

)

Definition at line 192 of file class.ilObjStudyProgramme.php.

References ilObject\getId(), getSubType(), ilAdvancedMDRecord\saveObjRecSelection(), and updateSettings().

Referenced by addLeaf(), and updateLastChange().

                                 {
                parent::update();

                // Update selection for advanced meta data of the type
                if ($this->getSubType()) {
                        ilAdvancedMDRecord::saveObjRecSelection($this->getId(), 'prg_type', $this->getSubType()->getAssignedAdvancedMDRecordIds());
                } else {
                        // If no type is assigned, delete relations by passing an empty array
                        ilAdvancedMDRecord::saveObjRecSelection($this->getId(), 'prg_type', array());
                }

                $this->updateSettings();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

updateAllAssignments()

ilObjStudyProgramme::updateAllAssignments

(

)

Update all assignments to this program node.

Returns

$this

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

References ilObject\getId(), and ilStudyProgrammeUserAssignment\getInstancesForProgram().

                                               {
                $assignments = ilStudyProgrammeUserAssignment::getInstancesForProgram($this->getId());
                foreach ($assignments as $ass) {
                        $ass->updateFromProgram();
                }
                return $this;
        }

Here is the call graph for this function:

updateCustomIcon()

ilObjStudyProgramme::updateCustomIcon

(

)

updates the selected custom icon in container folder by type

Definition at line 1227 of file class.ilObjStudyProgramme.php.

References getSubType(), ilContainer\removeCustomIcon(), and saveIcons().

                                           {
                $subtype = $this->getSubType();

                if($subtype) {
                        if(is_file($subtype->getIconPath(true))) {
                                $icon = $subtype->getIconPath(true);
                                $this->saveIcons($icon);
                        } else {
                                $this->removeCustomIcon();
                        }
                } else {
                        $this->removeCustomIcon();
                }
        }

Here is the call graph for this function:

updateLastChange()

ilObjStudyProgramme::updateLastChange ( )

protected

Update last change timestamp on this node and its parents.

Definition at line 1126 of file class.ilObjStudyProgramme.php.

References $parent, getParent(), and update().

Referenced by setPoints(), and setStatus().

                                              {
                $this->settings->updateLastChange();
                if ($parent = $this->getParent()) {
                        $parent->updateLastChange();
                }
                $this->update();
        }

Here is the call graph for this function:

Here is the caller graph for this function:

updateSettings()

ilObjStudyProgramme::updateSettings ( )

protected

Update settings in DB.

Throws when settings are not loaded.

Definition at line 151 of file class.ilObjStudyProgramme.php.

Referenced by update().

                                            {
                if ($this->settings === null) {
                        throw new ilException("ilObjStudyProgramme::updateSettings: no settings loaded.");
                }
                $this->settings->update();
        }

Here is the caller graph for this function:

Field Documentation

$children

ilObjStudyProgramme::$children

protected

Definition at line 21 of file class.ilObjStudyProgramme.php.

Referenced by getChildren().

$ilUser

ilObjStudyProgramme::$ilUser

Definition at line 26 of file class.ilObjStudyProgramme.php.

Referenced by __construct().

$lp_children

ilObjStudyProgramme::$lp_children

protected

Definition at line 22 of file class.ilObjStudyProgramme.php.

Referenced by getLPChildren().

$object_factory

ilObjStudyProgramme::$object_factory

Definition at line 29 of file class.ilObjStudyProgramme.php.

$parent

ilObjStudyProgramme::$parent

protected

Definition at line 20 of file class.ilObjStudyProgramme.php.

Referenced by getCreatableSubObjects(), getParent(), moveTo(), and updateLastChange().

$settings

ilObjStudyProgramme::$settings

protected

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

Referenced by getRawSettings().

$study_programme_cache

ilObjStudyProgramme::$study_programme_cache = null

static

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

$tree

ilObjStudyProgramme::$tree

Definition at line 25 of file class.ilObjStudyProgramme.php.

Referenced by __construct(), getParentId(), and setProgressesCompletedIfParentIsProgrammeInLPCompletedMode().

---

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

• Modules/StudyProgramme/classes/class.ilObjStudyProgramme.php