Inheritance diagram for ilObjStudyProgramme:

Collaboration diagram for ilObjStudyProgramme:

Public Member Functions
	__construct (int $id=0, bool $call_by_reference=true)
	ATTENTION: After using the constructor the object won't be in the cache. More...

	getSettings ()

	updateSettings (ilStudyProgrammeSettings $settings)

	create ()

	update ()

	delete ()
	Delete Study Programme and all related data. More...

	hasAdvancedMetadata ()

	cloneObject (int $target_ref_id, int $copy_id=0, bool $omit_tree=false)

	getLastChange ()
	Get the timestamp of the last change on this program or sub program. More...

	getPoints ()
	Get the amount of points. More...

	setPoints (int $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...

	isCertificateActive ()

	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 obj-ids of the leafs the program contains. More...

	getAmountOfLPChildren ()
	Get the amount of leafs the study programme contains. More...

	hasLPChildren ()

	applyToSubTreeNodes (Closure $fun, bool $include_references=false)
	Apply the given Closure to every node in the subtree starting at this object. More...

	getCompletedCourses (int $usr_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 ($prg)
	Clears child cache and adds progress for new node. More...

	putInTree (int $parent_ref_id)
	Overwritten from ilObject. More...

	removeNode (ilObjStudyProgramme $a_prg)
	Remove a node from this object. More...

	canBeRemoved ()
	Check weather a node can be removed. More...

	moveTo (ilObjStudyProgramme $new_parent)
	Move this tree node to a new parent. More...

	assignUser (int $usr_id, ?int $acting_usr_id=null, $raise_event=true)
	Assign a user to this node at the study program. More...

	removeAssignment (ilPRGAssignment $assignment)
	Remove an assignment from this program. More...

	getSpecificAssignment (int $assignment_id)

	storeExpiryInfoSentFor (ilPRGAssignment $ass)

	resetExpiryInfoSentFor (ilPRGAssignment $ass)

	storeRiskyToFailSentFor (ilPRGAssignment $ass)

	resetRiskyToFailSentFor (ilPRGAssignment $ass)

	hasAssignmentOf (int $user_id)
	Check whether user is assigned to this program or any node above. More...

	getAmountOfAssignmentsOf (int $user_id)
	Get the amount of assignments a user has on this program node or any node above. More...

	getAssignmentsOf (int $user_id)
	Get the assignments of user at this program or any node above. More...

	getAssignments ()

	getMembers ()
	get usr_ids with any progress on this node More...

	getLocalMembers ()
	get usr_ids with assignment on this node More...

	hasAssignments ()
	Are there any assignments on this node or any node above? 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...

	addMissingProgresses ()
	Add missing progress records for all assignments of this programm. More...

	hasRelevantProgresses ()
	Are there any users that have a relevant progress on this programme? More...

	getIdsOfUsersWithRelevantProgress ()

	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, bool $search_recursive)
	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, bool $search_recursive)
	Disable a membership source. More...

	enableAutomaticMembershipSource (string $type, int $src_id, bool $search_recursive, $assign_now=false)
	Enable a membership source. More...

	getApplicableMembershipSourceForUser (int $usr_id, ?int $exclude_id)

	succeed (int $usr_id, int $triggering_obj_id, ?ilPRGAssignment $ass=null)

	updateCustomIcon ()

	markAccredited (int $assignment_id, int $acting_usr_id, ilPRGMessageCollection $err_collection)

	unmarkAccredited (int $assignment_id, int $acting_usr_id, ilPRGMessageCollection $err_collection)

	markNotRelevant (int $assignment_id, int $acting_usr_id, ilPRGMessageCollection $err_collection)

	markRelevant (int $assignment_id, int $acting_usr_id, ilPRGMessageCollection $err_collection)

	changeProgressDeadline (int $assignment_id, int $acting_usr_id, ilPRGMessageCollection $err_collection, ?DateTimeImmutable $deadline)

	changeProgressValidityDate (int $assignment_id, int $acting_usr_id, ilPRGMessageCollection $err_collection, ?DateTimeImmutable $validity)

	changeAmountOfPoints (int $assignment_id, int $acting_usr_id, ilPRGMessageCollection $err_collection, int $points)

	updatePlanFromRepository (int $assignment_id, int $acting_usr_id, ?ilPRGMessageCollection $err_collection=null)

	acknowledgeCourses (int $assignment_id, array $nodes, ?ilPRGMessageCollection $err_collection=null)

	canBeCompleted (ilPRGProgress $progress)

	statusToRepr (int $status)
	Get a user readable representation of a status. More...

	hasContentPage ()

	createContentPage ()

Public Member Functions inherited from ilContainer
	getTileSizes ()

	getObjectTranslation ()

	setObjectTranslation (?ilObjectTranslation $obj_trans)

	createContainerDirectory ()

	getContainerDirectory ()

	setHiddenFilesFound (bool $a_hiddenfilesfound)

	getHiddenFilesFound ()

	getStyleSheetId ()

	setStyleSheetId (int $a_style_id)

	setNewsTimeline (bool $a_val)

	getNewsTimeline ()

	setNewsTimelineAutoEntries (bool $a_val)

	getNewsTimelineAutoEntries ()

	setNewsTimelineLandingPage (bool $a_val)

	getNewsTimelineLandingPage ()

	isNewsTimelineEffective ()

	isNewsTimelineLandingPageEffective ()

	setNewsBlockActivated (bool $a_val)

	getNewsBlockActivated ()

	setUseNews (bool $a_val)

	getUseNews ()

	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies (container sorting) More...

	cloneAllObject (string $session_id, string $client_id, string $new_type, int $ref_id, int $clone_source, array $options, bool $soap_call=false, int $a_submode=1)

	delete ()
	delete category and all related data More...

	getViewMode ()

	getOrderType ()

	setOrderType (int $a_value)

	isClassificationFilterActive ()

	filteredSubtree ()
	Note grp/crs currently allow to filter in their whole subtrees Catetories only their direct childs. More...

	getSubItems (bool $a_admin_panel_enabled=false, bool $a_include_side_block=false, int $a_get_single=0, ?ilContainerUserFilter $container_user_filter=null)

	gotItems ()

	addAdditionalSubItemInformation (array &$object)
	Add additional information to sub item, e.g. More...

	getGroupedObjTypes ()

	enablePageEditing ()

	create ()

	putInTree (int $parent_ref_id)

	update ()

	read ()

	readContainerSettings ()

	removeTranslations ()

	deleteTranslation (string $a_lang)

	addTranslation (string $a_title, string $a_desc, string $a_lang, string $a_lang_default)

Public Member Functions inherited from ilObject
	getObjectProperties ()

	flushObjectProperties ()

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

	processAutoRating ()

	read ()

	getId ()

	setId (int $id)

	setRefId (int $ref_id)

	getRefId ()

	getType ()

	setType (string $type)

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

	getTitle ()

	getUntranslatedTitle ()
	Get untranslated object title WebDAV needs to access the untranslated title of an object. More...

	setTitle (string $title)

	getDescription ()

	setDescription (string $description)

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

	getImportId ()

	setImportId (string $import_id)

	setOfflineStatus (bool $status)

	getOfflineStatus ()

	supportsOfflineHandling ()

	getOwner ()

	getOwnerName ()
	get full name of object owner More...

	setOwner (int $usr_id)

	getCreateDate ()
	Get create date in YYYY-MM-DD HH-MM-SS format. More...

	getLastUpdateDate ()
	Get last update date in YYYY-MM-DD HH-MM-SS format. More...

	create ()
	note: title, description and type should be set when this function is called More...

	update ()

	MDUpdateListener (string $element)
	Metadata update listener. More...

	createMetaData ()

	updateMetaData ()

	deleteMetaData ()

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

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

	setPermissions (int $parent_ref_id)

	setParentRolePermissions (int $parent_ref_id)
	Initialize the permissions of parent roles (local roles of categories, global roles...) This method is overwritten in e.g. More...

	createReference ()
	creates reference for object More...

	countReferences ()

	delete ()
	delete object or referenced object (in the case of a referenced object, object data is only deleted if last reference is deleted) This function removes an object entirely from system!! More...

	initDefaultRoles ()
	init default roles settings Purpose of this function is to create a local role folder and local roles, that are needed depending on the object type. More...

	applyDidacticTemplate (int $tpl_id)

	getXMLZip ()

	getHTMLDirectory ()

	appendCopyInfo (int $target_id, int $copy_id)
	Prepend Copy info if object with same name exists in that container. More...

	cloneDependencies (int $target_id, int $copy_id)
	Clone object dependencies. More...

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

	selfOrParentWithRatingEnabled ()

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

