ILIAS: ilObjStudyProgramme Class Reference

References $format, ilStudyProgrammeProgress\DATE_FORMAT, ilStudyProgrammeProgress\getDeadline(), ilStudyProgrammeProgress\getStatus(), ilStudyProgrammeProgress\markFailed(), ilStudyProgrammeProgress\markNotFailed(), ilStudyProgrammeProgress\STATUS_FAILED, and ilStudyProgrammeProgress\STATUS_IN_PROGRESS.

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

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

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

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

                                   : 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->getAmountOfLPChildren() > 0) {
            $this->settings_repository->update(
                $this->getSettings()->setLPMode(ilStudyProgrammeSettings::MODE_LP_COMPLETED)
            );
        } else {
            if ($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)
                );
            }
        }
    }

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

Here is the call graph for this function:

◆ applyProgressDeadline()

ilObjStudyProgramme::applyProgressDeadline	(	ilStudyProgrammeProgress	$progress,
		int	$acting_usr_id = `null`
	)

protected

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

                                                                                                            : ilStudyProgrammeProgress
    {
        $today = $this->getNow();
        $format = ilStudyProgrammeProgress::DATE_FORMAT;
        $deadline = $progress->getDeadline();
 
        if (is_null($acting_usr_id)) {
            $acting_usr_id = $this->getLoggedInUserId();
        }
        
        switch ($progress->getStatus()) {
 
            case ilStudyProgrammeProgress::STATUS_IN_PROGRESS:
                if (!is_null($deadline)
                    && $deadline->format($format) < $today->format($format)
                ) {
                    $progress = $progress->markFailed($this->getNow(), $acting_usr_id);
                }
                break;
 
            case ilStudyProgrammeProgress::STATUS_FAILED:
                if (is_null($deadline)
                    || $deadline->format($format) >= $today->format($format)
                ) {
                    $progress = $progress->markNotFailed($this->getNow(), $acting_usr_id);
                }
                break;
        }
 
        return $progress;
    }

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

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

References getChildren(), and throwIfNotInTree().

Referenced by assignUser(), and getAllPrgChildren().

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

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

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

                                                                       : ilStudyProgrammeAssignment
    {
        $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);
 
        $this->applyToSubTreeNodes(
            function (ilObjStudyProgramme $node) use ($ass, $acting_usr_id) {
                $progress = $node->createProgressForAssignment($ass, $acting_usr_id);
                $progress = $node->resetProgressToSettings($progress, $acting_usr_id);
                $this->getProgressRepository()->update($progress);
            },
            true
        );
 
        $this->events->userAssigned($ass);
        return $ass;
    }

References applyToSubTreeNodes(), createProgressForAssignment(), ilObject\getId(), getLoggedInUserId(), getProgressRepository(), getStatus(), resetProgressToSettings(), ilStudyProgrammeSettings\STATUS_ACTIVE, and true.

Referenced by enableAutomaticMembershipSource().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ canBeCompleted()

ilObjStudyProgramme::canBeCompleted ( ilStudyProgrammeProgress $progress )

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

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

References ilStudyProgrammeProgress\getAmountOfPoints(), and ilStudyProgrammeSettings\MODE_LP_COMPLETED.

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

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

References getProgresses(), and ilStudyProgrammeProgress\STATUS_NOT_RELEVANT.

Referenced by removeNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ changeAmountOfPoints()

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

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

      : void {
        $progress = $this->getProgressRepository()->get($progress_id);
        
        if (!$progress->isRelevant()) {
            $err_collection->add(false, 'will_not_modify_irrelevant_progress', $this->getProgressIdString($progress));
            return;
        }
        if ($progress->isSuccessful()) {
            $err_collection->add(false, 'will_not_modify_successful_progress', $this->getProgressIdString($progress));
            return;
        }
        
        $progress = $progress
            ->withAmountOfPoints($points)
            ->withLastChange($acting_usr_id, $this->getNow())
            ->withIndividualModifications(true);
 
        $progress = $this->recalculateProgressStatus($progress);
 
        $this->getProgressRepository()->update($progress);
        $err_collection->add(true, 'required_points_updated', $this->getProgressIdString($progress));
        $this->refreshLPStatus($progress->getUserId());
        $this->updateParentProgress($progress);
    }

Here is the call graph for this function:

◆ changeProgressDeadline()

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

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

      : void {
        $progress = $this->getProgressRepository()->get($progress_id);
 
        if (!$progress->isRelevant()) {
            $err_collection->add(false, 'will_not_modify_irrelevant_progress', $this->getProgressIdString($progress));
            return;
        }
        if ($progress->isSuccessful()) {
            $err_collection->add(false, 'will_not_modify_deadline_on_successful_progress', $this->getProgressIdString($progress));
            return;
        }
 
        $progress = $progress
            ->withDeadline($deadline)
            ->withLastChange($acting_usr_id, $this->getNow())
            ->withIndividualModifications(true);
 
        $progress = $this->applyProgressDeadline($progress, $acting_usr_id);
 
        $this->getProgressRepository()->update($progress);
        $this->refreshLPStatus($progress->getUserId());
        $this->updateParentProgress($progress);
        $err_collection->add(true, 'deadline_updated', $this->getProgressIdString($progress));
    }

Here is the call graph for this function:

◆ changeProgressValidityDate()

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

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

      : void {
        $progress = $this->getProgressRepository()->get($progress_id);
 
        if (!$progress->isRelevant()) {
            $err_collection->add(false, 'will_not_modify_irrelevant_progress', $this->getProgressIdString($progress));
            return;
        }
        if (!$progress->isSuccessful()) {
            $err_collection->add(false, 'will_not_modify_validity_on_non_successful_progress', $this->getProgressIdString($progress));
            return;
        }
 
        $progress = $progress
            ->withValidityOfQualification($validity)
            ->withLastChange($acting_usr_id, $this->getNow())
            ->withIndividualModifications(true);
 
        $this->getProgressRepository()->update($progress);
        $err_collection->add(true, 'validity_updated', $this->getProgressIdString($progress));
 
        //update LearningProgress, but this does not affect upper progresses
        $this->refreshLPStatus($progress->getUserId());
    }

Here is the call graph for this function:

◆ clearChildrenCache()

ilObjStudyProgramme::clearChildrenCache ( )

protected

Clear the cached children.

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

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

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

Here is the caller graph for this function:

◆ clearLPChildrenCache()

ilObjStudyProgramme::clearLPChildrenCache ( )

protected

Clear the cached lp children.

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

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

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

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

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

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

Here is the caller graph for this function:

◆ create()

ilObjStudyProgramme::create ( )

Exceptions

Reimplemented from ilContainer.

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

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

References ilObject\$id, and getSettingsRepository().

Here is the call graph for this function:

◆ createInstance()

static ilObjStudyProgramme::createInstance ( )

static

Create an instance of ilObjStudyProgramme, put in cache.

Exceptions

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

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

Here is the caller graph for this function:

◆ createProgressForAssignment()

ilObjStudyProgramme::createProgressForAssignment	(	ilStudyProgrammeAssignment	$ass,
		int	$acting_user = `null`
	)

Create a progress on this programme for the given assignment.

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

                                                                                                          : ilStudyProgrammeProgress
    {
        return $this->progress_repository->createFor($this->getSettings(), $ass, $acting_user);
    }

References getSettings().

Referenced by assignUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilObjStudyProgramme::delete ( )

Delete Study Programme and all related data.

Exceptions

