ilObjStudyProgramme Class Reference

Inheritance diagram for ilObjStudyProgramme:

Collaboration diagram for ilObjStudyProgramme:

Public Member Functions
	__construct ($a_id=0, bool $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 (int $a_points)
	Set the amount of points. More...
	getLPMode ()
	adjustLPMode ()
	Adjust the lp mode to match current state of tree: More...
	getStatus ()
	setStatus (int $a_status)
	Set the status of the node. More...
	isActive ()
	getSubType ()
	Gets the SubType Object. More...
	getTypeSettings ()
	setTypeSettings (\ilStudyProgrammeTypeSettings $type_settings)
	getAssessmentSettings ()
	setAssessmentSettings (\ilStudyProgrammeAssessmentSettings $assessment_settings)
	getDeadlineSettings ()
	setDeadlineSettings (\ilStudyProgrammeDeadlineSettings $deadline_settings)
	getValidityOfQualificationSettings ()
	setValidityOfQualificationSettings (\ilStudyProgrammeValidityOfAchievedQualificationSettings $validity_of_qualification_settings)
	getAccessControlByOrguPositionsGlobal ()
	getPositionSettingsIsActiveForPrg ()
	getPositionSettingsIsChangeableForPrg ()
	getAutoMailSettings ()
	setAutoMailSettings (\ilStudyProgrammeAutoMailSettings $automail_settings)
	shouldSendReAssignedMail ()
	shouldSendInfoToReAssignMail ()
	shouldSendRiskyToFailMail ()
	getAllPrgChildren ()
	getChildren (bool $include_references=false)
	Get all ilObjStudyProgrammes that are direct children of this object. More...
	getParent ()
	Get the parent ilObjStudyProgramme of this object. More...
	getReferencesToSelf ()
	getParents (bool $include_references=false)
	Get all parents of the node, where the root of the program comes first. More...
	hasChildren (bool $include_references=false)
	Does this StudyProgramme have other ilObjStudyProgrammes as children? More...
	getAmountOfChildren ($include_references=false)
	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, bool $include_references=false)
	Apply the given Closure to every node in the subtree starting at this object. More...
	getCompletedCourses (int $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...
	nodeInserted (ilObjStudyProgramme $a_prg)
	Clears child chache and adds progress for new node. 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 (ilStudyProgrammeLeaf $a_leaf)
	Insert a leaf in this object. More...
	removeLeaf (ilStudyProgrammeLeaf $a_leaf)
	Remove a leaf from this object. More...
	moveTo (ilObjStudyProgramme $a_new_parent)
	Move this tree node to a new parent. More...
	assignUser (int $a_usr_id, int $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 (int $a_user_id)
	Check whether user is assigned to this program or any node above. More...
	getAmountOfAssignmentsOf (int $a_user_id)
	Get the amount of assignments a user has on this program node or any node above. More...
	getAssignmentsOf (int $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...
	getMembers ()
	hasAssignments ()
	Are there any assignments on this node or any node above? More...
	updateAllAssignments ()
	Update all assignments to this program node. More...
	getAssignmentsOfSingleProgramForUser (int $usr_id)
	Get assignments of user to this program-node only. More...
	hasAssignmentsOfSingleProgramForUser (int $usr_id)
	Get assignments of user to this program-node only. More...
	createProgressForAssignment (ilStudyProgrammeAssignment $ass)
	Create a progress on this programme for the given assignment. More...
	getProgressesOf (int $a_user_id)
	Get the progresses the user has on this node. More...
	getProgressForAssignment (int $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...
	getIdsOfUsersWithFailedProgress ()
	Get the ids of all users that have failed this programme. More...
	getIdsOfUsersWithNotCompletedAndRelevantProgress ()
	Get the ids of all users that have not completed this programme but have a relevant progress on it. More...
	getAutomaticContentCategories ()
	Get configuration of categories with auto-content for this StudyProgramme;. More...
	hasAutomaticContentCategories ()
	storeAutomaticContentCategory (int $category_ref_id)
	Store a Category with auto-content for this StudyProgramme; a category can only be referenced once (per programme). More...
	deleteAutomaticContentCategories (array $category_ids=[])
	Delete configuration of categories with auto-content for this StudyProgramme;. More...
	deleteAllAutomaticContentCategories ()
	Delete all configuration of categories with auto-content for this StudyProgramme;. More...
	isAutoContentApplicable ()
	AutoContent should only be available in active- or draft-mode, and only, if there is no sub-programme. More...
	getAutomaticMembershipSources ()
	Get sources for auto-memberships. More...
	storeAutomaticMembershipSource (string $type, int $src_id)
	Store a source to be monitored for automatic memberships. More...
	deleteAutomaticMembershipSource (string $type, int $src_id)
	Delete a membership source. More...
	deleteAllAutomaticMembershipSources ()
	Delete all membership sources of this StudyProgramme;. More...
	disableAutomaticMembershipSource (string $type, int $src_id)
	Disable a membership source. More...
	enableAutomaticMembershipSource (string $type, int $src_id)
	Enable a membership source. More...
	getApplicableMembershipSourceForUser (int $usr_id, string $exclude_type)
	getRawSettings ()
	Get the underlying model of this program. More...
Public Member Functions inherited from ilContainer
	__construct ($a_id=0, $a_reference=true)
	getObjectTranslation ()
	Get object translation. More...
	setObjectTranslation (ilObjectTranslation $obj_trans)
	Get object translation. More...
	createContainerDirectory ()
	Create directory for the container. More...
	getContainerDirectory ()
	Get the container directory. 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...
	setNewsTimeline ($a_val)
	Set news timeline. More...
	getNewsTimeline ()
	Get news timeline. More...
	setNewsTimelineAutoEntries ($a_val)
	Set news timeline auto entries. More...
	getNewsTimelineAutoEntries ()
	Get news timeline auto entries. More...
	setNewsTimelineLandingPage ($a_val)
	Set news timline is landing page. More...
	getNewsTimelineLandingPage ()
	Get news timline is landing page. More...
	isNewsTimelineEffective ()
	Is news timeline effective? More...
	isNewsTimelineLandingPageEffective ()
	Is news timeline landing page effective? More...
	setNewsBlockActivated ($a_val)
	Set news block activated. More...
	getNewsBlockActivated ()
	Get news block activated. More...
	setUseNews ($a_val)
	Set use news. More...
	getUseNews ()
	Get use news. 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...
	delete ()
	delete category and all related data More...
	getViewMode ()
	Get container view mode. More...
	getOrderType ()
	Get order type default implementation. More...
	setOrderType ($a_value)
	isClassificationFilterActive ()
	Is classification filter active? More...
	filteredSubtree ()
	Note grp/crs currently allow to filter in their whole subtrees Catetories only their direct childs. More...
	getSubItems ( $a_admin_panel_enabled=false, $a_include_side_block=false, $a_get_single=0, \ilContainerUserFilter $container_user_filter=null)
	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...
	putInTree ($a_parent_ref)
	update ()
	Update. More...
	read ()
	read More...
	readContainerSettings ()
	Read container settings. More...
	removeTranslations ()
	Remove all translations of container. More...
	deleteTranslation ($a_lang)
	Delete translation. More...
	addTranslation ($a_title, $a_desc, $a_lang, $a_lang_default)
	Add translation. 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...

Static Public Member Functions
static	initStudyProgrammeCache ()
static	getInstanceByRefId ($a_ref_id)
static	createInstance ()
	Create an instance of ilObjStudyProgramme, put in cache. More...
static	getAllChildren (int $a_ref_id, bool $include_references=false)
	Get a list of all ilObjStudyProgrammes in the subtree starting at $a_ref_id. More...
static	addCrsToProgrammes (int $crs_ref_id, int $cat_ref_id)
	Check, if a category is under surveilllance and automatically add the course. More...
static	removeCrsFromProgrammes (int $crs_ref_id, int $cat_ref_id)
	Check, if a category is under surveilllance and automatically remove the deleted course. More...
static	addMemberToProgrammes (string $src_type, int $src_id, int $usr_id)
static	removeMemberFromProgrammes (string $src_type, int $src_id, int $usr_id)
static	setProgressesCompletedFor (int $a_obj_id, int $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 (array $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	sendInvalidateMail (int $ref_id, int $usr_id)
Static Public Member Functions inherited from ilContainer
static	_getContainerDirectory ($a_id)
	Get the container directory. More...
static	_lookupContainerSetting ($a_id, $a_keyword, $a_default_value=null)
	Lookup a container setting. More...
static	_writeContainerSetting ($a_id, $a_keyword, $a_value)
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	_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
	$webdir
	$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
	$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

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...
	getReferencesTo (ilObjStudyProgramme $prg)
	throwIfNotInTree ()
	Helper function to check, weather object is in tree. More...
	getMembersOfMembershipSource (string $src_type, int $src_id)
	Get member-ids of a certain source. More...
	updateLastChange ()
	Update last change timestamp on this node and its parents. More...
	getIdsFromNodesOnPathFromRootToHere (bool $include_references=false)
	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...
	getLog ()
Protected Member Functions inherited from ilContainer
	getInitialSubitems ()
	Get initial subitems. More...
	applyContainerUserFilter ($objects, ilContainerUserFilter $container_user_filter=null)
	Apply container user filter on objects. More...
	legacyOnlineFilter ($obj_ids, $objects, $val)
	Legacy online filter. More...

Static Protected Member Functions
static	getProgrammesMonitoringCategory (int $cat_ref_id)
	Get all StudyProgrammes monitoring this category. More...
static	getProgrammesMonitoringMemberSource (string $src_type, int $src_id)
	Get all StudyProgrammes monitoring this membership-source. More...
static	setProgressesCompletedIfParentIsProgrammeInLPCompletedMode (int $a_ref_id, int $a_obj_id, int $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
	$type_repository
	$assignment_repository
	$progress_repository
	$auto_categories_repository
	$auto_memberships_repository
	$membersourcereader_factory
	$progress_db
	$assignment_db
	$events
	$db
	$plugin_admin
	$settings_repository
	$ps
	$reference_children = []
	$members_cache
Protected Attributes inherited from ilContainer
	$db
	$log
	$access
	$error
	$rbacsystem
	$tree
	$user
	$obj_definition
	$order_type = 0
	$hiddenfilesfound = false
	$news_timeline = false
	$news_timeline_auto_entries = false
	$setting
	$obj_trans = null
	$recommended_content_manager
Protected Attributes inherited from ilObject
	$objDefinition
	$db
	$log
	$error
	$tree
	$app_event_handler
	$rbacadmin
	$rbacreview

Detailed Description

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

Constructor & Destructor Documentation

__construct()

ilObjStudyProgramme::__construct	(		$a_id = 0,
		bool	$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.

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

References $DIC, $ilUser, $tree, ILIAS\GlobalScreen\Provider\__construct(), clearChildrenCache(), clearLPChildrenCache(), clearParentCache(), ilStudyProgrammeDIC\dic(), settings(), and ilObjectFactoryWrapper\singleton().

    {
        $this->type = "prg";
        $this->settings = null;
        $this->settings_repository =
            ilStudyProgrammeDIC::dic()['model.Settings.ilStudyProgrammeSettingsRepository'];
        $this->type_repository =
            ilStudyProgrammeDIC::dic()['model.Type.ilStudyProgrammeTypeRepository'];
        $this->assignment_repository =
            ilStudyProgrammeDIC::dic()['model.Assignment.ilStudyProgrammeAssignmentRepository'];
        $this->progress_repository =
            ilStudyProgrammeDIC::dic()['model.Progress.ilStudyProgrammeProgressRepository'];
        $this->auto_categories_repository =
            ilStudyProgrammeDIC::dic()['model.AutoCategories.ilStudyProgrammeAutoCategoriesRepository'];
        $this->auto_memberships_repository =
            ilStudyProgrammeDIC::dic()['model.AutoMemberships.ilStudyProgrammeAutoMembershipsRepository'];
        $this->membersourcereader_factory =
            ilStudyProgrammeDIC::dic()['model.AutoMemberships.ilStudyProgrammeMembershipSourceReaderFactory'];

        $this->progress_db = ilStudyProgrammeDIC::dic()['ilStudyProgrammeUserProgressDB'];
        $this->assignment_db = ilStudyProgrammeDIC::dic()['ilStudyProgrammeUserAssignmentDB'];
        $this->events = ilStudyProgrammeDIC::dic()['ilStudyProgrammeEvents'];

        parent::__construct($a_id, $a_call_by_reference);

        $this->clearParentCache();
        $this->clearChildrenCache();
        $this->clearLPChildrenCache();

        global $DIC;
        $tree = $DIC['tree'];
        $ilUser = $DIC['ilUser'];
        $this->webdir = $DIC->filesystem()->web();
        $this->tree = $tree;
        $this->ilUser = $ilUser;
        $this->db = $DIC['ilDB'];
        $this->plugin_admin = $DIC['ilPluginAdmin'];
        $this->lng = $DIC['lng'];

        $this->object_factory = ilObjectFactoryWrapper::singleton();
        $this->ps = ilStudyProgrammeDIC::dic()['ilOrgUnitObjectTypePositionSetting'];

        self::initStudyProgrammeCache();
    }

Here is the call graph for this function:

Member Function Documentation

addCrsToProgrammes()

static ilObjStudyProgramme::addCrsToProgrammes ( int  $crs_ref_id, int  $cat_ref_id  )

static

Check, if a category is under surveilllance and automatically add the course.

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

References ilObject\_lookupObjectId(), and ilContainerReference\TITLE_TYPE_REUSE.

Referenced by ilStudyProgrammeAppEventListener\addCrsToProgrammes().

                                                                                : void
    {
        foreach (self::getProgrammesMonitoringCategory($cat_ref_id) as $prg) {
            $course_ref = new ilObjCourseReference();
            $course_ref->setTitleType(ilObjCourseReference::TITLE_TYPE_REUSE);
            $course_ref->setTargetRefId($crs_ref_id);
            $course_ref->create();
            $course_ref->createReference();
            $course_ref->putInTree($prg->getRefId());
            $course_ref->setPermissions($crs_ref_id);
            $course_ref->setTargetId(ilObject::_lookupObjectId($crs_ref_id));
            $course_ref->update();
        }
    }

Here is the call graph for this function:

Here is the caller graph for this function:

addLeaf()

ilObjStudyProgramme::addLeaf

(

ilStudyProgrammeLeaf

$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
ilException

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

References clearLPChildrenCache(), ilStudyProgrammeLeaf\createReference(), ilStudyProgrammeLeaf\getRefId(), ilObject\getRefId(), hasChildren(), ilStudyProgrammeSettings\MODE_LP_COMPLETED, ilStudyProgrammeLeaf\putInTree(), settings(), and throwIfNotInTree().

                                                          : ilObjStudyProgramme
    {
        $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_repository->update(
            $this->settings->setLPMode(ilStudyProgrammeSettings::MODE_LP_COMPLETED)
        );

        return $this;
    }

Here is the call graph for this function:

addMemberToProgrammes()

static ilObjStudyProgramme::addMemberToProgrammes ( string  $src_type, int  $src_id, int  $usr_id  )

static

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

References ilStudyProgrammeAutoMembershipSource\SOURCE_MAPPING.

Referenced by ilStudyProgrammeAppEventListener\addMemberToProgrammes().

                                                                                             : void
    {
        foreach (self::getProgrammesMonitoringMemberSource($src_type, $src_id) as $prg) {
            if (!$prg->hasAssignmentsOfSingleProgramForUser($usr_id)) {
                $assigned_by = ilStudyProgrammeAutoMembershipSource::SOURCE_MAPPING[$src_type];
                $prg->assignUser($usr_id, $assigned_by);
            }
        }
    }

Here is the caller 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.

ilStudyProgrammeUserAssignment[]

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

References Vendor\Package\$e, ilObject\$id, ilContainer\$log, $progress_repository, applyToSubTreeNodes(), getAssignments(), getLog(), setStatus(), and ilStudyProgrammeProgress\STATUS_NOT_RELEVANT.

Referenced by nodeInserted().

                                           : void
    {
        $progress_repository = $this->progress_repository;
        $log = $this->getLog();

        foreach ($this->getAssignments() as $ass) { 
            $id = $ass->getId();
            $assignment = $ass->getSPAssignment();

            $mapping = function (ilObjStudyProgramme $node) use ($id, $log, $progress_repository, $assignment) {
                try {
                    $node->getProgressForAssignment($id);
                } catch (ilStudyProgrammeNoProgressForAssignmentException $e) {
                    $log->debug("Adding progress for: " . $id . " " . $node->getId());
                    $progress_repository->update(
                        $progress_repository->createFor(
                            $node->getRawSettings(),
                            $assignment
                        )->setStatus(
                            ilStudyProgrammeProgress::STATUS_NOT_RELEVANT
                        )
                    );
                }
            };

            $this->applyToSubTreeNodes($mapping, true);
        }
    }

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.

Returns

ilObjStudyProgramme

Exceptions

ilStudyProgrammeTreeException

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

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

                                                        : ilObjStudyProgramme
    {
        $this->throwIfNotInTree();

        if ($this->getLPMode() == ilStudyProgrammeSettings::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 433 of file class.ilObjStudyProgramme.php.

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

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

Here is the call graph for this function:

applyToSubTreeNodes()

ilObjStudyProgramme::applyToSubTreeNodes	(	Closure	$fun,
		bool	$include_references = false
	)

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.

Exceptions

ilStudyProgrammeTreeException

Throws when this object is not in tree.

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

References getChildren(), and throwIfNotInTree().

Referenced by addMissingProgresses(), assignUser(), and getAllPrgChildren().

    {
        $this->throwIfNotInTree();

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

Here is the call graph for this function:

Here is the caller graph for this function:

assignUser()

ilObjStudyProgramme::assignUser	(	int	$a_usr_id,
		int	$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

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

References applyToSubTreeNodes(), createProgressForAssignment(), getDeadlineSettings(), ilObject\getId(), getStatus(), settings(), ilStudyProgrammeSettings\STATUS_ACTIVE, and ilStudyProgrammeProgress\STATUS_NOT_RELEVANT.

Referenced by enableAutomaticMembershipSource().

                                                                              : ilStudyProgrammeUserAssignment
    {
        $this->members_cache = null;
        if ($this->settings === null) {
            throw new ilException(
                "ilObjStudyProgramme::assignUser: Program was not properly created.'"
            );
        }

        if ($this->getStatus() != ilStudyProgrammeSettings::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 = $this->assignment_repository->createFor($this->settings->getObjId(), $a_usr_id, $a_assigning_usr_id);
        $ass = $this->assignment_db->getInstanceByModel($ass_mod);
        $this->applyToSubTreeNodes(
            function (ilObjStudyProgramme $node) use ($ass_mod, $a_assigning_usr_id) {
                $progress = $node->createProgressForAssignment($ass_mod);
                if ($node->getStatus() != ilStudyProgrammeSettings::STATUS_ACTIVE) {
                    $this->progress_repository->update(
                        $progress->setStatus(ilStudyProgrammeProgress::STATUS_NOT_RELEVANT)
                    );
                } else {
                    $deadline_date = null;
                    if ($deadline_date = $node->getDeadlineSettings()->getDeadlineDate()) {
                        $this->progress_repository->update(
                            $progress->setDeadline($deadline_date)
                        );
                    }
                    if ($deadline_period = $node->getDeadlineSettings()->getDeadlinePeriod()) {
                        $deadline_date = new DateTime();
                        $deadline_date->add(new DateInterval('P' . $deadline_period . 'D'));
                        $this->progress_repository->update(
                            $progress->setDeadline($deadline_date)
                        );
                    }
                    if ($deadline_date) {
                        $this->progress_db->getInstanceById($progress->getId())->recalculateFailedToDeadline();
                    }
                }
            },
            true
        );

        $this->events->userAssigned($ass);

        return $ass;
    }

Here is the call graph for this function:

Here is the caller 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.

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

References getProgresses(), and ilStudyProgrammeProgress\STATUS_NOT_RELEVANT.

Referenced by removeNode().

                                   : bool
    {
        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 200 of file class.ilObjStudyProgramme.php.

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

                                            : void
    {
        $this->children = null;
    }

Here is the caller graph for this function:

clearLPChildrenCache()

ilObjStudyProgramme::clearLPChildrenCache ( )

protected

Clear the cached lp children.

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

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

                                              : void
    {
        $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 191 of file class.ilObjStudyProgramme.php.

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

                                          : void
    {
        // 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

(

)

Exceptions

ilException

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

References ilObject\$id, and createSettings().

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

        return (int) $id;
    }

Here is the call graph for this function:

createInstance()

static ilObjStudyProgramme::createInstance ( )

static

Create an instance of ilObjStudyProgramme, put in cache.

Exceptions

ilException

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

Referenced by ilObjStudyProgrammeTest\createSmallTree(), ilPrgRestartAssignmentsCronJobTest\newPrg(), ilPrgInvalidateExpiredProgressesCronJobTest\newPrg(), ilStudyProgrammeProgressCalculationTest\setUp(), ilStudyProgrammeUserAssignmentTest\setUp(), ilStudyProgrammeLPTest\setUp(), ilStudyProgrammeUserProgressTest\setUp(), ilStudyProgrammeEventsTest\setUp(), ilObjStudyProgrammeTest\setUp(), ilStudyProgrammeAssignmentRepositoryTest\setUpBeforeClass(), ilStudyProgrammeProgressCalculationTest\setUpNodes(), ilStudyProgrammeUserProgressTest\test_limited_validity_accredited(), ilStudyProgrammeUserProgressTest\test_limited_validity_date(), ilStudyProgrammeUserProgressTest\test_limited_validity_period(), ilStudyProgrammeUserProgressTest\test_set_failed_limited_validity_future(), ilStudyProgrammeUserProgressTest\test_set_failed_limited_validity_past(), ilStudyProgrammeUserProgressTest\test_set_failed_no_limited_validity(), ilStudyProgrammeUserProgressTest\testCanBeCompleted3(), ilStudyProgrammeUserProgressTest\testCompletionOnDeeplyNestedProgresses(), ilStudyProgrammeLPTest\testNewNodesAreNotRelevant(), ilStudyProgrammeUserProgressTest\testNewNodesAreNotRelevant(), ilStudyProgrammeUserAssignmentTest\testNoRestartDate(), ilStudyProgrammeUserAssignmentTest\testRestartDate(), ilStudyProgrammeUserAssignmentTest\testRstartAssignment(), and ilObjStudyProgrammeTest\testTreeGetParents().

                                            : ilObjStudyProgramme
    {
        $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.

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

References settings().

Referenced by assignUser().

                                                                                 : ilStudyProgrammeProgress
    {
        return $this->progress_repository->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.

Exceptions

ilException	if settings are already created
ilException	if there is no oid to create settings

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

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

Referenced by create().

                                        : void
    {
        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 = $this->settings_repository->createFor($this->getId());
    }

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.

Exceptions

ilException

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

References Vendor\Package\$e, deleteAllAutomaticContentCategories(), deleteAllAutomaticMembershipSources(), deleteAssignments(), deleteSettings(), and ilObject\getId().

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

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

        $this->deleteAllAutomaticContentCategories();
        $this->deleteAllAutomaticMembershipSources();

        $this->events->raise('delete', ['object' => $this, 'obj_id' => $this->getId()]);
        return true;
    }

Here is the call graph for this function:

deleteAllAutomaticContentCategories()

ilObjStudyProgramme::deleteAllAutomaticContentCategories

(

)

Delete all configuration of categories with auto-content for this StudyProgramme;.

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

References ilObject\getId().

Referenced by delete().

                                                          : void
    {
        $this->auto_categories_repository->deleteFor($this->getId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteAllAutomaticMembershipSources()

ilObjStudyProgramme::deleteAllAutomaticMembershipSources

(

)

Delete all membership sources of this StudyProgramme;.

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

References ilObject\getId().

Referenced by delete().

                                                          : void
    {
        $this->auto_memberships_repository->deleteFor($this->getId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

deleteAssignments()

ilObjStudyProgramme::deleteAssignments ( )

protected

Delete all assignments from the DB.

Exceptions

ilException

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

References getAssignments().

Referenced by delete().

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

Here is the call graph for this function:

Here is the caller graph for this function:

deleteAutomaticContentCategories()

ilObjStudyProgramme::deleteAutomaticContentCategories

(

array

$category_ids = []

)

Delete configuration of categories with auto-content for this StudyProgramme;.

Parameters

int[]

$category_ids

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

References ilObject\getId().

                                                                               : void
    {
        $this->auto_categories_repository->delete($this->getId(), $category_ids);
    }

Here is the call graph for this function:

deleteAutomaticMembershipSource()

ilObjStudyProgramme::deleteAutomaticMembershipSource	(	string	$type,
		int	$src_id
	)

Delete a membership source.

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

References ilObject\getId().

                                                                               : void
    {
        $this->auto_memberships_repository->delete($this->getId(), $type, $src_id);
    }

Here is the call graph for this function:

deleteSettings()

ilObjStudyProgramme::deleteSettings ( )

protected

Delete settings from DB.

Throws when settings are not loaded.

Exceptions

ilException

if no settings are loaded

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

References settings().

Referenced by delete().

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

Here is the call graph for this function:

Here is the caller graph for this function:

disableAutomaticMembershipSource()

ilObjStudyProgramme::disableAutomaticMembershipSource	(	string	$type,
		int	$src_id
	)

Disable a membership source.

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

References ilObject\getId().

                                                                                : void
    {
        $ams = $this->auto_memberships_repository->create($this->getId(), $type, $src_id, false);
        $this->auto_memberships_repository->update($ams);
    }

Here is the call graph for this function:

enableAutomaticMembershipSource()

ilObjStudyProgramme::enableAutomaticMembershipSource	(	string	$type,
		int	$src_id
	)

Enable a membership source.

Exceptions

ilException

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

References ilObject\$type, assignUser(), getAssignmentsOfSingleProgramForUser(), ilObject\getId(), getMembersOfMembershipSource(), and ilStudyProgrammeAutoMembershipSource\SOURCE_MAPPING.

                                                                               : void
    {
        $assigned_by = ilStudyProgrammeAutoMembershipSource::SOURCE_MAPPING[$type];
        $member_ids = $this->getMembersOfMembershipSource($type, $src_id);

        foreach ($member_ids as $usr_id) {
            if (!$this->getAssignmentsOfSingleProgramForUser($usr_id)) {
                $this->assignUser($usr_id, $assigned_by);
            }
        }
        $ams = $this->auto_memberships_repository->create($this->getId(), $type, $src_id, true);
        $this->auto_memberships_repository->update($ams);
    }

Here is the call graph for this function:

getAccessControlByOrguPositionsGlobal()

ilObjStudyProgramme::getAccessControlByOrguPositionsGlobal

(

)

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

References getPositionSettingsIsActiveForPrg(), and getPositionSettingsIsChangeableForPrg().

                                                            : bool
    {
        return
            $this->getPositionSettingsIsActiveForPrg() &&
            !$this->getPositionSettingsIsChangeableForPrg()
        ;
    }

Here is the call graph for this function:

getAllChildren()

static ilObjStudyProgramme::getAllChildren ( int  $a_ref_id, bool  $include_references = false  )

static

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

Throws when object is not in tree.

Returns

ilObjStudyProgramme[]

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

References $ret, and ilObject\getId().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getAllPrgChildren()

ilObjStudyProgramme::getAllPrgChildren

(

)

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

References $ret, applyToSubTreeNodes(), and ilObject\getId().

Referenced by ilStudyProgrammeDashboardViewGUI\calculatePercent().

                                        : array
    {
        $ret = [];
        $this->applyToSubTreeNodes(
            function (ilObjStudyProgramme $prg) use (&$ret) {
                if ($prg->getId() == $this->getId()) {
                    return;
                }
                $ret[] = $prg;
            },
            false
        );
        return $ret;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAmountOfAssignmentsOf()

ilObjStudyProgramme::getAmountOfAssignmentsOf

(

int

$a_user_id

)

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

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

References getAssignmentsOf().

Referenced by hasAssignmentOf().

                                                             : int
    {
        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

(

$include_references = false

)

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

Returns

int

Exceptions

ilStudyProgrammeTreeException

when this object is not in tree.

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

References getChildren().

Referenced by adjustLPMode(), hasChildren(), and isAutoContentApplicable().

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

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 853 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:

getApplicableMembershipSourceForUser()

ilObjStudyProgramme::getApplicableMembershipSourceForUser	(	int	$usr_id,
		string	$exclude_type
	)

Returns

ilStudyProgrammeAutoMembershipSource | null

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

References getAutomaticMembershipSources(), and getMembersOfMembershipSource().

    {
        foreach ($this->getAutomaticMembershipSources() as $ams) {
            $src_type = $ams->getSourceType();
            if ($src_type !== $exclude_type) {
                $source_members = $this->getMembersOfMembershipSource($src_type, $ams->getSourceId());
                if (in_array($usr_id, $source_members)) {
                    return $ams;
                }
            }
        }
        return null;
    }

Here is the call graph for this function:

getAssessmentSettings()

ilObjStudyProgramme::getAssessmentSettings

(

)

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

References settings().

Referenced by ilObjStudyProgrammeSettingsGUI\buildFormElements(), getStatus(), setPoints(), and setStatus().

                                            : \ilStudyProgrammeAssessmentSettings
    {
        return $this->settings->getAssessmentSettings();
    }

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 1286 of file class.ilObjStudyProgramme.php.

References $assignment_db, and getAssignmentsRaw().

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

                                     : array
    {
        $assignment_db = $this->assignment_db;
        return array_map(function ($ass) use ($assignment_db) {
            return $assignment_db->getInstanceByModel($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

(

int

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

Returns

ilStudyProgrammeUserAssignment[]

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

References $assignment_db, and getIdsFromNodesOnPathFromRootToHere().

Referenced by getAmountOfAssignmentsOf().

                                                     : array
    {
        $prg_ids = $this->getIdsFromNodesOnPathFromRootToHere();
        $assignments = [];
        foreach ($prg_ids as $prg_id) {
            $assignments = array_merge(
                $assignments,
                $this->assignment_repository->readByUsrIdAndPrgId($a_user_id, $prg_id)
            );
        }
        usort($assignments, function ($a_one, $a_other) {
            return strcmp(
                $a_one->getLastChange()->format('Y-m-d'),
                $a_other->getLastChange()->format('Y-m-d')
            );
        });
        $assignment_db = $this->assignment_db;
        return array_map(function ($ass) use ($assignment_db) {
            return $assignment_db->getInstanceByModel($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:

getAssignmentsOfSingleProgramForUser()

ilObjStudyProgramme::getAssignmentsOfSingleProgramForUser

(

int

$usr_id

)

Get assignments of user to this program-node only.

Returns

ilStudyProgrammeUserAssignment[]

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

References ilObject\getId().

Referenced by enableAutomaticMembershipSource(), and hasAssignmentsOfSingleProgramForUser().

                                                                      : array
    {
        return $this->assignment_repository->readByUsrIdAndPrgId($usr_id, $this->getId());
    }

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.

Returns

ilStudyProgrammeAssignment[]

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

References getIdsFromNodesOnPathFromRootToHere(), and ilStudyProgrammeAssignment\getLastChange().

Referenced by getAssignments().

                                           : array
    {
        $assignments = [];
        foreach ($this->getIdsFromNodesOnPathFromRootToHere(true) as $prg_id) {
            $assignments = array_merge($this->assignment_repository->readByPrgId($prg_id), $assignments);
        }
        usort(
            $assignments,
            function (ilStudyProgrammeAssignment $a_one, ilStudyProgrammeAssignment $a_other) {
                return -strcmp(
                    $a_one->getLastChange()->format('Y-m-d'),
                    $a_other->getLastChange()->format('Y-m-d')
                );
            }
        );
        return $assignments;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAutoMailSettings()

ilObjStudyProgramme::getAutoMailSettings

(

)

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

References settings().

Referenced by ilObjStudyProgrammeSettingsGUI\buildFormElements(), shouldSendInfoToReAssignMail(), shouldSendReAssignedMail(), and shouldSendRiskyToFailMail().

                                          : \ilStudyProgrammeAutoMailSettings
    {
        return $this->settings->getAutoMailSettings();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAutomaticContentCategories()

ilObjStudyProgramme::getAutomaticContentCategories

(

)

Get configuration of categories with auto-content for this StudyProgramme;.

Returns

ilStudyProgrammeAutoCategory[]

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

References ilObject\getId().

Referenced by hasAutomaticContentCategories().

                                                    : array
    {
        return $this->auto_categories_repository->readFor($this->getId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getAutomaticMembershipSources()

ilObjStudyProgramme::getAutomaticMembershipSources

(

)

Get sources for auto-memberships.

Returns

ilStudyProgrammeAutoMembershipSource[]

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

References ilObject\getId().

Referenced by getApplicableMembershipSourceForUser().

                                                    : array
    {
        return $this->auto_memberships_repository->readFor($this->getId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getChildren()

ilObjStudyProgramme::getChildren

(

bool

$include_references = false

)

Get all ilObjStudyProgrammes that are direct children of this object.

Returns

ilObjStudyProgramme[]

Exceptions

ilStudyProgrammeTreeException

when this object is not in tree.

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

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

Referenced by applyToSubTreeNodes(), and getAmountOfChildren().

                                                                  : array
    {
        $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);
        }
        if ($include_references && $this->reference_children === null) {
            $this->reference_children = [];
            $ref_child_ref_ids = $this->tree->getChildsByType($this->getRefId(), "prgr");
            foreach ($this->children as $prg) {
                $ref_child_ref_ids =
                    array_merge(
                        $this->tree->getChildsByType($prg->getRefId(), "prgr"),
                        $ref_child_ref_ids
                    );
            }
            foreach (
                array_unique(
                    array_map(
                        function ($data) {
                            return $data['child'];
                        },
                        array_filter($ref_child_ref_ids, function ($data) {
                            return $data["deleted"] === null;
                        })
                    )
                ) as $prg_ref_id
            ) {
                $this->reference_children[] =
                    (new ilObjStudyProgrammeReference($prg_ref_id))->getReferencedObject();
            }
        }
        return $include_references ?
            array_merge($this->children, $this->reference_children) :
            $this->children;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getCompletedCourses()

ilObjStudyProgramme::getCompletedCourses

(

int

$a_user_id

)

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

Returns

int[]

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

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

                                                        : array
    {
        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 ( array  $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.

ilException

Parameters

string[]

$a_subobjects

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

References $DIC, Vendor\Package\$e, ilObject\$lng, ilContainer\$log, $name, $parent, ilObject\$ref_id, ilObjUser\_lookupFullname(), ilObjUser\_lookupGender(), ilObjUser\_lookupLogin(), ilObject\_lookupType(), getInstanceByRefId(), ilStudyProgrammeSettings\MODE_LP_COMPLETED, ilStudyProgrammeSettings\MODE_POINTS, and ilStudyProgrammeSettings\MODE_UNDEFINED.

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

                                                                                  : array
    {
        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 ilStudyProgrammeSettings::MODE_UNDEFINED:
                $possible_subobjects = $a_subobjects;
                break;
            case ilStudyProgrammeSettings::MODE_POINTS:
                $possible_subobjects = [
                    "prg" => $a_subobjects["prg"],
                    "prgr" => $a_subobjects["prgr"]
                ];
                break;
            case ilStudyProgrammeSettings::MODE_LP_COMPLETED:
                $possible_subobjects = ['crsr' => $a_subobjects['crsr']];
                break;
            default:
                throw new ilException("Undefined mode for study programme: '$mode'");
        }

        if ($parent->hasAutomaticContentCategories()) {
            $possible_subobjects = array_filter(
                $possible_subobjects,
                function ($subtype) {
                    return $subtype === 'crsr';
                },
                ARRAY_FILTER_USE_KEY

            );
        }
        return $possible_subobjects;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getDeadlineSettings()

ilObjStudyProgramme::getDeadlineSettings

(

)

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

References settings().

Referenced by assignUser(), ilObjStudyProgrammeSettingsGUI\buildFormElements(), and ilStudyProgrammeChangeDeadlineGUI\getDeadlineSubForm().

                                          : \ilStudyProgrammeDeadlineSettings
    {
        return $this->settings->getDeadlineSettings();
    }

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.

Returns

int

Exceptions

ilException

when this object is not in tree.

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

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

getIdsFromNodesOnPathFromRootToHere()

ilObjStudyProgramme::getIdsFromNodesOnPathFromRootToHere ( bool  $include_references = false )

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.

Returns

int[]

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

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

Referenced by getAssignmentsOf(), and getAssignmentsRaw().

                                                                                             : array
    {
        $prg_ids = array_map(function ($par) {
            return $par->getId();
        }, $this->getParents($include_references));
        $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 1473 of file class.ilObjStudyProgramme.php.

References getProgresses().

Referenced by getIdsOfUsersWithFailedProgress().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getIdsOfUsersWithFailedProgress()

ilObjStudyProgramme::getIdsOfUsersWithFailedProgress

(

)

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

Returns

int[]

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

References getIdsOfUsersWithCompletedProgress(), and getProgresses().

                                                      : array
    {
        $returns = array();
        foreach ($this->getProgresses() as $progress) {
            $progress->recalculateFailedToDeadline();
            if ($progress->isFailed() || $progress->isSuccessfulExpired()) {
                $returns[] = $progress->getUserId();
            }
        }
        return array_unique(array_diff($returns, $this->getIdsOfUsersWithCompletedProgress()));
    }

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 1509 of file class.ilObjStudyProgramme.php.

References getProgresses().

                                                                       : array
    {
        $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 1457 of file class.ilObjStudyProgramme.php.

References getProgresses().

                                                        : array
    {
        $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

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

Referenced by ilStudyProgrammeMembersTableGUI\__construct(), ilObjStudyProgrammeReferenceAccess\_checkAccess(), ilObjStudyProgrammeAccess\_checkAccess(), getChildren(), getCreatableSubObjects(), ilObjStudyProgrammeAutoCategoriesGUI\getObject(), ilStudyProgrammeChangeExpireDateGUI\getObject(), ilStudyProgrammeChangeDeadlineGUI\getObject(), ilObjStudyProgrammeSettingsGUI\getObject(), ilObjStudyProgrammeAutoMembershipsGUI\getObject(), ilObjStudyProgrammeReference\getParent(), getParent(), ilObjStudyProgrammeReference\getReferencedObject(), ilObjStudyProgrammeTreeExplorerGUI\getRootNode(), ilStudyProgrammeUserAssignment\getStudyProgramme(), ilStudyProgrammeUserProgress\getStudyProgramme(), ilStudyProgrammeAppEventListener\getStudyProgramme(), ilObjStudyProgrammeMembersGUI\getStudyProgramme(), ilObjStudyProgrammeReference\putInTree(), putInTree(), sendInvalidateMail(), setProgressesCompletedIfParentIsProgrammeInLPCompletedMode(), ilObjStudyProgrammeMembersGUI\setRefId(), ilObjStudyProgrammeTest\testDelete(), ilObjStudyProgrammeTest\testGetInstanceByRefId(), ilObjStudyProgrammeTest\testLoadByObjId(), ilObjStudyProgrammeTest\testSettings(), and ilStudyProgrammeType\updateAssignedStudyProgrammesIcons().

                                                         : ilObjStudyProgramme
    {
        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.

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

References settings().

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

Here is the call graph for this function:

getLog()

ilObjStudyProgramme::getLog ( )

protected

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

References ilLoggerFactory\getLogger().

Referenced by addMissingProgresses().

    {
        return ilLoggerFactory::getLogger($this->type);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getLPChildren()

ilObjStudyProgramme::getLPChildren

(

)

Get the leafs the study programme contains.

Returns

ilStudyProgrammeLeaf[]

Exceptions

ilStudyProgrammeTreeException

when this object is not in tree.

Definition at line 808 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'];

            $lp_children = array_map(function ($node_data) {
                $lp_obj = $this->object_factory->getInstanceByRefId($node_data["child"]);

                // filter out all StudyProgramme instances
                return ($lp_obj instanceof $this) ? 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.

Returns

ilStudyProgrammeLeaf[]

Exceptions

ilStudyProgrammeTreeException

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

(

)

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

References settings().

Referenced by addNode(), and nodeInserted().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getMembers()

ilObjStudyProgramme::getMembers

(

)

Returns

int[] | null

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

References $members_cache, and ilObject\getId().

Referenced by ilStudyProgrammePositionBasedAccess\getUsersInPrgAccessibleForOperation().

    {
        if (!$this->members_cache) {
            $this->members_cache = array_map(
                function ($assignment) {
                    return $assignment->getUserId();
                },
                $this->assignment_repository->readByPrgId($this->getId())
            );
        }
        return $this->members_cache;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getMembersOfMembershipSource()

ilObjStudyProgramme::getMembersOfMembershipSource ( string  $src_type, int  $src_id  )

protected

Get member-ids of a certain source.

Returns

int[]

Exceptions

InvalidArgumentException

if $src_type is not in AutoMembershipSource-types

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

Referenced by enableAutomaticMembershipSource(), and getApplicableMembershipSourceForUser().

                                                                                   : array
    {
        $source_reader = $this->membersourcereader_factory->getReaderFor($src_type, $src_id);
        return $source_reader->getMemberIds();
    }

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.

Returns

ilObjStudyProgramme | null

Exceptions

ilException

when this object is not in tree.

Definition at line 680 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 1907 of file class.ilObjStudyProgramme.php.

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

    {
        global $DIC;
        $tree = $DIC['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

(

bool

$include_references = false

)

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

Returns

ilObjStudyProgramme[]

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

References $parent, and getReferencesTo().

Referenced by getIdsFromNodesOnPathFromRootToHere(), and getRoot().

    {
        $current = $this;
        $parents = [];
        $queque = [$current];
        while ($element = array_shift($queque)) {
            $parent = $element->getParent();
            if ($parent === null || $include_references) {
                foreach ($this->getReferencesTo($element) as $reference) {
                    if ($this->tree->isDeleted($reference->getRefId())) {
                        continue;
                    }
                    $r_parent = $reference->getParent();
                    if (is_null($r_parent)) {
                        continue;
                    }
                    array_push($queque, $r_parent);
                    $parents[] = $r_parent;
                }
                continue;
            }
            array_push($queque, $parent);
            $parents[] = $parent;
        }
        return array_reverse($parents);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getPoints()

ilObjStudyProgramme::getPoints

(

)

Get the amount of points.

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

References settings().

Referenced by ilStudyProgrammeDashboardViewGUI\calculatePercent().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getPositionSettingsIsActiveForPrg()

ilObjStudyProgramme::getPositionSettingsIsActiveForPrg

(

)

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

Referenced by getAccessControlByOrguPositionsGlobal().

                                                        : bool
    {
        return $this->ps->isActive();
    }

Here is the caller graph for this function:

getPositionSettingsIsChangeableForPrg()

ilObjStudyProgramme::getPositionSettingsIsChangeableForPrg

(

)

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

Referenced by getAccessControlByOrguPositionsGlobal().

                                                            : bool
    {
        return $this->ps->isChangeableForObject();
    }

Here is the caller graph for this function:

getProgrammesMonitoringCategory()

static ilObjStudyProgramme::getProgrammesMonitoringCategory ( int  $cat_ref_id )

staticprotected

Get all StudyProgrammes monitoring this category.

Returns

ilObjStudyProgramme[]

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

References $db, ilObject\_getAllReferences(), and ilStudyProgrammeDIC\dic().

                                                                               : array
    {
        $db = ilStudyProgrammeDIC::dic()['model.AutoCategories.ilStudyProgrammeAutoCategoriesRepository'];
        $programmes = array_map(
            function ($rec) {
                $prg_obj_id = (int) array_shift(array_values($rec));
                $prg_ref_id = (int) array_shift(ilObject::_getAllReferences($prg_obj_id));
                $prg = self::getInstanceByRefId($prg_ref_id);
                if ($prg->isAutoContentApplicable()) {
                    return $prg;
                }
            },
            $db::getProgrammesFor($cat_ref_id)
        );
        return $programmes;
    }

Here is the call graph for this function:

getProgrammesMonitoringMemberSource()

static ilObjStudyProgramme::getProgrammesMonitoringMemberSource ( string  $src_type, int  $src_id  )

staticprotected

Get all StudyProgrammes monitoring this membership-source.

Returns

ilObjStudyProgramme[]

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

References $db, ilObject\_getAllReferences(), and ilStudyProgrammeDIC\dic().

                                                                                                 : array
    {
        $db = ilStudyProgrammeDIC::dic()['model.AutoMemberships.ilStudyProgrammeAutoMembershipsRepository'];
        $programmes = array_map(
            function ($rec) {
                $prg_obj_id = (int) array_shift(array_values($rec));
                $prg_ref_id = (int) array_shift(ilObject::_getAllReferences($prg_obj_id));
                $prg = self::getInstanceByRefId($prg_ref_id);
                return $prg;
            },
            $db::getProgrammesFor($src_type, $src_id)
        );
        return $programmes;
    }

Here is the call graph for this function:

getProgresses()

ilObjStudyProgramme::getProgresses

(

)

Get all progresses on this node.

Returns

ilStudyProgrammeUserProgress[]

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

References ilObject\getId().

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

                                    : array
    {
        return $this->progress_db->getInstancesForProgram($this->getId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getProgressesOf()

ilObjStudyProgramme::getProgressesOf

(

int

$a_user_id

)

Get the progresses the user has on this node.

Parameters

int

$a_user_id

Returns

ilStudyProgrammeUserProgress[]

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

References ilObject\getId().

Referenced by ilStudyProgrammeMailTemplateContext\getNewestProgressForUser().

                                                    : array
    {
        return $this->progress_db->getInstancesForUser($this->getId(), $a_user_id);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getProgressForAssignment()

ilObjStudyProgramme::getProgressForAssignment

(

int

$a_assignment_id

)

Get the progress for an assignment on this node.

Throws when assignment does not belong to this program.

Parameters

int

$a_assignment_id

Returns

ilStudyProgrammeUserProgress

Exceptions

ilException

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

References ilObject\getId().

Referenced by ilStudyProgrammeUserAssignment\delete().

                                                                   : ilStudyProgrammeUserProgress
    {
        return $this->progress_db->getInstanceForAssignment($this->getId(), $a_assignment_id);
    }

Here is the call graph for this function:

Here is the caller 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

ilStudyProgrammeSettings | null

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

References $DIC, $settings, ilObject\getId(), getSubType(), and ilObject\getType().

    {
        return $this->settings;
    }

Here is the call graph for this function:

getReferencesTo()

ilObjStudyProgramme::getReferencesTo ( ilObjStudyProgramme  $prg )

protected

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

References ilObject\$id, $tree, ilObject\_getAllReferences(), ilContainerReference\_lookupSourceIds(), and ilObject\getId().

Referenced by getParents(), and getReferencesToSelf().

                                                                 : array
    {
        $tree = $this->tree;
        return array_filter(
            array_map(
                function ($id) {
                    return new ilObjStudyProgrammeReference(
                        array_shift(
                            ilObject::_getAllReferences($id)
                        )
                    );
                },
                ilContainerReference::_lookupSourceIds($prg->getId())
            ),
            function ($prg_ref) use ($tree) {
                return !$tree->isDeleted($prg_ref->getRefId());
            }
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getReferencesToSelf()

ilObjStudyProgramme::getReferencesToSelf

(

)

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

References getReferencesTo().

                                          : array
    {
        return $this->getReferencesTo($this);
    }

Here is the call graph for this function:

getRoot()

ilObjStudyProgramme::getRoot

(

)

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

Returns

ilObjStudyProgramme

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

References getParents().

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

Here is the call graph for this function:

getStatus()

ilObjStudyProgramme::getStatus

(

)

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

References getAssessmentSettings().

Referenced by assignUser(), and isActive().

                                : int
    {
        return $this->getAssessmentSettings()->getStatus();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getSubType()

ilObjStudyProgramme::getSubType

(

)

Gets the SubType Object.

Returns

ilStudyProgrammeType | null

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

References getTypeSettings().

Referenced by getRawSettings().

    {
        if (!in_array($this->getTypeSettings()->getTypeId(), array("-", "0"))) {
            $subtype_id = $this->getTypeSettings()->getTypeId();
            return $this->type_repository->readType($subtype_id);
        }

        return null;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getTypeSettings()

ilObjStudyProgramme::getTypeSettings

(

)

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

References settings().

Referenced by ilObjStudyProgrammeSettingsGUI\buildForm(), ilObjStudyProgrammeSettingsGUI\buildFormElements(), getSubType(), and update().

                                      : \ilStudyProgrammeTypeSettings
    {
        return $this->settings->getTypeSettings();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getValidityOfQualificationSettings()

ilObjStudyProgramme::getValidityOfQualificationSettings

(

)

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

References settings().

Referenced by ilObjStudyProgrammeSettingsGUI\buildFormElements(), ilStudyProgrammeChangeExpireDateGUI\getValidityOfQualificationSubForm(), and ilStudyProgrammeUserProgress\maybeLimitProgressValidity().

                                                         : \ilStudyProgrammeValidityOfAchievedQualificationSettings
    {
        return $this->settings->getValidityOfQualificationSettings();
    }

Here is the call graph for this function:

Here is the caller graph for this function:

hasAssignmentOf()

ilObjStudyProgramme::hasAssignmentOf

(

int

$a_user_id

)

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

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

References getAmountOfAssignmentsOf().

                                                    : bool
    {
        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?

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

References getAssignments().

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

Here is the call graph for this function:

hasAssignmentsOfSingleProgramForUser()

ilObjStudyProgramme::hasAssignmentsOfSingleProgramForUser

(

int

$usr_id

)

Get assignments of user to this program-node only.

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

References getAssignmentsOfSingleProgramForUser().

                                                                      : bool
    {
        return count($this->getAssignmentsOfSingleProgramForUser($usr_id)) > 0;
    }

Here is the call graph for this function:

hasAutomaticContentCategories()

ilObjStudyProgramme::hasAutomaticContentCategories

(

)

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

References getAutomaticContentCategories().

                                                    : bool
    {
        return count($this->getAutomaticContentCategories()) > 0;
    }

Here is the call graph for this function:

hasChildren()

ilObjStudyProgramme::hasChildren

(

bool

$include_references = false

)

Does this StudyProgramme have other ilObjStudyProgrammes as children?

Exceptions

ilStudyProgrammeTreeException

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

References getAmountOfChildren().

Referenced by addLeaf().

                                                                  : bool
    {
        return $this->getAmountOfChildren($include_references) > 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 865 of file class.ilObjStudyProgramme.php.

References getAmountOfLPChildren().

Referenced by ilStudyProgrammeDashboardViewGUI\calculatePercent(), and isAutoContentApplicable().

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

Here is the call graph for this function:

Here is the caller graph for this function:

hasProgresses()

ilObjStudyProgramme::hasProgresses

(

)

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

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

References getProgresses().

                                    : bool
    {
        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?

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

References getProgresses().

                                            : bool
    {
        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 181 of file class.ilObjStudyProgramme.php.

References ilObjStudyProgrammeCache\singleton().

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

Here is the call graph for this function:

isActive()

ilObjStudyProgramme::isActive

(

)

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

References getStatus(), and ilStudyProgrammeSettings\STATUS_ACTIVE.

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

Here is the call graph for this function:

isAutoContentApplicable()

ilObjStudyProgramme::isAutoContentApplicable

(

)

AutoContent should only be available in active- or draft-mode, and only, if there is no sub-programme.

Exceptions

ilStudyProgrammeTreeException

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

References getAmountOfChildren(), hasLPChildren(), settings(), ilStudyProgrammeSettings\STATUS_ACTIVE, and ilStudyProgrammeSettings\STATUS_DRAFT.

                                              : bool
    {
        $valid_status = in_array(
            $this->settings->getAssessmentSettings()->getStatus(),
            [
                ilStudyProgrammeSettings::STATUS_DRAFT,
                ilStudyProgrammeSettings::STATUS_ACTIVE
            ]
        );

        $crslnk_allowed = (
            $this->hasLPChildren()
            || $this->getAmountOfChildren(true) === 0
        );

        return $valid_status && $crslnk_allowed;
    }

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
ilException

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

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

                                                              : ilObjStudyProgramme
    {
        global $DIC;
        $rbacadmin = $DIC['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

)

Clears child chache and adds progress for new node.

Exceptions

ilStudyProgrammeTreeException
ilException

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

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

    {
        if ($this->getLPMode() == ilStudyProgrammeSettings::MODE_LP_COMPLETED) {
            throw new ilStudyProgrammeTreeException("Program already contains leafs.");
        }

        if ($this->settings->getLPMode() !== ilStudyProgrammeSettings::MODE_POINTS) {
            $this->settings_repository->update(
                $this->settings->setLPMode(ilStudyProgrammeSettings::MODE_POINTS)
            );
        }

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

Parameters

int

$a_parent_ref

Exceptions

ilStudyProgrammeTreeException
ilException

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

(

)

Exceptions

ilException

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

References readSettings().

                           : void
    {
        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.

Exceptions

ilException	if settings are already loaded
ilException	if there is no oid to load settings

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

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

Referenced by read().

                                      : void
    {
        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 = $this->settings_repository->read($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

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

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

                                                                                   : ilObjStudyProgramme
    {
        $this->members_cache = null;
        if ($a_assignment->getStudyProgramme()->getId() != $this->getId()) {
            throw new ilException(
                "ilObjStudyProgramme::removeAssignment: Assignment '"
                . $a_assignment->getId() . "' does not belong to study "
                . "program '" . $this->getId() . "'."
            );
        }

        $this->events->userDeassigned($a_assignment);

        $a_assignment->delete();

        return $this;
    }

Here is the call graph for this function:

removeCrsFromProgrammes()

static ilObjStudyProgramme::removeCrsFromProgrammes ( int  $crs_ref_id, int  $cat_ref_id  )

static

Check, if a category is under surveilllance and automatically remove the deleted course.

Exceptions

ilStudyProgrammeTreeException

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

Referenced by ilStudyProgrammeAppEventListener\removeCrsFromProgrammes().

    {
        foreach (self::getProgrammesMonitoringCategory($cat_ref_id) as $prg) {
            foreach ($prg->getLPChildren() as $child) {
                if ((int) $child->getTargetRefId() === $crs_ref_id) {
                    $child->delete();
                }
            }
        }
    }

Here is the caller graph for this function:

removeLeaf()

ilObjStudyProgramme::removeLeaf

(

ilStudyProgrammeLeaf

$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

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

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

                                                             : ilObjStudyProgramme
    {
        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:

removeMemberFromProgrammes()

static ilObjStudyProgramme::removeMemberFromProgrammes ( string  $src_type, int  $src_id, int  $usr_id  )

static

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

References $assignment_db, ilStudyProgrammeDIC\dic(), ilStudyProgrammeAutoMembershipSource\SOURCE_MAPPING, and ilStudyProgrammeProgress\STATUS_IN_PROGRESS.

Referenced by ilStudyProgrammeAppEventListener\removeMemberFromProgrammes().

                                                                                                  : void
    {
        foreach (self::getProgrammesMonitoringMemberSource($src_type, $src_id) as $prg) {
            foreach ($prg->getProgressesOf($usr_id) as $progress) {
                if ($progress->getStatus() !== ilStudyProgrammeProgress::STATUS_IN_PROGRESS) {
                    continue;
                }
                $assignments = $prg->getAssignmentsOfSingleProgramForUser($usr_id);
                $next_membership_source = $prg->getApplicableMembershipSourceForUser($usr_id, $src_type);

                foreach ($assignments as $assignment) {
                    if (!is_null($next_membership_source)) {
                        $new_src_type = $next_membership_source->getSourceType();
                        $assigned_by = ilStudyProgrammeAutoMembershipSource::SOURCE_MAPPING[$new_src_type];
                        $assignment = $assignment->setLastChangeBy($assigned_by);
                        $prg->assignment_repository->update($assignment);
                        break;
                    } else {
                        $assignment_db = ilStudyProgrammeDIC::dic()['ilStudyProgrammeUserAssignmentDB'];
                        $user_assignment = $assignment_db->getInstanceByModel($assignment);
                        $prg->removeAssignment($user_assignment);
                    }
                }
            }
        }
    }

Here is the call graph for this function:

Here is the caller 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
ilStudyProgrammeTreeException

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

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

                                                           : ilObjStudyProgramme
    {
        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:

sendInvalidateMail()

static ilObjStudyProgramme::sendInvalidateMail ( int  $ref_id, int  $usr_id  )

static

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

References $DIC, Vendor\Package\$e, ilObject\$lng, $name, ilObjUser\_lookupFullname(), ilObjUser\_lookupGender(), ilObjUser\_lookupLogin(), and getInstanceByRefId().

                                                                        : bool
    {
        global $DIC;
        $lng = $DIC['lng'];
        $lng->loadLanguageModule("prg");
        $lng->loadLanguageModule("mail");

        $prg = ilObjStudyProgramme::getInstanceByRefId($ref_id);

        $subject = $lng->txt("invalidate_mail_subject");
        $gender = ilObjUser::_lookupGender($usr_id);
        $name = ilObjUser::_lookupFullname($usr_id);
        $body = sprintf(
            $lng->txt("invalidate_mail_body"),
            $lng->txt("mail_salutation_" . $gender),
            $name,
            $prg->getTitle()
        );

        $send = true;
        $mail = new ilMail(ANONYMOUS_USER_ID);
        try {
            $mail->enqueue(
                ilObjUser::_lookupLogin($usr_id),
                '',
                '',
                $subject,
                $body,
                null
            );
        } catch (Exception $e) {
            $send = false;
        }

        return $send;
    }

Here is the call graph for this function:

setAssessmentSettings()

ilObjStudyProgramme::setAssessmentSettings

(

\ilStudyProgrammeAssessmentSettings

$assessment_settings

)

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

References settings().

Referenced by ilObjStudyProgrammeSettingsGUI\buildForm(), setPoints(), and setStatus().

      : void {
        $this->settings = $this->settings->withAssessmentSettings($assessment_settings);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setAutoMailSettings()

ilObjStudyProgramme::setAutoMailSettings

(

\ilStudyProgrammeAutoMailSettings

$automail_settings

)

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

References settings().

Referenced by ilObjStudyProgrammeSettingsGUI\buildForm().

                                                                                              : void
    {
        $this->settings = $this->settings->withAutoMailSettings($automail_settings);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setDeadlineSettings()

ilObjStudyProgramme::setDeadlineSettings

(

\ilStudyProgrammeDeadlineSettings

$deadline_settings

)

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

References settings().

Referenced by ilObjStudyProgrammeSettingsGUI\buildForm().

                                                                                              : void
    {
        $this->settings = $this->settings->withDeadlineSettings($deadline_settings);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setPoints()

ilObjStudyProgramme::setPoints

(

int

$a_points

)

Set the amount of points.

Exceptions

ilException

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

References $settings, getAssessmentSettings(), setAssessmentSettings(), and updateLastChange().

                                             : ilObjStudyProgramme
    {
        $settings = $this->getAssessmentSettings();
        $settings = $settings->withPoints($a_points);
        $this->setAssessmentSettings($settings);
        $this->updateLastChange();
        return $this;
    }

Here is the call graph for this function:

setProgressesCompletedFor()

static ilObjStudyProgramme::setProgressesCompletedFor ( int  $a_obj_id, int  $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 1858 of file class.ilObjStudyProgramme.php.

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

Referenced by ilStudyProgrammeAppEventListener\onServiceTrackingUpdateStatus().

                                                                                    : void
    {
        // 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((int) $ref_id, (int) $obj_id, $a_user_id);
                }
            }
        } else {
            foreach (ilObject::_getAllReferences($a_obj_id) as $ref_id) {
                self::setProgressesCompletedIfParentIsProgrammeInLPCompletedMode((int) $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 ( int  $a_ref_id, int  $a_obj_id, int  $a_user_id  )

staticprotected

Exceptions

ilException

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

References $DIC, $tree, getInstanceByRefId(), and ilStudyProgrammeSettings\MODE_LP_COMPLETED.

      : void {
        global $DIC; // TODO: replace this by a settable static for testing purpose?
        $tree = $DIC['tree'];
        $node_data = $tree->getParentNodeData($a_ref_id);
        if ($node_data["type"] !== "prg") {
            return;
        }
        self::initStudyProgrammeCache();
        $prg = ilObjStudyProgramme::getInstanceByRefId($node_data["child"]);
        if ($prg->getLPMode() != ilStudyProgrammeSettings::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

(

int

$a_status

)

Set the status of the node.

Exceptions

ilException

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

References $settings, getAssessmentSettings(), setAssessmentSettings(), and updateLastChange().

Referenced by addMissingProgresses().

                                             : ilObjStudyProgramme
    {
        $settings = $this->getAssessmentSettings()->withStatus($a_status);
        $this->setAssessmentSettings($settings);
        $this->updateLastChange();
        return $this;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setTypeSettings()

ilObjStudyProgramme::setTypeSettings

(

\ilStudyProgrammeTypeSettings

$type_settings

)

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

References settings().

Referenced by ilObjStudyProgrammeSettingsGUI\buildForm().

                                                                                  : void
    {
        $this->settings = $this->settings->withTypeSettings($type_settings);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

setValidityOfQualificationSettings()

ilObjStudyProgramme::setValidityOfQualificationSettings

(

\ilStudyProgrammeValidityOfAchievedQualificationSettings

$validity_of_qualification_settings

)

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

References settings().

Referenced by ilObjStudyProgrammeSettingsGUI\buildForm().

      : void {
        $this->settings = $this->settings->withValidityOfQualificationSettings(
            $validity_of_qualification_settings
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

shouldSendInfoToReAssignMail()

ilObjStudyProgramme::shouldSendInfoToReAssignMail

(

)

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

References getAutoMailSettings().

                                                   : bool
    {
        return $this->getAutoMailSettings()->getReminderNotRestartedByUserDays() > 0;
    }

Here is the call graph for this function:

shouldSendReAssignedMail()

ilObjStudyProgramme::shouldSendReAssignedMail

(

)

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

References getAutoMailSettings().

                                               : bool
    {
        return $this->getAutoMailSettings()->getSendReAssignedMail();
    }

Here is the call graph for this function:

shouldSendRiskyToFailMail()

ilObjStudyProgramme::shouldSendRiskyToFailMail

(

)

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

References getAutoMailSettings().

                                                : bool
    {
        return $this->getAutoMailSettings()->getProcessingEndsNotSuccessfulDays() > 0;
    }

Here is the call graph for this function:

storeAutomaticContentCategory()

ilObjStudyProgramme::storeAutomaticContentCategory

(

int

$category_ref_id

)

Store a Category with auto-content for this StudyProgramme; a category can only be referenced once (per programme).

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

References ilObject\getId().

                                                                        : void
    {
        $ac = $this->auto_categories_repository->create(
            $this->getId(),
            $category_ref_id
        );
        $this->auto_categories_repository->update($ac);
    }

Here is the call graph for this function:

storeAutomaticMembershipSource()

ilObjStudyProgramme::storeAutomaticMembershipSource	(	string	$type,
		int	$src_id
	)

Store a source to be monitored for automatic memberships.

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

References ilObject\getId().

                                                                              : void
    {
        $ams = $this->auto_memberships_repository->create($this->getId(), $type, $src_id, false);
        $this->auto_memberships_repository->update($ams);
    }

Here is the call graph for this function:

throwIfNotInTree()

ilObjStudyProgramme::throwIfNotInTree ( )

protected

Helper function to check, weather object is in tree.

Throws ilStudyProgrammeTreeException if object is not in tree.

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

(

)

Exceptions

ilException

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

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

Referenced by updateLastChange().

                             : void
    {
        parent::update();

        // Update selection for advanced meta data of the type
        if ($this->getTypeSettings()->getTypeId()) {
            ilAdvancedMDRecord::saveObjRecSelection(
                $this->getId(),
                'prg_type',
                $this->type_repository->readAssignedAMDRecordIdsByType($this->getTypeSettings()->getTypeId())
            );
        } 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.

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

References ilObject\getId().

                                           : ilObjStudyProgramme
    {
        $this->members_cache = null;
        $assignments = $this->assignment_db->getInstancesForProgram((int) $this->getId());
        foreach ($assignments as $ass) {
            $ass->updateFromProgram();
        }
        return $this;
    }

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 1807 of file class.ilObjStudyProgramme.php.

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

Referenced by setPoints(), and setStatus().

                                          : void
    {
        $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.

Exceptions

ilException

if no settings are loaded

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

References settings().

Referenced by update().

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

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$assignment_db

ilObjStudyProgramme::$assignment_db

protected

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

Referenced by getAssignments(), getAssignmentsOf(), and removeMemberFromProgrammes().

$assignment_repository

ilObjStudyProgramme::$assignment_repository

protected

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

$auto_categories_repository

ilObjStudyProgramme::$auto_categories_repository

protected

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

$auto_memberships_repository

ilObjStudyProgramme::$auto_memberships_repository

protected

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

$children

ilObjStudyProgramme::$children

protected

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

Referenced by getChildren().

$db

ilObjStudyProgramme::$db

protected

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

Referenced by getProgrammesMonitoringCategory(), and getProgrammesMonitoringMemberSource().

$events

ilObjStudyProgramme::$events

protected

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

$ilUser

ilObjStudyProgramme::$ilUser

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

Referenced by __construct().

$lp_children

ilObjStudyProgramme::$lp_children

protected

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

Referenced by getLPChildren().

$members_cache

ilObjStudyProgramme::$members_cache

protected

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

Referenced by getMembers().

$membersourcereader_factory

ilObjStudyProgramme::$membersourcereader_factory

protected

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

$object_factory

ilObjStudyProgramme::$object_factory

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

$parent

ilObjStudyProgramme::$parent

protected

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

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

$plugin_admin

ilObjStudyProgramme::$plugin_admin

protected

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

$progress_db

ilObjStudyProgramme::$progress_db

protected

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

$progress_repository

ilObjStudyProgramme::$progress_repository

protected

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

Referenced by addMissingProgresses().

$ps

ilObjStudyProgramme::$ps

protected

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

$reference_children

ilObjStudyProgramme::$reference_children = []

protected

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

$settings

ilObjStudyProgramme::$settings

protected

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

Referenced by getRawSettings(), setPoints(), and setStatus().

$settings_repository

ilObjStudyProgramme::$settings_repository

protected

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

$study_programme_cache

ilObjStudyProgramme::$study_programme_cache = null

static

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

$tree

ilObjStudyProgramme::$tree

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

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

$type_repository

ilObjStudyProgramme::$type_repository

protected

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

$webdir

ilObjStudyProgramme::$webdir

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

---

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

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