Static Public Member Functions
static	initStudyProgrammeCache ()

static	getRefIdFor (int $obj_id)

static	getInstanceByObjId (int $obj_id)

static	getInstanceByRefId ($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 surveillance 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 $obj_id, int $user_id)
	Succeed all StudyProgramme(Nodes) where the object with the given id (a CRSR) is in a Programme with MODE_LP_COMPLETED. More...

static	setProgressesCompletedIfParentIsProgrammeInLPCompletedMode (int $ref_id, int $obj_id, int $user_id)

static	getCreatableSubObjects (array $subobjects, $ref_id)
	Filter the list of possible subobjects for the objects that actually could be created on a concrete node. More...

Static Public Member Functions inherited from ilContainer
static	_getContainerDirectory (int $a_id)

static	_lookupContainerSetting (int $a_id, string $a_keyword, ?string $a_default_value=null)

static	_hasContainerSetting (int $a_id, string $a_keyword)

static	_writeContainerSetting (int $a_id, string $a_keyword, string $a_value)

static	_getContainerSettings (int $a_id)

static	_deleteContainerSettings (int $a_id, string $a_keyword="", bool $a_keyword_like=false)

static	_exportContainerSettings (ilXmlWriter $a_xml, int $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 (string $import_id)
	Get (latest) object id for an import id. More...

static	_lookupImportId (int $obj_id)

static	_lookupOwnerName (int $owner_id)
	Lookup owner name for owner id. More...

static	_getIdForImportId (string $import_id)

static	_getAllReferences (int $id)
	get all reference ids for object ID More...

static	_lookupTitle (int $obj_id)

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

static	_lookupOwner (int $obj_id)
	Lookup owner user ID for object ID. More...

static	_getIdsForTitle (string $title, string $type='', bool $partial_match=false)

static	_lookupDescription (int $obj_id)

static	_lookupLastUpdate (int $obj_id, bool $formatted=false)

static	_getLastUpdateOfObjects (array $obj_ids)

static	_lookupObjId (int $ref_id)

static	_setDeletedDate (int $ref_id, int $deleted_by)

static	setDeletedDates (array $ref_ids, int $user_id)

static	_resetDeletedDate (int $ref_id)

static	_lookupDeletedDate (int $ref_id)

static	_writeTitle (int $obj_id, string $title)
	write title to db (static) More...

static	_writeDescription (int $obj_id, string $desc)
	write description to db (static) More...

static	_writeImportId (int $obj_id, string $import_id)
	write import id to db (static) More...

static	_lookupType (int $id, bool $reference=false)

static	_isInTrash (int $ref_id)

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

static	_lookupObjectId (int $ref_id)

static	_getObjectsDataForType (string $type, bool $omit_trash=false)
	get all objects of a certain type More...

static	_exists (int $id, bool $reference=false, ?string $type=null)
	checks if an object exists in object_data More...

static	_getObjectsByType (string $obj_type="", ?int $owner=null)

static	_prepareCloneSelection (array $ref_ids, string $new_type, bool $show_path=true)
	Prepare copy wizard object selection. More...

static	getIconForType (string $type)

static	_getIcon (int $obj_id=0, string $size="big", string $type="", bool $offline=false)
	Get icon for repository item. More...

static	collectDeletionDependencies (array &$deps, int $ref_id, int $obj_id, string $type, int $depth=0)
	Collect deletion dependencies. More...

static	getDeletionDependencies (int $obj_id)
	Get deletion dependencies. More...

static	getLongDescriptions (array $obj_ids)

static	getAllOwnedRepositoryObjects (int $user_id)

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

static	_lookupCreationDate (int $obj_id)

static	_getObjectTypeIdByTitle (string $type, ?\ilDBInterface $ilDB=null)

Data Fields
const	CP_TYPE = 'cont'

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

const	TILE_NORMAL = 0

const	TILE_SMALL = 1

const	TILE_LARGE = 2

const	TILE_EXTRA_LARGE = 3

const	TILE_FULL = 4

array	$items = []

Data Fields inherited from ilObject
const	TITLE_LENGTH = 255

const	DESC_LENGTH = 128

const	LONG_DESC_LENGTH = 4000

const	TABLE_OBJECT_DATA = "object_data"

array	$objectList

string	$untranslatedTitle

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

	getPrgInstanceByObjId (int $obj_id)

	getAssignmentRepository ()

	getSettingsRepository ()

	getTree ()

	getLogger ()

	deleteSettings ()

	deleteAssignmentsAndProgresses ()
	Delete all assignments from the DB. More...

	getReferencesTo (ilObjStudyProgramme $prg)

	throwIfNotInTree ()

	getMembersOfMembershipSource (ilStudyProgrammeAutoMembershipSource $ams, ?int $exclude_id)
	Get member-ids of a certain source. More...

	updateLastChange ()
	Update last change timestamp on this node and its parents. More...

	getLoggedInUserId ()

	getNow ()

	refreshLPStatus (int $usr_id, ?int $node_obj_id=null)

Protected Member Functions inherited from ilContainer
	getInitialSubitems ()

	applyContainerUserFilter (array $objects, ?ilContainerUserFilter $container_user_filter=null)

Protected Member Functions inherited from ilObject
	doMDUpdateListener (string $a_element)

	beforeMDUpdateListener (string $a_element)

	doCreateMetaData ()

	beforeCreateMetaData ()

	doUpdateMetaData ()

	beforeUpdateMetaData ()

	doDeleteMetaData ()

	beforeDeleteMetaData ()

	handleAutoRating ()

	hasAutoRating ()

Static Protected Member Functions
static	getProgrammesMonitoringCategory (int $cat_ref_id)
	Get all (not OUTDATED) StudyProgrammes monitoring this category. More...

static	getProgrammesMonitoringMemberSource (string $src_type, int $src_id)
	Get all StudyProgrammes monitoring this membership-source. More...

Protected Attributes
	$parent

array	$children = null

array	$lp_children = null

ilStudyProgrammeTypeDBRepository	$type_repository

ilPRGAssignmentDBRepository	$assignment_repository

ilStudyProgrammeAutoCategoryDBRepository	$auto_categories_repository

ilStudyProgrammeAutoMembershipsDBRepository	$auto_memberships_repository

ilStudyProgrammeMembershipSourceReaderFactory	$membersourcereader_factory

ilStudyProgrammeEvents	$events

ilStudyProgrammeSettingsDBRepository	$settings_repository

array	$members_cache = null

array	$reference_children = null

Filesystem	$webdir

ilObjUser	$ilUser

ilObjectFactoryWrapper	$object_factory = null

ilObjectCustomIconFactory	$custom_icon_factory

ilLogger	$logger

Protected Attributes inherited from ilContainer
News	$news

ILIAS Style Content DomainService	$content_style_domain

ILIAS Container InternalDomainService	$domain

ilAccessHandler	$access

ilRbacSystem	$rbacsystem

ilObjUser	$user

ilObjectDefinition	$obj_definition

int	$order_type = 0

bool	$hiddenfilesfound = false

bool	$news_timeline = false

bool	$news_timeline_auto_entries = false

ilSetting	$setting

ilObjectTranslation	$obj_trans = null

int	$style_id = 0

bool	$news_timeline_landing_page = false

bool	$news_block_activated = false

bool	$use_news = false

ilRecommendedContentManager	$recommended_content_manager

array	$type_grps = null

Protected Attributes inherited from ilObject
ilLogger	$obj_log

ILIAS	$ilias

ilObjectDefinition	$obj_definition

ilDBInterface	$db

ilLogger	$log

ilErrorHandling	$error

ilTree	$tree

ilAppEventHandler	$app_event_handler

ilRbacAdmin	$rbac_admin

ilRbacReview	$rbac_review

ilObjUser	$user

ilLanguage	$lng

LOMServices	$lom_services

bool	$call_by_reference

int	$max_title = self::TITLE_LENGTH

int	$max_desc = self::DESC_LENGTH

bool	$add_dots = true

int	$ref_id = null

string	$type = ""

string	$title = ""

string	$desc = ""

string	$long_desc = ""

int	$owner = 0

string	$create_date = ""

string	$last_update = ""

string	$import_id = ""

bool	$register = false

Static Protected Attributes
static ilObjStudyProgrammeCache	$study_programme_cache = null

Additional Inherited Members
Static Public Attributes inherited from ilContainer
static bool	$data_preloaded = false

Detailed Description

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

Constructor & Destructor Documentation

◆ __construct()

ilObjStudyProgramme::__construct	(	int	$id = `0`,
		bool	$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 74 of file class.ilObjStudyProgramme.php.

References ilObject\$call_by_reference, $DIC, $dic, $id, $ilUser, ilObject\$tree, ILIAS\GlobalScreen\Provider\__construct(), clearChildrenCache(), clearLPChildrenCache(), clearParentCache(), ilStudyProgrammeDIC\dic(), ilLoggerFactory\getLogger(), ILIAS\Repository\lng(), ILIAS\Repository\logger(), and ilObjectFactoryWrapper\singleton().

     {
         $dic = ilStudyProgrammeDIC::dic();
         $this->type = "prg";
 
         $this->type_repository = $dic['model.Type.ilStudyProgrammeTypeRepository'];
         $this->auto_categories_repository = $dic['model.AutoCategories.ilStudyProgrammeAutoCategoriesRepository'];
         $this->auto_memberships_repository = $dic['model.AutoMemberships.ilStudyProgrammeAutoMembershipsRepository'];
         $this->membersourcereader_factory = $dic['model.AutoMemberships.ilStudyProgrammeMembershipSourceReaderFactory'];
 
         $this->settings_repository = $dic['model.Settings.ilStudyProgrammeSettingsRepository'];
         $this->assignment_repository = $dic['repo.assignment'];
         $this->events = $dic['ilStudyProgrammeEvents'];
 
         parent::__construct($id, $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->lng = $DIC['lng'];
         $this->logger = ilLoggerFactory::getLogger($this->type);
 
         $this->object_factory = ilObjectFactoryWrapper::singleton();
 
         $this->custom_icon_factory = $DIC['object.customicons.factory'];
 
         self::initStudyProgrammeCache();
     }

Here is the call graph for this function:

Member Function Documentation

◆ acknowledgeCourses()

ilObjStudyProgramme::acknowledgeCourses	(	int	$assignment_id,
		array	$nodes,
		?ilPRGMessageCollection	$err_collection = `null`
	)

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

References getLoggedInUserId(), and refreshLPStatus().

      : void {
         $acting_usr_id = $this->getLoggedInUserId();
         $assignment = $this->assignment_repository->get($assignment_id);
         foreach ($nodes as $nodeinfo) {
             [$node_obj_id, $course_obj_id] = $nodeinfo;
 
             $assignment = $assignment->succeed(
                 $this->settings_repository,
                 $node_obj_id,
                 $course_obj_id
             );
 
             $msg = sprintf(
                 '%s, progress-id (%s/%s)',
                 $assignment->getUserInformation()->getFullname(),
                 $assignment->getId(),
                 (string) $node_obj_id
             );
             $err_collection->add(true, 'acknowledged_course', $msg);
         }
         $this->assignment_repository->store($assignment);
         $this->refreshLPStatus($assignment->getUserId());
     }

Here is the call graph for this function:

◆ 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 1250 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(ilContainerReference::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();
             $lp = new ilLPObjSettings($course_ref->getId());
             $lp->insert();
             $lp->setMode($lp::LP_MODE_COURSE_REFERENCE);
             $lp->update(false);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ addMemberToProgrammes()

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

static

Definition at line 1463 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->isActive() &&
                 !$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, i.e.: there was a node added below this one.

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

References getAssignments().

Referenced by nodeInserted().

                                           : void
     {
         $assignments = $this->getAssignments();
         foreach ($assignments as $ass) {
             $this->assignment_repository->store($ass);
         }
     }

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.

Parameters

ilObjStudyProgramme $a_prg

Returns: ilObjStudyProgramme

Exceptions

ilException
ilStudyProgrammeTreeException

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

References ilObject\createReference(), getLPMode(), ilObject\getRefId(), ilStudyProgrammeSettings\MODE_LP_COMPLETED, null, 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 364 of file class.ilObjStudyProgramme.php.

References clearChildrenCache(), clearLPChildrenCache(), getAmountOfChildren(), getAmountOfLPChildren(), getSettings(), ilStudyProgrammeSettings\MODE_LP_COMPLETED, ilStudyProgrammeSettings\MODE_POINTS, and ilStudyProgrammeSettings\MODE_UNDEFINED.

                                   : void
     {
         // Clear caches here, there have been some changes, because this method
         // would not have been called otherwise, and the changer just does not
         // know if we have filled the caches already...
         $this->clearLPChildrenCache();
         $this->clearChildrenCache();
 
         if ($this->tree->isInTree($this->getRefId())) {
             if ($this->getAmountOfLPChildren() > 0) {
                 $this->settings_repository->update(
                     $this->getSettings()->setLPMode(ilStudyProgrammeSettings::MODE_LP_COMPLETED)
                 );
             } elseif ($this->getAmountOfChildren(true) > 0) {
                 $this->settings_repository->update(
                     $this->getSettings()->setLPMode(ilStudyProgrammeSettings::MODE_POINTS)
                 );
             } else {
                 $this->settings_repository->update(
                     $this->getSettings()->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 743 of file class.ilObjStudyProgramme.php.

References getChildren(), and throwIfNotInTree().

Referenced by getAllPrgChildren().

                                                                                        : void
     {
         $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	$usr_id,
		?int	$acting_usr_id = `null`,
			$raise_event = `true`
	)

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

References ilObject\getId(), getLoggedInUserId(), getSettingsRepository(), getStatus(), null, and ilStudyProgrammeSettings\STATUS_ACTIVE.

Referenced by enableAutomaticMembershipSource().

                                                                                             : ilPRGAssignment
     {
         $this->members_cache = null;
 
         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 (is_null($acting_usr_id)) {
             $acting_usr_id = $this->getLoggedInUserId();
         }
 
         $ass = $this->assignment_repository->createFor($this->getId(), $usr_id, $acting_usr_id);
         $ass = $ass
             ->initAssignmentDates();
 
         $ass = $ass->resetProgresses(
             $this->getSettingsRepository(),
             $acting_usr_id
         );
 
         $this->assignment_repository->store($ass);
 
         if ($raise_event) {
             $this->events->userAssigned($ass);
         }
         return $ass;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ canBeCompleted()

ilObjStudyProgramme::canBeCompleted ( ilPRGProgress $progress )

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

References ilPRGProgress\getAmountOfPoints(), getLPMode(), ilPRGProgress\getPossiblePointsOfRelevantChildren(), getStatus(), ilStudyProgrammeSettings\MODE_LP_COMPLETED, and ilStudyProgrammeSettings\STATUS_DRAFT.

                                                            : bool
     {
         if ($this->getStatus() === ilStudyProgrammeSettings::STATUS_DRAFT) {
             return false;
         }
         if ($this->getLPMode() == ilStudyProgrammeSettings::MODE_LP_COMPLETED) {
             return true;
         }
         $possible_points = $progress->getPossiblePointsOfRelevantChildren();
         return $possible_points >= $progress->getAmountOfPoints();
     }

Here is the call graph for this function:

◆ canBeRemoved()

ilObjStudyProgramme::canBeRemoved ( )

Check weather a node can be removed.

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

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

References hasRelevantProgresses().

Referenced by removeNode().

                                   : bool
     {
         return ! $this->hasRelevantProgresses();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ changeAmountOfPoints()

ilObjStudyProgramme::changeAmountOfPoints	(	int	$assignment_id,
		int	$acting_usr_id,
		ilPRGMessageCollection	$err_collection,
		int	$points
	)

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

References ilObject\getId(), getSettingsRepository(), and refreshLPStatus().

      : void {
         $progress_node_id = $this->getId();
         $assignment = $this->assignment_repository->get($assignment_id)
             ->changeAmountOfPoints(
                 $this->getSettingsRepository(),
                 $progress_node_id,
                 $acting_usr_id,
                 $err_collection,
                 $points
             );
 
         $this->assignment_repository->store($assignment);
         $this->refreshLPStatus($assignment->getUserId());
     }

Here is the call graph for this function:

◆ changeProgressDeadline()

ilObjStudyProgramme::changeProgressDeadline	(	int	$assignment_id,
		int	$acting_usr_id,
		ilPRGMessageCollection	$err_collection,
		?DateTimeImmutable	$deadline
	)

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

References ilObject\getId(), getSettingsRepository(), and refreshLPStatus().

      : void {
         $progress_node_id = $this->getId();
         $assignment = $this->assignment_repository->get($assignment_id)
             ->changeProgressDeadline(
                 $this->getSettingsRepository(),
                 $progress_node_id,
                 $acting_usr_id,
                 $err_collection,
                 $deadline
             );
 
         $this->assignment_repository->store($assignment);
         $this->refreshLPStatus($assignment->getUserId());
     }

Here is the call graph for this function:

◆ changeProgressValidityDate()

ilObjStudyProgramme::changeProgressValidityDate	(	int	$assignment_id,
		int	$acting_usr_id,
		ilPRGMessageCollection	$err_collection,
		?DateTimeImmutable	$validity
	)

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

References ilObject\getId(), getSettingsRepository(), and refreshLPStatus().

      : void {
         $progress_node_id = $this->getId();
         $assignment = $this->assignment_repository->get($assignment_id)
             ->changeProgressValidityDate(
                 $this->getSettingsRepository(),
                 $progress_node_id,
                 $acting_usr_id,
                 $err_collection,
                 $validity
             );
 
         $this->assignment_repository->store($assignment);
         $this->refreshLPStatus($assignment->getUserId());
     }

Here is the call graph for this function:

◆ clearChildrenCache()

ilObjStudyProgramme::clearChildrenCache ( )

protected

Clear the cached children.

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

References null.

Referenced by __construct(), adjustLPMode(), 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 138 of file class.ilObjStudyProgramme.php.

References null.

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

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

◆ cloneObject()

ilObjStudyProgramme::cloneObject	(	int	$target_ref_id,
		int	$copy_id = `0`,
		bool	$omit_tree = `false`
	)

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

References getSettings(), and ilStudyProgrammeSettings\STATUS_DRAFT.

                                                                                               : ?ilObject
     {
         $new_obj = parent::cloneObject($target_ref_id, $copy_id, $omit_tree);
         $settings = $this->getSettings()->withObjId($new_obj->getId());
         $settings = $settings->withAssessmentSettings(
             $settings->getAssessmentSettings()->withStatus(ilStudyProgrammeSettings::STATUS_DRAFT)
         );
         $new_obj->updateSettings($settings);
         return $new_obj;
     }

Here is the call graph for this function:

◆ create()

ilObjStudyProgramme::create ( )

Exceptions

ilException

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

References $id, getSettingsRepository(), and ILIAS\Repository\int().

                             : int
     {
         $id = (int) parent::create();
         $this->getSettingsRepository()->createFor($id);
         return $id;
     }

Here is the call graph for this function:

◆ createContentPage()

ilObjStudyProgramme::createContentPage ( )

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

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

                                        : void
     {
         if ($this->hasContentPage()) {
             throw new \LogicException('will not create content page - it already exists.');
         }
         $new_page_object = new \ilContainerPage();
         $new_page_object->setId($this->getId());
         $new_page_object->setParentId($this->getId());
         $new_page_object->createFromXML();
     }

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

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

◆ delete()

ilObjStudyProgramme::delete ( )

Delete Study Programme and all related data.

Exceptions

ilException

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

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

                             : bool
     {
         // always call parent delete function first!!
         if (!parent::delete()) {
             return false;
         }
 
         $this->deleteSettings();
         $this->deleteAssignmentsAndProgresses();
         try {
             $this->auto_categories_repository->deleteFor($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 1242 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 1380 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:

◆ deleteAssignmentsAndProgresses()

ilObjStudyProgramme::deleteAssignmentsAndProgresses ( )

protected

Delete all assignments from the DB.

Exceptions

ilException

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

References ilObject\getId().

Referenced by delete().

                                                        : void
     {
         $this->assignment_repository->deleteAllAssignmentsForProgrammeId($this->getId());
     }

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 1234 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 1372 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

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

References getSettings(), and getSettingsRepository().

Referenced by delete().

                                        : void
     {
         $this->getSettingsRepository()->delete($this->getSettings());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ disableAutomaticMembershipSource()

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

Disable a membership source.

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

References ilObject\getId(), and null.

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

Here is the call graph for this function:

◆ enableAutomaticMembershipSource()

ilObjStudyProgramme::enableAutomaticMembershipSource	(	string	$type,
		int	$src_id,
		bool	$search_recursive,
			$assign_now = `false`
	)

Enable a membership source.

Exceptions

ilException

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

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

                                                                                                                            : void
     {
         if ($assign_now) {
             $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,
             null,
             null,
             $search_recursive
         );
         $this->auto_memberships_repository->update($ams);
     }

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

References ilObject\getId().

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

◆ getAllPrgChildren()

ilObjStudyProgramme::getAllPrgChildren ( )

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

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

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

Here is the call graph for this function:

◆ getAmountOfAssignmentsOf()

ilObjStudyProgramme::getAmountOfAssignmentsOf ( int $user_id )

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

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

References getAssignmentsOf().

Referenced by hasAssignmentOf().

                                                           : int
     {
         return count($this->getAssignmentsOf($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.

Exceptions

ilStudyProgrammeTreeException when this object is not in tree.

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

References getChildren().

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

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

Exceptions

when	this object is not in tree.

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

References getLPChildren().

Referenced by adjustLPMode(), and hasLPChildren().

                                            : int
     {
         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,
		?int	$exclude_id
	)

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

References getAutomaticMembershipSources(), getMembersOfMembershipSource(), and null.

      : ?ilStudyProgrammeAutoMembershipSource {
         foreach ($this->getAutomaticMembershipSources() as $ams) {
             if ($ams->isEnabled()) {
                 $source_members = $this->getMembersOfMembershipSource($ams, $exclude_id);
                 if (in_array($usr_id, $source_members)) {
                     return $ams;
                 }
             }
         }
         return null;
     }

Here is the call graph for this function:

◆ getAssignmentRepository()

ilObjStudyProgramme::getAssignmentRepository ( )

protected

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

References $assignment_repository.

                                                 : PRGAssignmentRepository
     {
         return $this->assignment_repository;
     }

◆ getAssignments()

ilObjStudyProgramme::getAssignments ( )

Returns: ilPRGAssignment[]

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

References ilObject\getId().

Referenced by addMissingProgresses(), getIdsOfUsersWithRelevantProgress(), and getMembers().

                                     : array
     {
         return $this->assignment_repository->getAllForNodeIsContained($this->getId());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAssignmentsOf()

ilObjStudyProgramme::getAssignmentsOf ( int $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 assignment is the first one.

Returns: ilPRGAssignment[]

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

References ilObject\getId().

Referenced by getAmountOfAssignmentsOf().

                                                   : array
     {
         $assignments = $this->assignment_repository->getAllForNodeIsContained(
             $this->getId(),
             [$user_id]
         );
 
         usort($assignments, function ($a_one, $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:

◆ getAssignmentsOfSingleProgramForUser()

ilObjStudyProgramme::getAssignmentsOfSingleProgramForUser ( int $usr_id )

Get assignments of user to this program-node only.

Returns: ilPRGAssignment[]

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

References ilObject\getId().

Referenced by enableAutomaticMembershipSource(), and hasAssignmentsOfSingleProgramForUser().

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

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

References ilObject\getId().

Referenced by hasAutomaticContentCategories().

                                                    : array
     {
         return $this->auto_categories_repository->getFor($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 1347 of file class.ilObjStudyProgramme.php.

References ilObject\getId().

Referenced by getApplicableMembershipSourceForUser().

                                                    : array
     {
         return $this->auto_memberships_repository->getFor($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 489 of file class.ilObjStudyProgramme.php.

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

Referenced by applyToSubTreeNodes(), getAmountOfChildren(), and ilStudyProgrammeProgressListGUI\showMoreObjectsInfo().

                                                                  : 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(static 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(
                         static function ($data) {
                             return (int) $data['child'];
                         },
                         array_filter($ref_child_ref_ids, static 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 $usr_id )

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

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

References ilObject\_exists(), ilLPStatus\_hasUserCompleted(), ilObject\_lookupDeletedDate(), ilContainerReference\_lookupTargetId(), ilContainerReference\_lookupTargetRefId(), ilContainerReference\_lookupTitle(), ilObject\getRefId(), and ILIAS\Repository\int().

                                                     : array
     {
         $node_data = $this->tree->getNodeData($this->getRefId());
         $crsrs = $this->tree->getSubTree($node_data, true, ["crsr"]);
 
         $completed_crss = array();
         foreach ($crsrs as $ref) {
             $crs_id = (int) ilContainerReference::_lookupTargetId((int) $ref["obj_id"]);
             $crs_ref_id = (int) ilContainerReference::_lookupTargetRefId((int) $ref["obj_id"]);
 
             if (ilObject::_exists((int) $ref['ref_id'], true) &&
                 is_null(ilObject::_lookupDeletedDate((int) $ref['ref_id'])) &&
                 ilObject::_exists($crs_id, false) &&
                 is_null(ilObject::_lookupDeletedDate($crs_ref_id)) &&
                 ilLPStatus::_hasUserCompleted($crs_id, $usr_id)
             ) {
                 $containing_prg = self::getInstanceByRefId((int) $ref["parent"]);
                 if ($containing_prg->isActive()) {
                     $completed_crss[] = [
                         "crs_id" => $crs_id
                         , "prg_ref_id" => (int) $ref["parent"]
                         , "prg_obj_id" => $containing_prg->getId()
                         , "crsr_ref_id" => (int) $ref["child"]
                         , "crsr_id" => (int) $ref["obj_id"]
                         , "crs_ref_id" => (int) $crs_ref_id
                         , "crs_id" => (int) $crs_id
 
                         , "title" => ilContainerReference::_lookupTitle((int) $ref["obj_id"])
                     ];
                 }
             }
         }
         return $completed_crss;
     }

Here is the call graph for this function:

◆ getCreatableSubObjects()

static ilObjStudyProgramme::getCreatableSubObjects	(	array	$subobjects,
			$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[] $subobjects

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

References $parent, ilObject\$ref_id, ilObject\_lookupType(), ilStudyProgrammeSettings\MODE_LP_COMPLETED, ilStudyProgrammeSettings\MODE_POINTS, ilStudyProgrammeSettings\MODE_UNDEFINED, and null.

Referenced by ilObjectDefinition\getCreatableSubObjects().

                                                                              : array
     {
         if ($ref_id === null) {
             return $subobjects;
         }
 
         if (ilObject::_lookupType($ref_id, true) !== "prg") {
             throw new ilException("Ref-Id '$ref_id' does not belong to a study programme object.");
         }
 
         $parent = self::getInstanceByRefId($ref_id);
 
         $mode = $parent->getLPMode();
 
         switch ($mode) {
             case ilStudyProgrammeSettings::MODE_UNDEFINED:
                 $possible_subobjects = $subobjects;
                 break;
             case ilStudyProgrammeSettings::MODE_POINTS:
                 $possible_subobjects = [
                     "prg" => $subobjects["prg"],
                     "prgr" => $subobjects["prgr"]
                 ];
                 break;
             case ilStudyProgrammeSettings::MODE_LP_COMPLETED:
                 $possible_subobjects = ['crsr' => $subobjects['crsr']];
                 break;
             default:
                 throw new ilException("Undefined mode for study programme: '$mode'");
         }
 
         if ($parent->hasAutomaticContentCategories()) {
             $possible_subobjects = array_filter(
                 $possible_subobjects,
                 static 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:

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

Exceptions

ilException when this object is not in tree.

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

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

◆ getIdsOfUsersWithRelevantProgress()

ilObjStudyProgramme::getIdsOfUsersWithRelevantProgress ( )

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

References getAssignments().

                                                        : array
     {
         return array_map(
             fn($ass) => $ass->getUserId(),
             $this->getAssignments()
         );
     }

Here is the call graph for this function:

◆ getInstanceByObjId()

static ilObjStudyProgramme::getInstanceByObjId ( int $obj_id )

static

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

References getRefIdFor().

Referenced by ilStudyProgrammeIndividualPlanProgressListGUI\buildProgressStatus(), ilStudyProgrammeProgressListGUI\buildProgressStatus(), ilStudyProgrammeIndividualPlanTableGUI\fetchData(), ilStudyProgrammeProgressListGUI\fillTemplate(), ilStudyProgrammeExpandableProgressListGUI\getAccordionContentCoursesHTML(), ilStudyProgrammeExpandableProgressListGUI\getAccordionContentHTML(), ilPRGMail\getAssignmentAndProgramme(), ilPrgRestartAssignmentsCronJob\getStudyProgramme(), ilPDStudyProgrammeSimpleListGUI\hasPermission(), ilStudyProgrammeDashboardViewGUI\initData(), ilPDStudyProgrammeExpandableListGUI\new_ilStudyProgrammeAssignmentListGUI(), ilStudyProgrammeExpandableProgressListGUI\shouldShowSubProgress(), ilStudyProgrammeUserTable\toRow(), ilObjStudyProgrammeIndividualPlanGUI\updateDeadlines(), ilObjStudyProgrammeIndividualPlanGUI\updateRequiredPoints(), and ilObjStudyProgrammeIndividualPlanGUI\updateStatus().

                                                           : ilObjStudyProgramme
     {
         return self::getInstanceByRefId(self::getRefIdFor($obj_id));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstanceByRefId()

static ilObjStudyProgramme::getInstanceByRefId ( $ref_id )

static

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

References ilObject\$ref_id, and null.

                                                       : ilObjStudyProgramme
     {
         if (self::$study_programme_cache === null) {
             self::initStudyProgrammeCache();
         }
         return self::$study_programme_cache->getInstanceByRefId((int) $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 323 of file class.ilObjStudyProgramme.php.

References getSettings().

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

Here is the call graph for this function:

◆ getLocalMembers()

ilObjStudyProgramme::getLocalMembers ( )

get usr_ids with assignment on this node

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

References $members_cache, and ilObject\getId().

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

Here is the call graph for this function:

◆ getLoggedInUserId()

ilObjStudyProgramme::getLoggedInUserId ( )

protected

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

Referenced by acknowledgeCourses(), and assignUser().

                                           : int
     {
         return $this->ilUser->getId();
     }

Here is the caller graph for this function:

◆ getLogger()

ilObjStudyProgramme::getLogger ( )

protected

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

References $logger.

                                   : ilLogger
     {
         return $this->logger;
     }

◆ getLPChildren()

ilObjStudyProgramme::getLPChildren ( )

Get the leafs the study programme contains.

Returns: ilStudyProgrammeLeaf[]

Exceptions

ilStudyProgrammeTreeException when this object is not in tree.

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

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

Referenced by getAmountOfLPChildren(), and getLPChildrenIds().

                                    : array
     {
         $this->throwIfNotInTree();
 
         if ($this->lp_children === null) {
             $this->lp_children = array();
 
             $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((int) $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 obj-ids of the leafs the program contains.

Returns: int[]

Exceptions

ilStudyProgrammeTreeException

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

References getLPChildren().

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

Here is the call graph for this function:

◆ getLPMode()

ilObjStudyProgramme::getLPMode ( )

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

References getSettings().

Referenced by addNode(), canBeCompleted(), and nodeInserted().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getMembers()

ilObjStudyProgramme::getMembers ( )

get usr_ids with any progress on this node

Returns: int[]

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

References getAssignments().

                                 : array
     {
         $usr_ids = [];
         foreach ($this->getAssignments() as $assignment) {
             $usr_ids[] = $assignment->getUserId();
         }
         return array_unique($usr_ids);
     }

Here is the call graph for this function:

◆ getMembersOfMembershipSource()

ilObjStudyProgramme::getMembersOfMembershipSource	(	ilStudyProgrammeAutoMembershipSource	$ams,
		?int	$exclude_id
	)

protected

Get member-ids of a certain source.

Returns: int[]

Exceptions

InvalidArgumentException if $src_type is not in AutoMembershipSource-types

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

Referenced by enableAutomaticMembershipSource(), and getApplicableMembershipSourceForUser().

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

Here is the caller graph for this function:

◆ getNow()

ilObjStudyProgramme::getNow ( )

protected

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

                                : DateTimeImmutable
     {
         return new DateTimeImmutable();
     }

◆ getParent()

ilObjStudyProgramme::getParent ( )

Get the parent ilObjStudyProgramme of this object.

Returns null if parent is no StudyProgramme.

Exceptions

ilException when this object is not in tree.

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

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

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

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

Here is the call graph for this function:

Here is the caller 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 586 of file class.ilObjStudyProgramme.php.

References $parent, getReferencesTo(), and null.

Referenced by getRoot().

                                                                 : array
     {
         $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;
                     }
                     $queque[] = $r_parent;
                     $parents[] = $r_parent;
                 }
                 continue;
             }
             $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 331 of file class.ilObjStudyProgramme.php.

References getSettings().

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

Here is the call graph for this function:

◆ getPrgInstanceByObjId()

ilObjStudyProgramme::getPrgInstanceByObjId ( int $obj_id )

protected

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

References getRefIdFor().

                                                          : ilObjStudyProgramme
     {
         return self::getInstanceByRefId(self::getRefIdFor($obj_id));
     }

Here is the call graph for this function:

◆ getProgrammesMonitoringCategory()

static ilObjStudyProgramme::getProgrammesMonitoringCategory ( int $cat_ref_id )

staticprotected

Get all (not OUTDATED) StudyProgrammes monitoring this category.

Returns: ilObjStudyProgramme[]

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

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

                                                                               : array
     {
         $db = ilStudyProgrammeDIC::dic()['model.AutoCategories.ilStudyProgrammeAutoCategoriesRepository'];
         $programmes =
             array_filter(
                 array_map(
                     static function (array $rec) {
                         $values = array_values($rec);
                         $prg_obj_id = (int) array_shift($values);
 
                         $references = ilObject::_getAllReferences($prg_obj_id);
                         $prg_ref_id = (int) array_shift($references);
 
                         $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 1444 of file class.ilObjStudyProgramme.php.

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

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

Here is the call graph for this function:

◆ getReferencesTo()

ilObjStudyProgramme::getReferencesTo ( ilObjStudyProgramme $prg )

protected

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

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

Referenced by getParents(), and getReferencesToSelf().

                                                                 : array
     {
         $tree = $this->tree;
         return array_filter(
             array_map(
                 static function ($id) {
                     $refs = ilObject::_getAllReferences((int) $id);
                     return new ilObjStudyProgrammeReference(
                         array_shift($refs)
                     );
                 },
                 ilContainerReference::_lookupSourceIds($prg->getId())
             ),
             static 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 576 of file class.ilObjStudyProgramme.php.

References getReferencesTo().

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

Here is the call graph for this function:

◆ getRefIdFor()

static ilObjStudyProgramme::getRefIdFor ( int $obj_id )

static

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

References ilObject\_getAllReferences().

Referenced by ilStudyProgrammeMailMemberSearchGUI\getRootPrgRefId(), ilStudyProgrammeUserTable\lookupTitle(), ilObjStudyProgrammeMembersGUI\removeAssignment(), and ilPRGMail\sendMail().

                                                    : int
     {
         $refs = ilObject::_getAllReferences($obj_id);
         if (count($refs) < 1) {
             throw new ilException("Could not find ref_id for programme with obj_id $obj_id");
         }
         return (int) array_shift($refs);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getRoot()

ilObjStudyProgramme::getRoot ( )

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

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

References getParents().

                              : ilObjStudyProgramme
     {
         $parents = $this->getParents();
         if (count($parents) < 1) {
             return $this;
         }
         return $parents[0];
     }

Here is the call graph for this function:

◆ getSettings()

ilObjStudyProgramme::getSettings ( )

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

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

Referenced by adjustLPMode(), ilObjStudyProgrammeSettingsGUI\buildForm(), cloneObject(), deleteSettings(), ilStudyProgrammeChangeDeadlineGUI\getDeadlineSubForm(), getLastChange(), getLPMode(), getPoints(), getStatus(), getSubType(), ilStudyProgrammeChangeExpireDateGUI\getValidityOfQualificationSubForm(), hasAdvancedMetadata(), isAutoContentApplicable(), nodeInserted(), setPoints(), setStatus(), update(), and updateLastChange().

                                  : ilStudyProgrammeSettings
     {
         return $this->getSettingsRepository()->get($this->getId());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSettingsRepository()

ilObjStudyProgramme::getSettingsRepository ( )

protected

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

References $settings_repository.

Referenced by assignUser(), changeAmountOfPoints(), changeProgressDeadline(), changeProgressValidityDate(), create(), deleteSettings(), getSettings(), markAccredited(), markNotRelevant(), markRelevant(), succeed(), unmarkAccredited(), updatePlanFromRepository(), and updateSettings().

                                               : ilStudyProgrammeSettingsRepository
     {
         return $this->settings_repository;
     }

Here is the caller graph for this function:

◆ getSpecificAssignment()

ilObjStudyProgramme::getSpecificAssignment ( int $assignment_id )

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

                                                              : ilPRGAssignment
     {
         return $this->assignment_repository->get($assignment_id);
     }

◆ getStatus()

ilObjStudyProgramme::getStatus ( )

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

References getSettings().

Referenced by assignUser(), canBeCompleted(), ilStudyProgrammeIndividualPlanProgressListGUI\getTitleForItem(), isActive(), and isAutoContentApplicable().

                                : int
     {
         return $this->getSettings()->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.

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

References getSettings(), and null.

Referenced by updateCustomIcon().

                                 : ?ilStudyProgrammeType
     {
         $type_settings = $this->getSettings()->getTypeSettings();
         if (!in_array($type_settings->getTypeId(), array("-", "0"))) {
             $subtype_id = $type_settings->getTypeId();
             return $this->type_repository->getType($subtype_id);
         }
 
         return null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getTree()

ilObjStudyProgramme::getTree ( )

protected

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

References ilObject\$tree.

                                 : ilTree
     {
         return $this->tree;
     }

◆ hasAdvancedMetadata()

ilObjStudyProgramme::hasAdvancedMetadata ( )

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

References ilObject\$type, getSettings(), and null.

                                          : bool
     {
         $sub_type_id = $this->getSettings()->getTypeSettings()->getTypeId();
         $type = null;
         if ($sub_type_id) {
             $type = $this->type_repository->getType($sub_type_id);
         }
 
         return !is_null($type) && count($this->type_repository->getAssignedAMDRecordIdsByType($type->getId(), true)) > 0;
     }

Here is the call graph for this function:

◆ hasAssignmentOf()

ilObjStudyProgramme::hasAssignmentOf ( int $user_id )

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

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

References getAmountOfAssignmentsOf().

                                                  : bool
     {
         return $this->getAmountOfAssignmentsOf($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 1124 of file class.ilObjStudyProgramme.php.

References ilObject\getId(), ILIAS\Repository\lng(), and null.

                                     : bool
     {
         $filter = new ilPRGAssignmentFilter($this->lng);
         $count = $this->assignment_repository->countAllForNodeIsContained(
             $this->getId(),
             null,
             $filter
         );
         return $count > 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 1149 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 1211 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 618 of file class.ilObjStudyProgramme.php.

References getAmountOfChildren().

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

Here is the call graph for this function:

◆ hasContentPage()

ilObjStudyProgramme::hasContentPage ( )

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

References ilObject\getId().

Referenced by createContentPage().

                                     : bool
     {
         return \ilContainerPage::_exists(self::CP_TYPE, $this->getId());
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasLPChildren()

ilObjStudyProgramme::hasLPChildren ( )

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

References getAmountOfLPChildren().

Referenced by isAutoContentApplicable().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasRelevantProgresses()

ilObjStudyProgramme::hasRelevantProgresses ( )

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

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

References ilObject\getId(), ILIAS\Repository\lng(), and null.

Referenced by canBeRemoved().

                                            : bool
     {
         $filter = new ilPRGAssignmentFilter($this->lng);
         $filter = $filter->withValues([
             'prg_status_hide_irrelevant' => true
         ]);
         $count = $this->assignment_repository->countAllForNodeIsContained(
             $this->getId(),
             null,
             $filter
         );
         return $count > 0;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ initStudyProgrammeCache()

static ilObjStudyProgramme::initStudyProgrammeCache ( )

static

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

References null, and 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 409 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 1319 of file class.ilObjStudyProgramme.php.

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

                                              : bool
     {
         $valid_status = in_array(
             $this->getSettings()->getAssessmentSettings()->getStatus(),
             [
                 ilStudyProgrammeSettings::STATUS_DRAFT,
                 ilStudyProgrammeSettings::STATUS_ACTIVE
             ],
             true
         );
 
         $crslnk_allowed = (
             $this->hasLPChildren()
             || $this->getAmountOfChildren(true) === 0
         );
 
         return $valid_status && $crslnk_allowed;
     }

Here is the call graph for this function:

◆ isCertificateActive()

ilObjStudyProgramme::isCertificateActive ( )

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

References $certificate_template_repository, ilCertificateTemplateRepository\fetchCurrentlyUsedCertificate(), and ilObject\getId().

                                          : bool
     {
         $global_settings = new ilSetting('certificate');
         $global_active = (bool) $global_settings->get('active', '0');
         if (!$global_active) {
             return false;
         }
         $certificate_template_repository = new ilCertificateTemplateDatabaseRepository($this->db);
         $certificate_template = $certificate_template_repository->fetchCurrentlyUsedCertificate($this->getId());
         return $certificate_template->isCurrentlyActive();
     }

Here is the call graph for this function:

◆ markAccredited()

ilObjStudyProgramme::markAccredited	(	int	$assignment_id,
		int	$acting_usr_id,
		ilPRGMessageCollection	$err_collection
	)

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

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

      : void {
         $progress_node_id = $this->getId();
         $assignment = $this->assignment_repository->get($assignment_id)
             ->markAccredited(
                 $this->getSettingsRepository(),
                 $this->events,
                 $progress_node_id,
                 $acting_usr_id,
                 $err_collection
             );
 
         $this->assignment_repository->store($assignment);
     }

Here is the call graph for this function:

◆ markNotRelevant()

ilObjStudyProgramme::markNotRelevant	(	int	$assignment_id,
		int	$acting_usr_id,
		ilPRGMessageCollection	$err_collection
	)

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

References ilObject\getId(), getSettingsRepository(), and refreshLPStatus().

      : void {
         $progress_node_id = $this->getId();
         $assignment = $this->assignment_repository->get($assignment_id)
             ->markNotRelevant(
                 $this->getSettingsRepository(),
                 $progress_node_id,
                 $acting_usr_id,
                 $err_collection
             );
 
         $this->assignment_repository->store($assignment);
         $this->refreshLPStatus($assignment->getUserId());
     }

Here is the call graph for this function:

◆ markRelevant()

ilObjStudyProgramme::markRelevant	(	int	$assignment_id,
		int	$acting_usr_id,
		ilPRGMessageCollection	$err_collection
	)

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

References ilObject\getId(), getSettingsRepository(), and refreshLPStatus().

      : void {
         $progress_node_id = $this->getId();
         $assignment = $this->assignment_repository->get($assignment_id)
             ->markRelevant(
                 $this->getSettingsRepository(),
                 $progress_node_id,
                 $acting_usr_id,
                 $err_collection
             );
 
         $this->assignment_repository->store($assignment);
         $this->refreshLPStatus($assignment->getUserId());
     }

Here is the call graph for this function:

◆ moveTo()

ilObjStudyProgramme::moveTo ( ilObjStudyProgramme $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 917 of file class.ilObjStudyProgramme.php.

References $DIC, $parent, 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(), $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();
 
             $new_parent->clearChildrenCache();
             $new_parent->clearLPChildrenCache();
         }
 
         return $this;
     }

Here is the call graph for this function:

◆ nodeInserted()

ilObjStudyProgramme::nodeInserted ( $prg )

Clears child cache and adds progress for new node.

called by ilObjStudyProgrammeReference::putInTree, e.g.

Parameters

ilObjStudyProgrammeReference | ilObjStudyProgramme $prg

Exceptions

ilStudyProgrammeTreeException
ilException

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

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

                                       : void
     {
         if (! $prg instanceof ilObjStudyProgrammeReference &&
            ! $prg instanceof ilObjStudyProgramme
         ) {
             throw new ilStudyProgrammeTreeException("Wrong type of node: " . get_class($prg));
         }
         if ($this->getLPMode() === ilStudyProgrammeSettings::MODE_LP_COMPLETED) {
             throw new ilStudyProgrammeTreeException("Program already contains leafs.");
         }
 
         if ($this->getSettings()->getLPMode() !== ilStudyProgrammeSettings::MODE_POINTS) {
             $this->settings_repository->update(
                 $this->getSettings()->setLPMode(ilStudyProgrammeSettings::MODE_POINTS)
             );
         }
 
         $this->clearChildrenCache();
         $this->addMissingProgresses();
     }

Here is the call graph for this function:

◆ putInTree()

ilObjStudyProgramme::putInTree ( int $parent_ref_id )

Overwritten from ilObject.

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

Parameters

int $parent_ref_id

Exceptions

ilStudyProgrammeTreeException
ilException

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

References ilObject\_lookupType().

Referenced by addNode().

                                                  : void
     {
         parent::putInTree($parent_ref_id);
 
         if (ilObject::_lookupType($parent_ref_id, true) === "prg") {
             $par = self::getInstanceByRefId($parent_ref_id);
             $par->nodeInserted($this);
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ refreshLPStatus()

ilObjStudyProgramme::refreshLPStatus	(	int	$usr_id,
		?int	$node_obj_id = `null`
	)

protected

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

References ilLPStatusWrapper\_updateStatus(), and ilObject\getId().

Referenced by acknowledgeCourses(), changeAmountOfPoints(), changeProgressDeadline(), changeProgressValidityDate(), markNotRelevant(), markRelevant(), removeAssignment(), unmarkAccredited(), and updatePlanFromRepository().

                                                                              : void
     {
         if (is_null($node_obj_id)) {
             $node_obj_id = $this->getId();
         }
         ilLPStatusWrapper::_updateStatus($node_obj_id, $usr_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeAssignment()

ilObjStudyProgramme::removeAssignment ( ilPRGAssignment $assignment )

Remove an assignment from this program.

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

Exceptions

ilException

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

References ilPRGAssignment\getId(), ilObject\getId(), ilPRGAssignment\getProgresses(), ilPRGAssignment\getRootId(), ilPRGAssignment\getUserId(), null, and refreshLPStatus().

                                                                  : ilObjStudyProgramme
     {
         $this->members_cache = null;
         if ($assignment->getRootId() !== $this->getId()) {
             throw new ilException(
                 "ilObjStudyProgramme::removeAssignment: Assignment '"
                 . $assignment->getId() . "' does not belong to study "
                 . "program '" . $this->getId() . "'."
             );
         }
 
         $this->assignment_repository->delete($assignment);
 
         $affected_node_ids = array_map(fn($pgs) => $pgs->getNodeId(), $assignment->getProgresses());
         foreach ($affected_node_ids as $node_obj_id) {
             $this->refreshLPStatus($assignment->getUserId(), $node_obj_id);
         }
 
         $this->events->userDeassigned($assignment);
         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 surveillance and automatically remove the deleted course.

Exceptions

ilStudyProgrammeTreeException

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

Referenced by ilStudyProgrammeAppEventListener\removeCrsFromProgrammes().

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

◆ removeMemberFromProgrammes()

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

static

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

References ilPRGAssignmentDBRepository\delete(), ilStudyProgrammeDIC\dic(), null, ilStudyProgrammeAutoMembershipSource\SOURCE_MAPPING, and ilPRGAssignmentDBRepository\store().

Referenced by ilStudyProgrammeAppEventListener\removeMemberFromProgrammes().

                                                                                                  : void
     {
         $now = new DateTimeImmutable();
         $assignment_repository = ilStudyProgrammeDIC::dic()['repo.assignment'];
         foreach (self::getProgrammesMonitoringMemberSource($src_type, $src_id) as $prg) {
             $assignments = $prg->getAssignmentsOfSingleProgramForUser($usr_id);
             $next_membership_source = $prg->getApplicableMembershipSourceForUser($usr_id, $src_id);
 
             foreach ($assignments as $assignment) {
                 if (!$assignment->getProgressTree()->isInProgress()) {
                     continue;
                 }
 
                 if (
                     $next_membership_source !== null
                     && $next_membership_source?->isEnabled()
                     && $next_membership_source->getSourceId() !== $src_id
                 ) {
                     $new_src_type = $next_membership_source->getSourceType();
                     $assigned_by = ilStudyProgrammeAutoMembershipSource::SOURCE_MAPPING[$new_src_type];
                     $assignment = $assignment->withLastChange($assigned_by, $now);
                     $assignment_repository->store($assignment);
                     break;
                 } else {
                     $assignment_repository->delete($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 880 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:

◆ resetExpiryInfoSentFor()

ilObjStudyProgramme::resetExpiryInfoSentFor ( ilPRGAssignment $ass )

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

                                                                 : void
     {
         $this->assignment_repository->resetExpiryInfoSentFor($ass);
     }

◆ resetRiskyToFailSentFor()

ilObjStudyProgramme::resetRiskyToFailSentFor ( ilPRGAssignment $ass )

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

                                                                  : void
     {
         $this->assignment_repository->resetRiskyToFailSentFor($ass);
     }

◆ setPoints()

ilObjStudyProgramme::setPoints ( int $points )

Set the amount of points.

Exceptions

ilException

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

References getSettings(), updateLastChange(), and updateSettings().

                                           : ilObjStudyProgramme
     {
         $settings = $this->getSettings();
         $this->updateSettings(
             $settings->withAssessmentSettings($settings->getAssessmentSettings()->withPoints($points))
         );
         $this->updateLastChange();
         return $this;
     }

Here is the call graph for this function:

◆ setProgressesCompletedFor()

static ilObjStudyProgramme::setProgressesCompletedFor	(	int	$obj_id,
		int	$user_id
	)

static

Succeed all StudyProgramme(Nodes) where the object with the given id (a CRSR) is in a Programme with MODE_LP_COMPLETED.

This is exclusively called via event "Services/Tracking, updateStatus" (onServiceTrackingUpdateStatus)

Parameters

int	$ref_id	the RefId of the CRSR; used to find the PRG it's in
int	$obj_id	the ObjId of the CRS; used as "triggering object"
int	$user_id	the user's id to succeed for; all assignments are affected

This is exclusively called via event "components/ILIAS/Tracking, updateStatus" (onServiceTrackingUpdateStatus)

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

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

                                                                                : void
     {
         // We only use courses via crs_refs
         $type = ilObject::_lookupType($obj_id);
         if ($type === "crsr") {
             foreach (ilObject::_getAllReferences($obj_id) as $ref_id) {
                 self::setProgressesCompletedIfParentIsProgrammeInLPCompletedMode($ref_id, $obj_id, $user_id);
             }
         }
     }

Here is the call graph for this function:

◆ setProgressesCompletedIfParentIsProgrammeInLPCompletedMode()

static ilObjStudyProgramme::setProgressesCompletedIfParentIsProgrammeInLPCompletedMode	(	int	$ref_id,
		int	$obj_id,
		int	$user_id
	)

static

Exceptions

ilException

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

References $DIC, ilObject\$tree, ilTree\getParentNodeData(), and ilStudyProgrammeSettings\MODE_LP_COMPLETED.

Referenced by ilStudyProgrammeAppEventListener\onServiceTrackingUpdateStatus().

      : void {
         global $DIC; // TODO: replace this by a settable static for testing purpose?
         $tree = $DIC['tree'];
         $node_data = $tree->getParentNodeData($ref_id);
         if (count($node_data) === 0 || !array_key_exists('type', $node_data) || $node_data["type"] !== "prg") {
             return;
         }
         self::initStudyProgrammeCache();
         $prg = self::getInstanceByRefId($node_data["child"]);
         if ($prg->getLPMode() !== ilStudyProgrammeSettings::MODE_LP_COMPLETED) {
             return;
         }
         $prg->succeed($user_id, $obj_id);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setStatus()

ilObjStudyProgramme::setStatus ( int $a_status )

Set the status of the node.

Exceptions

ilException

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

References getSettings(), updateLastChange(), and updateSettings().

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

Here is the call graph for this function:

◆ statusToRepr()

ilObjStudyProgramme::statusToRepr ( int $status )

Get a user readable representation of a status.

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

References ilObject\$lng, ilLanguage\loadLanguageModule(), ilPRGProgress\STATUS_ACCREDITED, ilPRGProgress\STATUS_COMPLETED, ilPRGProgress\STATUS_FAILED, ilPRGProgress\STATUS_IN_PROGRESS, ilPRGProgress\STATUS_NOT_RELEVANT, and ilLanguage\txt().

                                              : string
     {
         $lng = $this->lng;
         $lng->loadLanguageModule("prg");
         if ($status === ilPRGProgress::STATUS_IN_PROGRESS) {
             return $lng->txt("prg_status_in_progress");
         }
         if ($status === ilPRGProgress::STATUS_COMPLETED) {
             return $lng->txt("prg_status_completed");
         }
         if ($status === ilPRGProgress::STATUS_ACCREDITED) {
             return $lng->txt("prg_status_accredited");
         }
         if ($status === ilPRGProgress::STATUS_NOT_RELEVANT) {
             return $lng->txt("prg_status_not_relevant");
         }
         if ($status === ilPRGProgress::STATUS_FAILED) {
             return $lng->txt("prg_status_failed");
         }
         throw new ilException("Unknown status: '$status'");
     }

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 1221 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,
		bool	$search_recursive
	)

Store a source to be monitored for automatic memberships.

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

References ilObject\getId(), and null.

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

Here is the call graph for this function:

◆ storeExpiryInfoSentFor()

ilObjStudyProgramme::storeExpiryInfoSentFor ( ilPRGAssignment $ass )

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

                                                                 : void
     {
         $this->assignment_repository->storeExpiryInfoSentFor($ass);
     }

◆ storeRiskyToFailSentFor()

ilObjStudyProgramme::storeRiskyToFailSentFor ( ilPRGAssignment $ass )

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

                                                                  : void
     {
         $this->assignment_repository->storeRiskyToFailSentFor($ass);
     }

◆ succeed()

ilObjStudyProgramme::succeed	(	int	$usr_id,
		int	$triggering_obj_id,
		?ilPRGAssignment	$ass = `null`
	)

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

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

                                                                                               : void
     {
         $progress_node_id = $this->getId();
         if (is_null($ass)) {
             $user_assignments = $this->assignment_repository
                 ->getAllForNodeIsContained($progress_node_id, [$usr_id]);
         } else {
             $user_assignments = [$ass];
         }
 
         foreach ($user_assignments as $ass) {
             $ass = $ass->succeed(
                 $this->getSettingsRepository(),
                 $progress_node_id,
                 $triggering_obj_id
             );
             $this->assignment_repository->store($ass);
         }
     }

Here is the call graph for this function:

◆ throwIfNotInTree()

ilObjStudyProgramme::throwIfNotInTree ( )

protected

Exceptions

ilStudyProgrammeTreeException if object is not in tree.

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

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

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

Here is the caller graph for this function:

◆ unmarkAccredited()

ilObjStudyProgramme::unmarkAccredited	(	int	$assignment_id,
		int	$acting_usr_id,
		ilPRGMessageCollection	$err_collection
	)

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

References ilObject\getId(), getSettingsRepository(), and refreshLPStatus().

      : void {
         $progress_node_id = $this->getId();
         $assignment = $this->assignment_repository->get($assignment_id)
             ->unmarkAccredited(
                 $this->getSettingsRepository(),
                 $progress_node_id,
                 $acting_usr_id,
                 $err_collection
             );
 
         $this->assignment_repository->store($assignment);
         $this->refreshLPStatus($assignment->getUserId());
     }

Here is the call graph for this function:

◆ update()

ilObjStudyProgramme::update ( )

Exceptions

ilException

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

References ilObject\getId(), getSettings(), and ilAdvancedMDRecord\saveObjRecSelection().

Referenced by updateLastChange().

                             : bool
     {
         parent::update();
 
         $type_settings = $this->getSettings()->getTypeSettings();
         // Update selection for advanced metadata of the type
         if ($type_settings->getTypeId()) {
             ilAdvancedMDRecord::saveObjRecSelection(
                 $this->getId(),
                 'prg_type',
                 $this->type_repository->getAssignedAMDRecordIdsByType($type_settings->getTypeId())
             );
         } else {
             // If no type is assigned, delete relations by passing an empty array
             ilAdvancedMDRecord::saveObjRecSelection($this->getId(), 'prg_type', array());
         }
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateCustomIcon()

ilObjStudyProgramme::updateCustomIcon ( )

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

References ilFileUtils\getDataDir(), ilObject\getId(), getSubType(), and ilObject\getType().

Referenced by ilObjStudyProgrammeSettingsGUI\buildForm().

                                       : void
     {
         $customIcon = $this->custom_icon_factory->getByObjId($this->getId(), $this->getType());
         $subtype = $this->getSubType();
 
         if ($subtype && $subtype->getIconIdentifier()) {
             $src = $this->type_repository->getIconPathFS($subtype);
 
             //This is a horrible hack to allow Flysystem/LocalFilesystem to read the file.
             $tmp = 'ico_' . $this->getId();
             copy($src, \ilFileUtils::getDataDir() . '/temp/' . $tmp);
 
             $customIcon->saveFromTempFileName($tmp);
         } else {
             $customIcon->remove();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateLastChange()

ilObjStudyProgramme::updateLastChange ( )

protected

Update last change timestamp on this node and its parents.

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

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

Referenced by setPoints(), and setStatus().

                                          : void
     {
         $this->getSettings()->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:

◆ updatePlanFromRepository()

ilObjStudyProgramme::updatePlanFromRepository	(	int	$assignment_id,
		int	$acting_usr_id,
		?ilPRGMessageCollection	$err_collection = `null`
	)

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

References getSettingsRepository(), and refreshLPStatus().

      : void {
         $assignment = $this->assignment_repository->get($assignment_id)
             ->updatePlanFromRepository(
                 $this->getSettingsRepository(),
                 $acting_usr_id,
                 $err_collection
             );
 
         $this->assignment_repository->store($assignment);
         $this->refreshLPStatus($assignment->getUserId());
     }

Here is the call graph for this function:

◆ updateSettings()

ilObjStudyProgramme::updateSettings ( ilStudyProgrammeSettings $settings )

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

References ilObject\getId(), ilStudyProgrammeSettings\getObjId(), and getSettingsRepository().

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

                                                                       : bool
     {
         if ($settings->getObjId() !== $this->getId()) {
             throw new Exception("The given settings-object does not belong to this programme", 1);
         }
         $this->getSettingsRepository()->update($settings);
 
         return true;
     }