Reimplemented from ilContainer.

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

                             : bool
    {
        // always call parent delete function first!!
        if (!parent::delete()) {
            return false;
        }
 
        $this->deleteSettings();
        $this->deleteAssignmentsAndProgresses();
        try {
            $this->auto_categories_repository->deleteFor((int) $this->getId());
        } catch (ilStudyProgrammeTreeException $e) {
            // This would be the case when SP is in trash (#17797)
        }
 
        $this->deleteAllAutomaticContentCategories();
        $this->deleteAllAutomaticMembershipSources();
 
        $this->events->raise('delete', ['object' => $this, 'obj_id' => $this->getId()]);
        return true;
    }

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

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

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

References ilObject\getId().

Referenced by delete().

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

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

References ilObject\getId().

Referenced by delete().

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

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

                                                        : void
    {
        $assignment_repository = $this->getAssignmentRepository();
        $assignment_repository->deleteAllAssignmentsForProgrammeId($this->getId());
        $orphan_condition_field = $assignment_repository->getTableAndFieldOfAssignmentIds();
        $progress_repository = $this->getProgressRepository();
        $progress_repository->deleteProgressesFor($this->getId());
        $progress_repository->deleteAllOrphanedProgresses(...$orphan_condition_field);
    }

References $assignment_repository, $progress_repository, getAssignmentRepository(), ilObject\getId(), and getProgressRepository().

Referenced by delete().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ deleteAutomaticContentCategories()

ilObjStudyProgramme::deleteAutomaticContentCategories ( array $category_ids = [] )

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

Parameters

int[] $category_ids

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

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

References ilObject\getId().

Here is the call graph for this function:

◆ deleteAutomaticMembershipSource()

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

Delete a membership source.

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

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

References ilObject\getId().

Here is the call graph for this function:

◆ deleteSettings()

ilObjStudyProgramme::deleteSettings ( )

protected

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

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

References getSettings(), and getSettingsRepository().

Referenced by delete().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ disableAutomaticMembershipSource()

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

Disable a membership source.

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

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

References ilObject\getId().

Here is the call graph for this function:

◆ enableAutomaticMembershipSource()

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

Enable a membership source.

Exceptions

Referenced by ilStudyProgrammeProgressListGUI\buildProgressBar(), ilStudyProgrammeIndividualPlanProgressListGUI\buildProgressStatus(), ilStudyProgrammeProgressListGUI\buildProgressStatus(), ilStudyProgrammeIndividualPlanTableGUI\fetchData(), ilStudyProgrammeProgressListGUI\fillTemplate(), ilStudyProgrammeDashboardViewGUI\findValid(), ilStudyProgrammeExpandableProgressListGUI\getAccordionContentCoursesHTML(), ilStudyProgrammeExpandableProgressListGUI\getAccordionContentHTML(), ilStudyProgrammeExpandableProgressListGUI\getAccordionContentProgressesHTML(), ilStudyProgrammeDashboardViewGUI\getHTML(), ilPDStudyProgrammeSimpleListGUI\hasPermission(), ilPDStudyProgrammeExpandableListGUI\new_ilStudyProgrammeAssignmentListGUI(), ilPDStudyProgrammeSimpleListGUI\new_ilStudyProgrammeAssignmentListGUI(), ilStudyProgrammeAppEventListener\onServiceUserDeleteUser(), ilPrgRestartAssignmentsCronJob\run(), ilPrgUpdateProgressCronJob\run(), sendInformToReAssignMail(), sendRiskyToFailMail(), ilStudyProgrammeExpandableProgressListGUI\shouldShowSubProgress(), and ilObjStudyProgrammeIndividualPlanGUI\view().

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

                                                                                                    : 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);
        $this->auto_memberships_repository->update($ams);
    }

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

Here is the call graph for this function:

◆ getAchievedPointsOfChildren()

ilObjStudyProgramme::getAchievedPointsOfChildren ( ilStudyProgrammeProgress $progress )

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

                                                                                    : int
    {
        $sum = 0;
        $children = $this->getChildrenProgress($progress);
        foreach ($children as $child_progress) {
            if (!is_null($child_progress) && $child_progress->isSuccessful()) {
                $sum += $child_progress->getAmountOfPoints();
            }
        }
        return $sum;
    }

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAllPrgChildren()

ilObjStudyProgramme::getAllPrgChildren ( )

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

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

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

Referenced by ilStudyProgrammeDashboardViewGUI\calculatePercent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAmountOfAssignmentsOf()

ilObjStudyProgramme::getAmountOfAssignmentsOf ( int $a_user_id )

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

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

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

References getAssignmentsOf().

Referenced by hasAssignmentOf().

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

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

References getChildren().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAmountOfLPChildren()

ilObjStudyProgramme::getAmountOfLPChildren ( )

Get the amount of leafs, the study programme contains.

Throws when this object is not in tree.

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

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

References getLPChildren().

Referenced by adjustLPMode(), and hasLPChildren().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getApplicableMembershipSourceForUser()

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

Returns: ilStudyProgrammeAutoMembershipSource | null

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

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

References getAutomaticMembershipSources(), and getMembersOfMembershipSource().

Here is the call graph for this function:

◆ getAssignmentForProgress()

ilObjStudyProgramme::getAssignmentForProgress ( ilStudyProgrammeProgress $progress )

protected

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

                                                                                    : ilStudyProgrammeAssignment
    {
        return $this->assignment_repository->get($progress->getAssignmentId());
    }

References ilStudyProgrammeProgress\getAssignmentId().

Here is the call graph for this function:

◆ getAssignmentRepository()

ilObjStudyProgramme::getAssignmentRepository ( )

protected

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

                                                 : ilStudyProgrammeAssignmentRepository
    {
        return $this->assignment_repository;
    }

References $assignment_repository.

Referenced by addMissingProgresses(), deleteAssignmentsAndProgresses(), and updateAllAssignments().

Here is the caller graph for this function:

◆ getAssignments()

ilObjStudyProgramme::getAssignments ( )

Get all assignments to this program or any node above.

Returns: ilStudyProgrammeAssignment[]

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

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

References $assignment_repository, and getAssignmentsRaw().

Referenced by hasAssignments().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAssignmentsOf()

ilObjStudyProgramme::getAssignmentsOf ( int $a_user_id )

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

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

Returns: ilStudyProgrammeAssignment[]

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

                                                     : array
    {
        $prg_ids = $this->getIdsFromNodesOnPathFromRootToHere();
        $assignments = [];
        foreach ($prg_ids as $prg_id) {
            $assignments = array_merge(
                $assignments,
                $this->assignment_repository->getByUsrIdAndPrgId($a_user_id, $prg_id)
            );
        }
        usort($assignments, function ($a_one, $a_other) {
            return strcmp(
                $a_one->getLastChange()->format('Y-m-d'),
                $a_other->getLastChange()->format('Y-m-d')
            );
        });
        $assignment_repository = $this->assignment_repository;
        return array_map(function ($ass) use ($assignment_repository) {
            return $assignment_repository->getInstanceByModel($ass);
        }, array_values($assignments)); // use array values since we want keys 0...
    }

References $assignment_repository, and getIdsFromNodesOnPathFromRootToHere().

Referenced by getAmountOfAssignmentsOf().

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: ilStudyProgrammeAssignment[]

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

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

References ilObject\getId().

Referenced by enableAutomaticMembershipSource(), and hasAssignmentsOfSingleProgramForUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getAssignmentsRaw()

ilObjStudyProgramme::getAssignmentsRaw ( )

protected

Get model objects for the assignments on this programm.

Returns: ilStudyProgrammeAssignment[]

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

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

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

Referenced by getAssignments().

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

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

References ilObject\getId().

Referenced by hasAutomaticContentCategories().

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

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

References ilObject\getId().

Referenced by getApplicableMembershipSourceForUser().

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

                                                                  : array
    {
        $this->throwIfNotInTree();
 
        if ($this->children === null) {
            $ref_ids = $this->tree->getChildsByType($this->getRefId(), "prg");
 
            // apply container sorting to tree
            $sorting = ilContainerSorting::_getInstance($this->getId());
            $ref_ids = $sorting->sortItems(array('prg' => $ref_ids));
            $ref_ids = $ref_ids['prg'];
 
            $this->children = array_map(function ($node_data) {
                return ilObjStudyProgramme::getInstanceByRefId($node_data["child"]);
            }, $ref_ids);
        }
 
        if ($include_references && $this->reference_children === null) {
            $this->reference_children = [];
            $ref_child_ref_ids = $this->tree->getChildsByType($this->getRefId(), "prgr");
            foreach ($this->children as $prg) {
                $ref_child_ref_ids =
                    array_merge(
                        $this->tree->getChildsByType($prg->getRefId(), "prgr"),
                        $ref_child_ref_ids
                    );
            }
            foreach (
                array_unique(
                    array_map(
                        function ($data) {
                            return $data['child'];
                        },
                        array_filter($ref_child_ref_ids, function ($data) {
                            return $data["deleted"] === null;
                        })
                    )
                ) as $prg_ref_id
            ) {
                $this->reference_children[] =
                    (new ilObjStudyProgrammeReference($prg_ref_id))->getReferencedObject();
            }
        }
        return $include_references ?
            array_merge($this->children, $this->reference_children) :
            $this->children;
    }

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

Referenced by addMissingProgresses(), applyToSubTreeNodes(), and getAmountOfChildren().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getChildrenProgress()

ilObjStudyProgramme::getChildrenProgress ( $progress )

Returns: ilStudyProgrammeProgress[]

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

                                                   : array
    {
        $children = $this->getObjIdsOfChildren($progress->getNodeId());
        $ass_id = $progress->getAssignmentId();
 
        $ret = [];
        foreach ($children as $child_obj_id) {
            $progress = $this->getProgressRepository()->getByPrgIdAndAssignmentId($child_obj_id, $ass_id);
            $ret[] = $this->getProgressRepository()->getByPrgIdAndAssignmentId($child_obj_id, $ass_id);
        }
 
        return $ret;
    }

References $ret.

◆ getCompletedCourses()

ilObjStudyProgramme::getCompletedCourses ( int $a_user_id )

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

Returns: int[]

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

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

References ilObject\_exists(), ilLPStatus\_hasUserCompleted(), ilObject\_lookupDeletedDate(), ilContainerReference\_lookupTargetId(), ilContainerReference\_lookupTitle(), getInstanceByRefId(), and ilObject\getRefId().

Here is the call graph for this function:

◆ getCreatableSubObjects()

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

static

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

Will be called by ilObjDefinition::getCreatableSubObjects.

@thorws ilException

Parameters

string[] $a_subobjects

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

                                                                                  : array
    {
        if ($a_ref_id === null) {
            return $a_subobjects;
        }
 
        if (ilObject::_lookupType($a_ref_id, true) != "prg") {
            throw new ilException("Ref-Id '$a_ref_id' does not belong to a study programme object.");
        }
 
        $parent = ilObjStudyProgramme::getInstanceByRefId($a_ref_id);
 
        $mode = $parent->getLPMode();
 
        switch ($mode) {
            case ilStudyProgrammeSettings::MODE_UNDEFINED:
                $possible_subobjects = $a_subobjects;
                break;
            case ilStudyProgrammeSettings::MODE_POINTS:
                $possible_subobjects = [
                    "prg" => $a_subobjects["prg"],
                    "prgr" => $a_subobjects["prgr"]
                ];
                break;
            case ilStudyProgrammeSettings::MODE_LP_COMPLETED:
                $possible_subobjects = ['crsr' => $a_subobjects['crsr']];
                break;
            default:
                throw new ilException("Undefined mode for study programme: '$mode'");
        }
 
        if ($parent->hasAutomaticContentCategories()) {
            $possible_subobjects = array_filter(
                $possible_subobjects,
                function ($subtype) {
                    return $subtype === 'crsr';
                },
                ARRAY_FILTER_USE_KEY
            );
        }
        return $possible_subobjects;
    }

References ilObject\_lookupType(), getInstanceByRefId(), ilStudyProgrammeSettings\MODE_LP_COMPLETED, ilStudyProgrammeSettings\MODE_POINTS, and ilStudyProgrammeSettings\MODE_UNDEFINED.

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

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

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

◆ getIdsFromNodesOnPathFromRootToHere()

ilObjStudyProgramme::getIdsFromNodesOnPathFromRootToHere ( bool $include_references = false )

protected

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

Returns: int[]

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

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

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

Referenced by getAssignmentsOf(), and getAssignmentsRaw().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIdsOfSuccessfulChildren()

ilObjStudyProgramme::getIdsOfSuccessfulChildren ( int $ass_id )

Returns: array <obj_id, ref_id>

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

                                                            : array
    {
        $children = $this->getChildren(true);
        
        $ids = array();
        
        foreach ($children as $child) {
            $prgrs = $child->getProgressForAssignment($ass_id);
            if (!$prgrs->isSuccessful()) {
                continue;
            }
            $ids[] = [$child->getId(), $child->getRefId()];
        }
        if (count($ids) > 0) {
            return $ids;
        }
 
        //courses:
        $children = $this->getTree()->getChildsByType($this->getRefId(), "crsr");
        $usr_id = $this->getAssignmentRepository()->get($ass_id)->getUserId();
        foreach ($children as $child) {
            if (ilObject::_exists($child['ref_id'], true) &&
                is_null(ilObject::_lookupDeletedDate($child['ref_id']))
            ) {
                continue;
            }
            $crs_id = ilContainerReference::_lookupTargetId($child["obj_id"]);
 
            if (ilLPStatus::_hasUserCompleted($crs_id, $usr_id)) {
                $ref_id = ilContainerReference::_lookupTargetRefId($child["obj_id"]);
                $ids[] = [$crs_id, $ref_id];
            }
        }
        return $ids;
    }

References ilObject\_exists(), ilLPStatus\_hasUserCompleted(), ilObject\_lookupDeletedDate(), ilContainerReference\_lookupTargetId(), and ilContainerReference\_lookupTargetRefId().

Here is the call graph for this function:

◆ getIdsOfUsersWithCompletedProgress()

ilObjStudyProgramme::getIdsOfUsersWithCompletedProgress ( )

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

Returns: int[]

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

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

References getProgresses().

Referenced by getIdsOfUsersWithFailedProgress().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getIdsOfUsersWithFailedProgress()

ilObjStudyProgramme::getIdsOfUsersWithFailedProgress ( )

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

Returns: int[]

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

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

References getIdsOfUsersWithCompletedProgress(), and getProgresses().

Here is the call graph for this function:

◆ getIdsOfUsersWithNotCompletedAndRelevantProgress()

ilObjStudyProgramme::getIdsOfUsersWithNotCompletedAndRelevantProgress ( )

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

Returns: int[]

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

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

References getProgresses().

Here is the call graph for this function:

◆ getIdsOfUsersWithRelevantProgress()

ilObjStudyProgramme::getIdsOfUsersWithRelevantProgress ( )

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

Returns: int[]

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

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

References getProgresses().

Here is the call graph for this function:

◆ getInstanceByObjId()

static ilObjStudyProgramme::getInstanceByObjId ( $obj_id )

static

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

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

References getInstanceByRefId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstanceByRefId()

static ilObjStudyProgramme::getInstanceByRefId ( $a_ref_id )

static

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

                                                         : ilObjStudyProgramme
    {
        if (self::$study_programme_cache === null) {
            self::initStudyProgrammeCache();
        }
        return self::$study_programme_cache->getInstanceByRefId($a_ref_id);
    }

References initStudyProgrammeCache().

Here is the call graph for this function:

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

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

References getSettings().

Here is the call graph for this function:

◆ getLocalMembers()

ilObjStudyProgramme::getLocalMembers ( )

get usr_ids with assignment on this node

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

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

References $members_cache, and ilObject\getId().

Here is the call graph for this function:

◆ getLoggedInUserId()

ilObjStudyProgramme::getLoggedInUserId ( )

protected

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

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

Referenced by assignUser().

Here is the caller graph for this function:

◆ getLogger()

ilObjStudyProgramme::getLogger ( )

protected

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

                                   : ilComponentLogger
    {
        return $this->logger;
    }

Referenced by addMissingProgresses().

Here is the caller graph for this function:

◆ getLPChildren()

ilObjStudyProgramme::getLPChildren ( )

Get the leafs the study programme contains.

Returns: ilStudyProgrammeLeaf[]

Exceptions

ilStudyProgrammeTreeException when this object is not in tree.

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

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

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

Referenced by getAmountOfLPChildren(), and getLPChildrenIds().

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: ilStudyProgrammeLeaf[]

Exceptions

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

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

References getLPChildren().

Here is the call graph for this function:

◆ getLPMode()

ilObjStudyProgramme::getLPMode ( )

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

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

References getSettings().

Referenced by addNode(), and nodeInserted().

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

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

References getProgresses().

Here is the call graph for this function:

◆ getMembersOfMembershipSource()

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

protected

Get member-ids of a certain source.

Returns: int[]

Exceptions

InvalidArgumentException if $src_type is not in AutoMembershipSource-types

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

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

Referenced by enableAutomaticMembershipSource(), and getApplicableMembershipSourceForUser().

Here is the caller graph for this function:

◆ getNamesOfCompletedOrAccreditedChildren()

ilObjStudyProgramme::getNamesOfCompletedOrAccreditedChildren ( int $ass_id )

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

                                                                         : array
    {
        return array_map(
            function ($entry) {
                list($obj_id, $ref_id) = $entry;
                return ilObject::_lookupTitle($obj_id);
            },
            $this->getIdsOfSuccessfulChildren($ass_id)
        );
    }

References ilObject\_lookupTitle().

Here is the call graph for this function:

◆ getNow()

ilObjStudyProgramme::getNow ( )

protected

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

                                : DateTimeImmutable
    {
        return new DateTimeImmutable();
    }

◆ getObjIdsOfChildren()

ilObjStudyProgramme::getObjIdsOfChildren ( int $node_obj_id )

protected

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

                                                             : array
    {
        $node_ref_id = self::getRefIdFor($node_obj_id);
 
        $prgs = $this->tree->getChildsByType($node_ref_id, "prg");
        $prg_ids = array_map(
            function ($nd) {
                return (int) $nd['obj_id'];
            },
            $prgs
        );
 
        $prg_ref_ids = [];
        $prg_refs = $this->tree->getChildsByType($node_ref_id, "prgr");
        foreach ($prg_refs as $ref) {
            $ref_obj = new ilObjStudyProgrammeReference((int) $ref['ref_id']);
            $prg_ref_ids[] = (int) $ref_obj->getReferencedObject()->getId();
        }
 
        return array_merge($prg_ids, $prg_ref_ids);
    }

References $nd.

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

                                : ?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 = ilObjStudyProgramme::getInstanceByRefId($parent_data["ref_id"]);
            }
        }
        return $this->parent;
    }

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getParentId()

static ilObjStudyProgramme::getParentId ( ilObject $a_object )

staticprotected

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

Returns null if object is not in the tree currently.

Returns: int | null

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

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

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

Here is the call graph for this function:

◆ getParentProgress()

ilObjStudyProgramme::getParentProgress ( ilStudyProgrammeProgress $progress )

protected

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

                                                                             : ?ilStudyProgrammeProgress
    {
        $assignment_id = $progress->getAssignmentId();
 
        $prg_ref_id = $this->getRefIdFor($progress->getNodeId());
        $parent_node = $this->tree->getParentNodeData($prg_ref_id);
        $parent_prg_obj_id = (int) $parent_node["obj_id"];
 
        $parent_progress = $this->progress_repository->getByPrgIdAndAssignmentId(
            $parent_prg_obj_id,
            $assignment_id
        );
 
        if (!$parent_progress) {
            //maybe by reference?
            $obj_ids_referencing_node = ilContainerReference::_lookupSourceIds($progress->getNodeId());
            foreach (ilContainerReference::_lookupSourceIds($progress->getNodeId()) as $obj_id_referencing) {
                foreach (ilObject::_getAllReferences($obj_id_referencing) as $ref_id_referencing) {
                    $parent_node = $this->tree->getParentNodeData($ref_id_referencing);
                    $parent_prg_obj_id = (int) $parent_node["obj_id"];
 
                    $parent_progress = $this->progress_repository->getByPrgIdAndAssignmentId(
                        $parent_prg_obj_id,
                        $assignment_id
                    );
                    if ($parent_progress) {
                        return $parent_progress;
                    }
                }
            }
        }
 
        return $parent_progress; //...which is null here
    }

References ilObject\_getAllReferences(), ilContainerReference\_lookupSourceIds(), ilStudyProgrammeProgress\getAssignmentId(), and ilStudyProgrammeProgress\getNodeId().

Here is the call graph for this function:

◆ getParents()

ilObjStudyProgramme::getParents ( bool $include_references = false )

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

Returns: ilObjStudyProgramme[]

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

                                                                 : 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;
                    }
                    array_push($queque, $r_parent);
                    $parents[] = $r_parent;
                }
                continue;
            }
            array_push($queque, $parent);
            $parents[] = $parent;
        }
        return array_reverse($parents);
    }

References $parent, and getReferencesTo().

Referenced by getIdsFromNodesOnPathFromRootToHere(), and getRoot().

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

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

References getSettings().

Referenced by ilStudyProgrammeDashboardViewGUI\calculatePercent().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPossiblePointsOfRelevantChildren()

ilObjStudyProgramme::getPossiblePointsOfRelevantChildren ( ilStudyProgrammeProgress $progress )

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

                                                                                            : int
    {
        $sum = 0;
        foreach ($this->getChildrenProgress($progress) as $child_progress) {
            if (!is_null($child_progress) && $child_progress->isRelevant()) {
                $sum += $child_progress->getAmountOfPoints();
            }
        }
        return $sum;
    }

◆ getPrgInstanceByObjId()

ilObjStudyProgramme::getPrgInstanceByObjId ( int $obj_id )

protected

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

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

References getInstanceByRefId().

Here is the call graph for this function:

◆ getProgrammeSettingsForProgress()

ilObjStudyProgramme::getProgrammeSettingsForProgress ( ilStudyProgrammeProgress $progress )

protected

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

                                                                                           : ilStudyProgrammeSettings
    {
        return $this->settings_repository->get($progress->getNodeId());
    }

References ilStudyProgrammeProgress\getNodeId().

Here is the call graph for this function:

◆ getProgrammesMonitoringCategory()

static ilObjStudyProgramme::getProgrammesMonitoringCategory ( int $cat_ref_id )

staticprotected

Get all StudyProgrammes monitoring this category.

Returns: ilObjStudyProgramme[]

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

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

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

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

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

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

Here is the call graph for this function:

◆ getProgresses()

ilObjStudyProgramme::getProgresses ( )

Get all progresses on this node.

Returns: ilStudyProgrammeProgress[]

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

                                    : array
    {
        return $this->progress_repository->getByPrgId($this->getId());
    }

References ilObject\getId().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getProgressesOf()

ilObjStudyProgramme::getProgressesOf ( int $a_user_id )

Get the progresses the user has on this node.

Parameters

int $a_user_id

Returns: ilStudyProgrammeProgress[]

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

                                                    : array
    {
        return $this->progress_repository->getByPrgIdAndUserId($this->getId(), $a_user_id);
    }

References ilObject\getId().

Referenced by ilStudyProgrammeMailTemplateContext\getNewestProgressForUser().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getProgressForAssignment()

ilObjStudyProgramme::getProgressForAssignment ( int $assignment_id )

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

                                                                 : ?ilStudyProgrammeProgress
    {
        return $this->getProgressRepository()->getByPrgIdAndAssignmentId($this->getId(), $assignment_id);
    }

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

Here is the call graph for this function:

◆ getProgressIdString()

ilObjStudyProgramme::getProgressIdString ( ilStudyProgrammeProgress $progress )

protected

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

                                                                               : string
    {
        $username = ilObjUser::_lookupFullname($progress->getUserId());
        return sprintf(
            '%s, progress-id %s',
            $username,
            $progress->getId()
        );
    }

References ilObjUser\_lookupFullname(), ilStudyProgrammeProgress\getId(), and ilStudyProgrammeProgress\getUserId().

Here is the call graph for this function:

◆ getProgressRepository()

ilObjStudyProgramme::getProgressRepository ( )

protected

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

                                               : ilStudyProgrammeProgressRepository
    {
        return $this->progress_repository;
    }

References $progress_repository.

Referenced by addMissingProgresses(), assignUser(), deleteAssignmentsAndProgresses(), and getProgressForAssignment().

Here is the caller graph for this function:

◆ getReferencesTo()

ilObjStudyProgramme::getReferencesTo ( ilObjStudyProgramme $prg )

protected

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

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

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

Referenced by getParents(), and getReferencesToSelf().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getReferencesToSelf()

ilObjStudyProgramme::getReferencesToSelf ( )

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

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

References getReferencesTo().

Here is the call graph for this function:

◆ getRefIdFor()

static ilObjStudyProgramme::getRefIdFor ( int $obj_id )

static

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

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

References ilObject\_getAllReferences().

Referenced by ilStudyProgrammeMailMemberSearchGUI\getRootPrgRefId(), ilObjStudyProgrammeMembersGUI\remove(), and ilStudyProgrammeEvents\userReAssigned().

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.

Returns: ilObjStudyProgramme

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

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

References getParents().

Here is the call graph for this function:

◆ getSettings()

ilObjStudyProgramme::getSettings ( )

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSettingsRepository()

ilObjStudyProgramme::getSettingsRepository ( )

protected

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

                                               : ilStudyProgrammeSettingsRepository
    {
        return $this->settings_repository;
    }

References $settings_repository.

Referenced by addMissingProgresses(), create(), deleteSettings(), getSettings(), and updateSettings().

Here is the caller graph for this function:

◆ getStatus()

ilObjStudyProgramme::getStatus ( )

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

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

References getSettings().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSubType()

ilObjStudyProgramme::getSubType ( )

Gets the SubType Object.

Returns: ilStudyProgrammeType | null

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

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

References getSettings().

Here is the call graph for this function:

◆ getTree()

ilObjStudyProgramme::getTree ( )

protected

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

                                 : ilTree
    {
        return $this->tree;
    }

References $tree.

◆ hasAdvancedMetadata()

ilObjStudyProgramme::hasAdvancedMetadata ( )

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

                                          : bool
    {
        $sub_type_id = $this->getSettings()->getTypeSettings()->getTypeId();
        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;
    }

References ilObject\$type, and getSettings().

Here is the call graph for this function:

◆ hasAssignmentOf()

ilObjStudyProgramme::hasAssignmentOf ( int $a_user_id )

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

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

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

References getAmountOfAssignmentsOf().

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

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

References getAssignments().

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

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

References getAssignmentsOfSingleProgramForUser().

Here is the call graph for this function:

◆ hasAutomaticContentCategories()

ilObjStudyProgramme::hasAutomaticContentCategories ( )

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

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

References getAutomaticContentCategories().

Here is the call graph for this function:

◆ hasChildren()

ilObjStudyProgramme::hasChildren ( bool $include_references = false )

Does this StudyProgramme have other ilObjStudyProgrammes as children?

Exceptions

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

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

References getAmountOfChildren().

Referenced by addLeaf().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasLPChildren()

ilObjStudyProgramme::hasLPChildren ( )

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

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

References getAmountOfLPChildren().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasProgresses()

ilObjStudyProgramme::hasProgresses ( )

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

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

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

References getProgresses().

Here is the call graph for this function:

◆ hasRelevantProgresses()

ilObjStudyProgramme::hasRelevantProgresses ( )

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

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

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

References getProgresses().

Here is the call graph for this function:

◆ initStudyProgrammeCache()

static ilObjStudyProgramme::initStudyProgrammeCache ( )

static

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

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

References ilObjStudyProgrammeCache\singleton().

Referenced by __construct(), and getInstanceByRefId().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ invalidate()

ilObjStudyProgramme::invalidate ( int $progress_id )

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

                                                 : void
    {
        $progress = $this->getProgressRepository()->get($progress_id)
            ->invalidate();
 
        $this->getProgressRepository()->update($progress);
        $this->refreshLPStatus($progress->getUserId());
        $this->updateParentProgress($progress);
    }

◆ isActive()

ilObjStudyProgramme::isActive ( )

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

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

References getStatus(), and 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

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

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

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

Here is the call graph for this function:

◆ markAccredited()

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

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

      : void {
        $progress = $this->getProgressRepository()->get($progress_id);
        $new_status = $progress::STATUS_ACCREDITED;
 
        if (!$progress->isRelevant()) {
            $err_collection->add(false, 'will_not_modify_irrelevant_progress', $this->getProgressIdString($progress));
            return;
        }
        if ($progress->getStatus() === $new_status) {
            $err_collection->add(false, 'status_unchanged', $this->getProgressIdString($progress));
            return;
        }
        if (!$progress->isTransitionAllowedTo($new_status)) {
            $err_collection->add(false, 'status_transition_not_allowed', $this->getProgressIdString($progress));
            return;
        }
 
        $progress = $progress
            ->markAccredited($this->getNow(), $acting_usr_id)
            ->withCurrentAmountOfPoints($progress->getAmountOfPoints());
 
        if (!$progress->getValidityOfQualification()) {
            $progress = $this->updateProgressValidityFromSettings($progress);
        }
  
        $this->events->userSuccessful($progress);
 
        $this->getProgressRepository()->update($progress);
        $this->refreshLPStatus($progress->getUserId());
        $this->updateParentProgress($progress);
        $err_collection->add(true, 'status_changed', $this->getProgressIdString($progress));
    }

Here is the call graph for this function:

◆ markFailed()

ilObjStudyProgramme::markFailed	(	int	$progress_id,
		int	$acting_usr_id
	)

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

                                                                     : void
    {
        $progress = $this->getProgressRepository()->get($progress_id);
        if (!$progress->isRelevant()) {
            return;
        }
        $progress = $progress->markFailed($this->getNow(), $acting_usr_id);
 
        $this->getProgressRepository()->update($progress);
        $this->refreshLPStatus($progress->getUserId());
        $this->updateParentProgress($progress);
    }

◆ markNotFailed()

ilObjStudyProgramme::markNotFailed	(	int	$progress_id,
		int	$acting_usr_id
	)

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

                                                                        : void
    {
        if (!$progress->isRelevant()) {
            return;
        }
        $progress = $this->getProgressRepository()->get($progress_id)
            ->markNotFailed($this->getNow(), $acting_usr_id);
 
        $this->getProgressRepository()->update($progress);
        $this->refreshLPStatus($progress->getUserId());
        $this->updateParentProgress($progress);
    }

◆ markNotRelevant()

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

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

      : void {
        $progress = $this->getProgressRepository()->get($progress_id);
        if (!$progress->isRelevant()) {
            $err_collection->add(false, 'will_not_modify_irrelevant_progress', $this->getProgressIdString($progress));
            return;
        }
        if (is_null($this->getParentProgress($progress))) {
            $err_collection->add(false, 'will_not_set_top_progress_to_irrelevant', $this->getProgressIdString($progress));
            return;
        }
        if ($progress->getStatus() === ilStudyProgrammeProgress::STATUS_COMPLETED) {
            $err_collection->add(false, 'will_not_set_completed_progress_to_irrelevant_', $this->getProgressIdString($progress));
            return;
        }
        
        $progress = $progress
            ->markNotRelevant($this->getNow(), $acting_usr_id);
 
        $this->getProgressRepository()->update($progress);
        $this->refreshLPStatus($progress->getUserId());
        $this->updateParentProgress($progress);
        $err_collection->add(true, 'set_to_irrelevant', $this->getProgressIdString($progress));
    }

Here is the call graph for this function:

◆ markRelevant()

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

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

      : void {
        $progress = $this->getProgressRepository()->get($progress_id);
        if ($progress->isRelevant()) {
            $err_collection->add(false, 'will_not_modify_relevant_progress', $this->getProgressIdString($progress));
            return;
        }
 
        $progress = $progress
            ->markRelevant($this->getNow(), $acting_usr_id);
    
        $progress = $this->recalculateProgressStatus($progress);
 
        $this->getProgressRepository()->update($progress);
        $this->refreshLPStatus($progress->getUserId());
        $this->updateParentProgress($progress);
        $err_collection->add(true, 'set_to_relevant', $this->getProgressIdString($progress));
    }

Here is the call graph for this function:

◆ moveTo()

ilObjStudyProgramme::moveTo ( ilObjStudyProgramme $a_new_parent )

Move this tree node to a new parent.

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

Exceptions

ilStudyProgrammeTreeException
ilException

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

                                                              : ilObjStudyProgramme
    {
        global $DIC;
        $rbacadmin = $DIC['rbacadmin'];
 
        if ($parent = $this->getParent()) {
 
            // TODO: check if there some leafs in the new parent
 
            $this->tree->moveTree($this->getRefId(), $a_new_parent->getRefId());
            // necessary to clean up permissions
            $rbacadmin->adjustMovedObjectPermissions($this->getRefId(), $parent->getRefId());
 
            // TODO: lp-progress needs to be updated
 
            // clear caches on different nodes
            $this->clearParentCache();
 
            $parent->clearChildrenCache();
            $parent->clearLPChildrenCache();
 
            $a_new_parent->clearChildrenCache();
            $a_new_parent->clearLPChildrenCache();
        }
 
        return $this;
    }

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

Here is the call graph for this function:

◆ nodeInserted()

ilObjStudyProgramme::nodeInserted ( ilObjStudyProgramme $a_prg )

Clears child chache and adds progress for new node.

called by ilObjStudyProgrammeReference::putInTree, e.g.

Exceptions

ilStudyProgrammeTreeException
ilException

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

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

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

Here is the call graph for this function:

◆ putInTree()

ilObjStudyProgramme::putInTree ( $a_parent_ref )

Overwritten from ilObject.

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

Parameters

int $a_parent_ref

Exceptions

ilStudyProgrammeTreeException
ilException

Reimplemented from ilContainer.

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

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

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

Referenced by addNode().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ recalculateProgressStatus()

ilObjStudyProgramme::recalculateProgressStatus ( ilStudyProgrammeProgress $progress )

protected

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

                                                                                     : ilStudyProgrammeProgress
    {
        if (!$progress->isRelevant()) {
            return $progress;
        }
        $node_settings = $this->getSettingsRepository()->get($progress->getNodeId());
        $completion_mode = $node_settings->getLPMode();
 
        if ($completion_mode === ilStudyProgrammeSettings::MODE_UNDEFINED) {
            return $progress;
        }
 
        $required_points = $progress->getAmountOfPoints();
        
        if ($completion_mode === ilStudyProgrammeSettings::MODE_LP_COMPLETED) {
            $achieved_points = 0;
            
            $node_ref = self::getRefIdFor($progress->getNodeId());
            $children = $this->tree->getChildsByType($node_ref, "crsr");
            foreach ($children as $child) {
                if (ilObject::_exists($child['ref_id'], true) &&
                    is_null(ilObject::_lookupDeletedDate($child['ref_id']))
                ) {
                    $crs_id = ilContainerReference::_lookupTargetId($child["obj_id"]);
                    if (ilLPStatus::_hasUserCompleted($crs_id, $progress->getUserId())) {
                        $achieved_points = $progress->getAmountOfPoints();
                        break;
                    }
                }
            }
        }
 
        if ($completion_mode === ilStudyProgrammeSettings::MODE_POINTS) {
            $achieved_points = $this->getAchievedPointsOfChildren($progress);
        }
         
        $progress = $progress->withCurrentAmountOfPoints($achieved_points);
        $successful = ($achieved_points >= $required_points);
 
        if ($successful && !$progress->isSuccessful()) {
            $progress = $progress
                ->withStatus(ilStudyProgrammeProgress::STATUS_COMPLETED)
                ->withCompletion(null, new DateTimeImmutable());
          
            // there was a status change, so:
            $this->events->userSuccessful($progress);
        }
 
        if (!$successful && $progress->isSuccessful()) {
            $progress = $progress
                ->withStatus(ilStudyProgrammeProgress::STATUS_IN_PROGRESS)
                ->withCompletion(null, null)
                ->withValidityOfQualification(null);
        }
        
        return $progress;
    }

Here is the call graph for this function:

◆ refreshLPStatus()

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

protected

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

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

References ilLPStatusWrapper\_updateStatus().

Referenced by removeAssignment().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ removeAssignment()

ilObjStudyProgramme::removeAssignment ( ilStudyProgrammeAssignment $assignment )

Remove an assignment from this program.

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

Exceptions

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

                                                                             : 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 = $this->progress_repository->deleteForAssignmentId($assignment->getId());
        foreach ($affected_node_ids as $node_obj_id) {
            $this->refreshLPStatus($assignment->getUserId(), $node_obj_id);
        }
 
        $this->events->userDeassigned($assignment);
        return $this;
    }

References ilStudyProgrammeAssignment\getId(), ilStudyProgrammeAssignment\getRootId(), ilStudyProgrammeAssignment\getUserId(), and refreshLPStatus().

Here is the call graph for this function:

◆ removeCrsFromProgrammes()

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

static

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

Exceptions

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

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

Referenced by ilStudyProgrammeAppEventListener\removeCrsFromProgrammes().

Here is the caller graph for this function:

◆ removeLeaf()

ilObjStudyProgramme::removeLeaf ( ilStudyProgrammeLeaf $a_leaf )

Remove a leaf from this object.

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

Exceptions

ilException
ilStudyProgrammeTreeException

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

                                                             : ilObjStudyProgramme
    {
        if (self::getParentId($a_leaf) !== $this->getId()) {
            throw new ilStudyProgrammeTreeException("This is no parent of the given leaf node.");
        }
 
        $node_data = $this->tree->getNodeData($a_leaf->getRefId());
        $this->tree->deleteTree($node_data);
        $this->clearLPChildrenCache();
 
        return $this;
    }

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

Here is the call graph for this function:

◆ removeMemberFromProgrammes()

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

static

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

                                                                                                  : void
    {
        $now = new DateTimeImmutable();
        foreach (self::getProgrammesMonitoringMemberSource($src_type, $src_id) as $prg) {
            foreach ($prg->getProgressesOf($usr_id) as $progress) {
                if ($progress->getStatus() !== ilStudyProgrammeProgress::STATUS_IN_PROGRESS) {
                    continue;
                }
                $assignments = $prg->getAssignmentsOfSingleProgramForUser($usr_id);
                $next_membership_source = $prg->getApplicableMembershipSourceForUser($usr_id, $src_type);
 
                foreach ($assignments as $assignment) {
                    if (!is_null($next_membership_source) && $next_membership_source->isEnabled()) {
                        $new_src_type = $next_membership_source->getSourceType();
                        $assigned_by = ilStudyProgrammeAutoMembershipSource::SOURCE_MAPPING[$new_src_type];
                        $assignment = $assignment->withLastChange($assigned_by, $now);
                        $prg->assignment_repository->update($assignment);
                        break;
                    } else {
                        $assignment_repository = ilStudyProgrammeDIC::dic()['ilStudyProgrammeUserAssignmentDB'];
                        $user_assignment = $assignment_repository->getInstanceByModel($assignment);
                        $prg->removeAssignment($user_assignment);
                    }
                }
            }
        }
    }

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

Referenced by ilStudyProgrammeAppEventListener\removeMemberFromProgrammes().

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

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

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

Here is the call graph for this function:

◆ resetProgressToSettings()

ilObjStudyProgramme::resetProgressToSettings	(	ilStudyProgrammeProgress	$progress,
		int	$acting_usr_id
	)

protected

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

      : ilStudyProgrammeProgress {
        if ($progress->isRelevant()) {
            $progress = $this->updateProgressValidityFromSettings($progress);
            $progress = $this->updateProgressDeadlineFromSettings($progress);
        } else {
            $progress = $progress
                ->withValidityOfQualification(null)
                ->withDeadline(null);
        }
 
        $progress = $progress->withAmountOfPoints($this->getPoints());
        $progress = $progress
            ->withLastChange($acting_usr_id, $this->getNow())
            ->withIndividualModifications(false);
 
        return $progress;
    }

Referenced by assignUser().

Here is the caller graph for this function:

◆ sendInformToReAssignMail()

static ilObjStudyProgramme::sendInformToReAssignMail	(	int	$progress_id,
		int	$usr_id
	)

static

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

                                                                                   : void
    {
        global $DIC;
        $lng = $DIC['lng'];
        $log = $DIC['ilLog'];
        $lng->loadLanguageModule("prg");
        $lng->loadLanguageModule("mail");
 
        $usr_progress_db = ilStudyProgrammeDIC::dic()['ilStudyProgrammeUserProgressDB'];
        $usr_progress = $usr_progress_db->get($progress_id);
        $prg = ilObjStudyProgramme::getInstanceByObjId($usr_progress->getNodeId());
        $prg_should_send_mail = $prg->getSettings()->getAutoMailSettings()
            ->getReminderNotRestartedByUserDays() > 0;
 
        if (!$prg_should_send_mail) {
            $log->write("Send info to re assign mail is deactivated in study programme settings");
            return;
        }
 
        $subject = $lng->txt("info_to_re_assign_mail_subject");
        $gender = ilObjUser::_lookupGender($usr_id);
        $name = ilObjUser::_lookupFullname($usr_id);
        $body = sprintf(
            $lng->txt("info_to_re_assign_mail_body"),
            $lng->txt("mail_salutation_" . $gender),
            $name,
            $prg->getTitle()
        );
 
        $send = true;
        $mail = new ilMail(ANONYMOUS_USER_ID);
        try {
            $mail->enqueue(
                ilObjUser::_lookupLogin($usr_id),
                '',
                '',
                $subject,
                $body,
                null
            );
        } catch (Exception $e) {
            $send = false;
        }
 
        if ($send) {
            $usr_progress_db->sentExpiryInfoFor($usr_progress->getId());
        }
    }

References $DIC, Vendor\Package\$e, $lng, $log, $name, ilObjUser\_lookupFullname(), ilObjUser\_lookupGender(), ilObjUser\_lookupLogin(), ANONYMOUS_USER_ID, ilStudyProgrammeDIC\dic(), and getInstanceByObjId().

Referenced by ilStudyProgrammeAppEventListener\sendInformToReAssignMail().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendInvalidateMail()

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

static

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

                                                                        : bool
    {
        global $DIC;
        $lng = $DIC['lng'];
        $lng->loadLanguageModule("prg");
        $lng->loadLanguageModule("mail");
 
        $prg = ilObjStudyProgramme::getInstanceByRefId($ref_id);
 
        $subject = $lng->txt("invalidate_mail_subject");
        $gender = ilObjUser::_lookupGender($usr_id);
        $name = ilObjUser::_lookupFullname($usr_id);
        $body = sprintf(
            $lng->txt("invalidate_mail_body"),
            $lng->txt("mail_salutation_" . $gender),
            $name,
            $prg->getTitle()
        );
 
        $send = true;
        $mail = new ilMail(ANONYMOUS_USER_ID);
        try {
            $mail->enqueue(
                ilObjUser::_lookupLogin($usr_id),
                '',
                '',
                $subject,
                $body,
                null
            );
        } catch (Exception $e) {
            $send = false;
        }
 
        return $send;
    }

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

Here is the call graph for this function:

◆ sendReAssignedMail()

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

static

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

                                                                        : bool
    {
        global $DIC;
        $lng = $DIC['lng'];
        $lng->loadLanguageModule("prg");
        $lng->loadLanguageModule("mail");
        $log = $DIC['ilLog'];
 
        $prg = ilObjStudyProgramme::getInstanceByRefId($ref_id);
        $prg_should_send_mail = $prg->getSettings()->getAutoMailSettings()->getSendReAssignedMail();
        if (!$prg_should_send_mail) {
            $log->write("Send re assign mail is deactivated in study programme settings");
            return false;
        }
 
        $subject = $lng->txt("re_assigned_mail_subject");
        $gender = ilObjUser::_lookupGender($usr_id);
        $name = ilObjUser::_lookupFullname($usr_id);
        $body = sprintf(
            $lng->txt("re_assigned_mail_body"),
            $lng->txt("mail_salutation_" . $gender),
            $name,
            $prg->getTitle()
        );
 
        $send = true;
        $mail = new ilMail(ANONYMOUS_USER_ID);
        try {
            $mail->enqueue(
                ilObjUser::_lookupLogin($usr_id),
                '',
                '',
                $subject,
                $body,
                null
            );
        } catch (Exception $e) {
            $send = false;
        }
 
        return $send;
    }

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

Referenced by ilStudyProgrammeAppEventListener\sendReAssignedMail().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sendRiskyToFailMail()

static ilObjStudyProgramme::sendRiskyToFailMail	(	int	$progress_id,
		int	$usr_id
	)

static

Exceptions

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

                                                                              : void
    {
        global $DIC;
        $lng = $DIC['lng'];
        $log = $DIC['ilLog'];
        $lng->loadLanguageModule("prg");
        $lng->loadLanguageModule("mail");
 
        $usr_progress_db = ilStudyProgrammeDIC::dic()['ilStudyProgrammeUserProgressDB'];
        $usr_progress = $usr_progress_db->get($progress_id);
        $prg = ilObjStudyProgramme::getInstanceByObjId($usr_progress->getNodeId());
        $prg_should_send_mail = $prg->getSettings()->getAutoMailSettings()
            ->getProcessingEndsNotSuccessfulDays() > 0;
 
        if (!$prg_should_send_mail) {
            $log->write("Send risky to fail mail is deactivated in study programme settings");
            return;
        }
 
        $subject = $lng->txt("risky_to_fail_mail_subject");
        $gender = ilObjUser::_lookupGender($usr_id);
        $name = ilObjUser::_lookupFullname($usr_id);
        $body = sprintf(
            $lng->txt("risky_to_fail_mail_body"),
            $lng->txt("mail_salutation_" . $gender),
            $name,
            $prg->getTitle()
        );
 
        $send = true;
        $mail = new ilMail(ANONYMOUS_USER_ID);
        try {
            $mail->enqueue(
                ilObjUser::_lookupLogin($usr_id),
                '',
                '',
                $subject,
                $body,
                null
            );
        } catch (Exception $e) {
            $send = false;
        }
 
        if ($send) {
            $usr_progress_db->sentRiskyToFailFor($usr_progress->getId());
        }
    }

References $DIC, Vendor\Package\$e, $lng, $log, $name, ilObjUser\_lookupFullname(), ilObjUser\_lookupGender(), ilObjUser\_lookupLogin(), ANONYMOUS_USER_ID, ilStudyProgrammeDIC\dic(), and getInstanceByObjId().

Referenced by ilStudyProgrammeAppEventListener\sendRiskyToFailMail().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setPoints()

ilObjStudyProgramme::setPoints ( int $a_points )

Set the amount of points.

Exceptions

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

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

References getSettings(), and updateLastChange().

Here is the call graph for this function:

◆ setProgressesCompletedFor()

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

static

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

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

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

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

Referenced by ilStudyProgrammeAppEventListener\onServiceTrackingUpdateStatus().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setProgressesCompletedIfParentIsProgrammeInLPCompletedMode()

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

staticprotected

Exceptions

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

      : void {
        global $DIC; // TODO: replace this by a settable static for testing purpose?
        $tree = $DIC['tree'];
        $node_data = $tree->getParentNodeData($a_ref_id);
        if ($node_data["type"] !== "prg") {
            return;
        }
        self::initStudyProgrammeCache();
        $prg = ilObjStudyProgramme::getInstanceByRefId($node_data["child"]);
        if ($prg->getLPMode() != ilStudyProgrammeSettings::MODE_LP_COMPLETED) {
            return;
        }
 
        $now = new DateTimeImmutable();
        foreach ($prg->getProgressesOf($a_user_id) as $progress) {
            $progress_deadline = $progress->getDeadline();
            if (
                (is_null($progress_deadline) || $progress_deadline >= $now)
                && $progress->getStatus() === ilStudyProgrammeProgress::STATUS_IN_PROGRESS
            ) {
                $prg->succeed($progress->getId(), $a_obj_id);
            }
        }
    }

Referenced by setProgressesCompletedFor().

Here is the caller graph for this function:

◆ setStatus()

ilObjStudyProgramme::setStatus ( int $a_status )

Set the status of the node.

Exceptions

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

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

References getSettings(), and updateLastChange().

Here is the call graph for this function:

◆ statusToRepr()

ilObjStudyProgramme::statusToRepr ( $a_status )

Get a user readable representation of a status.

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

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

References $lng, ilStudyProgrammeProgress\STATUS_ACCREDITED, ilStudyProgrammeProgress\STATUS_COMPLETED, ilStudyProgrammeProgress\STATUS_FAILED, ilStudyProgrammeProgress\STATUS_IN_PROGRESS, and ilStudyProgrammeProgress\STATUS_NOT_RELEVANT.

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

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

References ilObject\getId().

Here is the call graph for this function:

◆ storeAutomaticMembershipSource()

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

Store a source to be monitored for automatic memberships.

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

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

References ilObject\getId().

Here is the call graph for this function:

◆ succeed()

ilObjStudyProgramme::succeed	(	int	$progress_id,
		int	$triggering_obj_id
	)

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

                                                                      : void
    {
        $progress = $this->getProgressRepository()->get($progress_id)
            ->succeed($this->getNow(), $triggering_obj_id);
                
        $achieved_points = $progress->getAmountOfPoints();
        $progress = $progress->withCurrentAmountOfPoints($achieved_points);
        $progress = $this->updateProgressValidityFromSettings($progress);
 
        $this->getProgressRepository()->update($progress);
 
        $this->refreshLPStatus($progress->getUserId());
        $this->updateParentProgress($progress);
    }

◆ throwIfNotInTree()

ilObjStudyProgramme::throwIfNotInTree ( )

protected

Exceptions

ilStudyProgrammeTreeException if object is not in tree.

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

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

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

Here is the caller graph for this function:

◆ unmarkAccredited()

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

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

      : void {
        $progress = $this->getProgressRepository()->get($progress_id);
        $new_status = $progress::STATUS_IN_PROGRESS;
 
        if (!$progress->isRelevant()) {
            $err_collection->add(false, 'will_not_modify_irrelevant_progress', $this->getProgressIdString($progress));
            return;
        }
        if ($progress->getStatus() === $new_status) {
            $err_collection->add(false, 'status_unchanged', $this->getProgressIdString($progress));
            return;
        }
        if (!$progress->isTransitionAllowedTo($new_status)
            //special case: completion may not be revoked manually (but might be as a calculation-result of underlying progresses)
            || $progress->getStatus() === $progress::STATUS_COMPLETED
        ) {
            $err_collection->add(false, 'status_transition_not_allowed', $this->getProgressIdString($progress));
            return;
        }
        
        $progress = $progress
            ->unmarkAccredited($this->getNow(), $acting_usr_id);
 
        $achieved_points = $this->getAchievedPointsOfChildren($progress);
        $progress = $progress->withCurrentAmountOfPoints($achieved_points);
 
        $progress = $this->applyProgressDeadline($progress);
 
        $this->getProgressRepository()->update($progress);
        $this->refreshLPStatus($progress->getUserId());
        $this->updateParentProgress($progress);
        $err_collection->add(true, 'status_changed', $this->getProgressIdString($progress));
    }

Here is the call graph for this function:

◆ update()

ilObjStudyProgramme::update ( )

Exceptions