ilPRGAssignmentActions.php File Reference

Go to the source code of this file.

Functions
	getProgressIdString (int $node_id)
	getNow ()
	getRefIdFor (int $obj_id)
	recalculateProgressStatus (ilStudyProgrammeSettingsRepository $settings_repo, ilPRGProgress $progress)
	updateParentProgresses (ilStudyProgrammeSettingsRepository $settings_repo, Zipper $zipper)
	updateProgressValidityFromSettings (ilStudyProgrammeValidityOfAchievedQualificationSettings $settings, ilPRGProgress $progress)
	updateProgressDeadlineFromSettings (ilStudyProgrammeDeadlineSettings $settings, ilPRGProgress $progress)
	updateProgressRelevanceFromSettings (ilStudyProgrammeSettingsRepository $settings_repo, ilPRGProgress $pgs)
	applyProgressDeadline (ilStudyProgrammeSettingsRepository $settings_repo, ilPRGProgress $progress, ?int $acting_usr_id=null, bool $recalculate=true)
	resetProgressToSettings (ilStudyProgrammeSettingsRepository $settings_repo, ilPRGProgress $pgs, int $acting_usr_id)
	getZipper ($node_id)
	notifyProgressSuccess (ilPRGProgress $pgs)
	notifyValidityChange (ilPRGProgress $pgs)
	notifyDeadlineChange (ilPRGProgress $pgs)
	notifyScoreChange (ilPRGProgress $pgs)
	notifyProgressRevertSuccess (ilPRGProgress $pgs)
	initAssignmentDates ()
	resetProgresses (ilStudyProgrammeSettingsRepository $settings_repo, int $acting_usr_id)
	markRelevant (ilStudyProgrammeSettingsRepository $settings_repo, int $node_id, int $acting_usr_id, ilPRGMessageCollection $err_collection)
	markNotRelevant (ilStudyProgrammeSettingsRepository $settings_repo, int $node_id, int $acting_usr_id, ilPRGMessageCollection $err_collection)
	markAccredited (ilStudyProgrammeSettingsRepository $settings_repo, ilStudyProgrammeEvents $events, int $node_id, int $acting_usr_id, ilPRGMessageCollection $err_collection)
	unmarkAccredited (ilStudyProgrammeSettingsRepository $settings_repo, int $node_id, int $acting_usr_id, ilPRGMessageCollection $err_collection)
	updatePlanFromRepository (ilStudyProgrammeSettingsRepository $settings_repo, int $acting_usr_id, ilPRGMessageCollection $err_collection)
	succeed (ilStudyProgrammeSettingsRepository $settings_repo, int $node_id, int $triggering_obj_id)
	markProgressesFailedForExpiredDeadline (ilStudyProgrammeSettingsRepository $settings_repo, int $acting_usr_id)
	changeProgressDeadline (ilStudyProgrammeSettingsRepository $settings_repo, int $node_id, int $acting_usr_id, ilPRGMessageCollection $err_collection, ?DateTimeImmutable $deadline)
	changeProgressValidityDate (ilStudyProgrammeSettingsRepository $settings_repo, int $node_id, int $acting_usr_id, ilPRGMessageCollection $err_collection, ?DateTimeImmutable $validity_date)
	changeAmountOfPoints (ilStudyProgrammeSettingsRepository $settings_repo, int $node_id, int $acting_usr_id, ilPRGMessageCollection $err_collection, int $points)
	invalidate (ilStudyProgrammeSettingsRepository $settings_repo)

Variables
trait	ilPRGAssignmentActions
	This trait is for (physical) separation of code only; it is actually just part of an ilPRGAssignment and MUST not be used anywhere else. More...

Function Documentation

applyProgressDeadline()

applyProgressDeadline ( ilStudyProgrammeSettingsRepository  $settings_repo, ilPRGProgress  $progress, ?int  $acting_usr_id = null, bool  $recalculate = true  )

protected

Definition at line 187 of file ilPRGAssignmentActions.php.

References ilPRGProgress\DATE_FORMAT, ilStudyProgrammeSettingsRepository\get(), ilPRGProgress\getDeadline(), ilPRGProgress\getNodeId(), getNow(), ilPRGProgress\getStatus(), ilPRGProgress\markFailed(), ilPRGProgress\markNotFailed(), ilStudyProgrammeSettings\MODE_LP_COMPLETED, notifyProgressRevertSuccess(), recalculateProgressStatus(), ilPRGProgress\STATUS_FAILED, and ilPRGProgress\STATUS_IN_PROGRESS.

Referenced by changeProgressDeadline(), unmarkAccredited(), and updatePlanFromRepository().

     : ilPRGProgress {
        $today = $this->getNow();
        $format = ilPRGProgress::DATE_FORMAT;
        $deadline = $progress->getDeadline();

        if (is_null($acting_usr_id)) {
            throw new Exception('no acting user.');
            $acting_usr_id = $this->getLoggedInUserId(); //TODO !
        }

        switch ($progress->getStatus()) {
            case ilPRGProgress::STATUS_IN_PROGRESS:
                if (!is_null($deadline)
                    && $deadline->format($format) < $today->format($format)
                ) {
                    $progress = $progress->markFailed($this->getNow(), $acting_usr_id);
                    $this->notifyProgressRevertSuccess($progress);
                } else {
                    $node_settings = $settings_repo->get($progress->getNodeId());
                    $completion_mode = $node_settings->getLPMode();
                    if ($recalculate || $completion_mode !== ilStudyProgrammeSettings::MODE_LP_COMPLETED) {
                        $progress = $this->recalculateProgressStatus($settings_repo, $progress);
                    }
                }
                break;

            case ilPRGProgress::STATUS_FAILED:
                if (is_null($deadline)
                    || $deadline->format($format) >= $today->format($format)
                ) {
                    $progress = $progress->markNotFailed($this->getNow(), $acting_usr_id);
                    $this->notifyProgressRevertSuccess($progress);
                }
                break;
        }

        return $progress;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

changeAmountOfPoints()

changeAmountOfPoints	(	ilStudyProgrammeSettingsRepository	$settings_repo,
		int	$node_id,
		int	$acting_usr_id,
		ilPRGMessageCollection	$err_collection,
		int	$points
	)

Definition at line 623 of file ilPRGAssignmentActions.php.

References ilPRGMessageCollection\add(), getNow(), getProgressIdString(), getZipper(), recalculateProgressStatus(), and updateParentProgresses().

     : self {
        $zipper = $this->getZipper($node_id)->modifyFocus(
            function ($pgs) use ($err_collection, $acting_usr_id, $settings_repo, $points): ilPRGProgress {
                if (!$pgs->isRelevant()) {
                    $err_collection->add(false, 'will_not_modify_irrelevant_progress', $this->getProgressIdString($pgs->getNodeId()));
                    return $pgs;
                }
                if ($pgs->isSuccessful()) {
                    $err_collection->add(false, 'will_not_modify_successful_progress', $this->getProgressIdString($pgs->getNodeId()));
                    return $pgs;
                }

                $pgs = $pgs->withAmountOfPoints($points)
                    ->withLastChange($acting_usr_id, $this->getNow())
                    ->withIndividualModifications(true);

                $err_collection->add(true, 'required_points_updated', $this->getProgressIdString($pgs->getNodeId()));
                $pgs = $this->recalculateProgressStatus($settings_repo, $pgs);
                return $pgs;
            }
        );

        $zipper = $this->updateParentProgresses($settings_repo, $zipper);
        return $this->withProgressTree($zipper->getRoot());
    }

Here is the call graph for this function:

changeProgressDeadline()

changeProgressDeadline	(	ilStudyProgrammeSettingsRepository	$settings_repo,
		int	$node_id,
		int	$acting_usr_id,
		ilPRGMessageCollection	$err_collection,
		?DateTimeImmutable	$deadline
	)

Definition at line 555 of file ilPRGAssignmentActions.php.

References ilPRGMessageCollection\add(), applyProgressDeadline(), getNow(), getProgressIdString(), getZipper(), notifyDeadlineChange(), and updateParentProgresses().

     : self {
        $zipper = $this->getZipper($node_id)->modifyFocus(
            function ($pgs) use ($err_collection, $acting_usr_id, $settings_repo, $deadline): ilPRGProgress {
                if (!$pgs->isRelevant()) {
                    $err_collection->add(false, 'will_not_modify_irrelevant_progress', $this->getProgressIdString($pgs->getNodeId()));
                    return $pgs;
                }
                if ($pgs->isSuccessful()) {
                    $err_collection->add(false, 'will_not_modify_deadline_on_successful_progress', $this->getProgressIdString($pgs->getNodeId()));
                    return $pgs;
                }

                $pgs = $pgs->withDeadline($deadline)
                    ->withLastChange($acting_usr_id, $this->getNow())
                    ->withIndividualModifications(true);
                $pgs = $this->applyProgressDeadline($settings_repo, $pgs, $acting_usr_id);
                if ($pgs->isInProgress()) {
                    $this->notifyDeadlineChange($pgs);
                }
                $err_collection->add(true, 'deadline_updated', $this->getProgressIdString($pgs->getNodeId()));
                return $pgs;
            }
        );

        $zipper = $this->updateParentProgresses($settings_repo, $zipper);
        return $this->withProgressTree($zipper->getRoot());
    }

Here is the call graph for this function:

changeProgressValidityDate()

changeProgressValidityDate	(	ilStudyProgrammeSettingsRepository	$settings_repo,
		int	$node_id,
		int	$acting_usr_id,
		ilPRGMessageCollection	$err_collection,
		?DateTimeImmutable	$validity_date
	)

Definition at line 589 of file ilPRGAssignmentActions.php.

References ilPRGMessageCollection\add(), ilPRGProgress\DATE_FORMAT, getNow(), getProgressIdString(), getZipper(), and notifyValidityChange().

     : self {
        $zipper = $this->getZipper($node_id)->modifyFocus(
            function ($pgs) use ($err_collection, $acting_usr_id, $settings_repo, $validity_date): ilPRGProgress {
                if (!$pgs->isRelevant()) {
                    $err_collection->add(false, 'will_not_modify_irrelevant_progress', $this->getProgressIdString($pgs->getNodeId()));
                    return $pgs;
                }
                if (!$pgs->isSuccessful()) {
                    $err_collection->add(false, 'will_not_modify_validity_on_non_successful_progress', $this->getProgressIdString($pgs->getNodeId()));
                    return $pgs;
                }

                $validity = is_null($validity_date) || $validity_date->format(ilPRGProgress::DATE_FORMAT) >= $this->getNow()->format(ilPRGProgress::DATE_FORMAT);
                $pgs = $pgs->withValidityOfQualification($validity_date)
                    ->withLastChange($acting_usr_id, $this->getNow())
                    ->withIndividualModifications(true)
                    ->withInvalidated(!$validity);

                $this->notifyValidityChange($pgs);
                $err_collection->add(true, 'validity_updated', $this->getProgressIdString($pgs->getNodeId()));
                return $pgs;
            }
        );

        //$zipper = $this->updateParentProgresses($settings_repo, $zipper);
        return $this->withProgressTree($zipper->getRoot());
    }

Here is the call graph for this function:

getNow()

getNow ( )

protected

Definition at line 41 of file ilPRGAssignmentActions.php.

Referenced by applyProgressDeadline(), changeAmountOfPoints(), changeProgressDeadline(), changeProgressValidityDate(), invalidate(), markAccredited(), markNotRelevant(), markProgressesFailedForExpiredDeadline(), markRelevant(), recalculateProgressStatus(), resetProgressToSettings(), succeed(), unmarkAccredited(), updateParentProgresses(), and updateProgressValidityFromSettings().

                               : DateTimeImmutable
    {
        return new DateTimeImmutable();
    }

Here is the caller graph for this function:

getProgressIdString()

getProgressIdString ( int  $node_id )

protected

Definition at line 31 of file ilPRGAssignmentActions.php.

References ILIAS\Survey\Mode\getId().

Referenced by changeAmountOfPoints(), changeProgressDeadline(), changeProgressValidityDate(), markAccredited(), markNotRelevant(), markRelevant(), and unmarkAccredited().

                                                        : string
    {
        return sprintf(
            '%s, progress-id (%s/%s)',
            $this->user_info->getFullname(),
            $this->getId(),
            (string) $node_id
        );
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRefIdFor()

getRefIdFor ( int  $obj_id )

protected

Definition at line 46 of file ilPRGAssignmentActions.php.

References ilObject\_getAllReferences().

Referenced by ilObjStudyProgramme\getInstanceByObjId(), and ilObjStudyProgramme\getPrgInstanceByObjId().

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

Here is the call graph for this function:

Here is the caller graph for this function:

getZipper()

getZipper (   $node_id )

protected

Definition at line 265 of file ilPRGAssignmentActions.php.

Referenced by changeAmountOfPoints(), changeProgressDeadline(), changeProgressValidityDate(), initAssignmentDates(), invalidate(), markAccredited(), markNotRelevant(), markProgressesFailedForExpiredDeadline(), markRelevant(), resetProgresses(), succeed(), unmarkAccredited(), and updatePlanFromRepository().

    {
        $progress_path = $this->getProgressForNode($node_id)->getPath();
        $zipper = new Zipper($this->getProgressTree());
        return $zipper = $zipper->toPath($progress_path);
    }

Here is the caller graph for this function:

initAssignmentDates()

initAssignmentDates

(

)

Definition at line 293 of file ilPRGAssignmentActions.php.

References getZipper().

                                         : self
    {
        $zipper = $this->getZipper($this->getRootId());
        $zipper = $zipper->modifyAll(
            fn($pgs) => $pgs->withAssignmentDate($this->getNow())
        );
        return $this->withProgressTree($zipper->getRoot());
    }

Here is the call graph for this function:

invalidate()

invalidate

(

ilStudyProgrammeSettingsRepository

$settings_repo

)

Definition at line 655 of file ilPRGAssignmentActions.php.

References $path, getNow(), ILIAS\StudyProgramme\Assignment\Node\getPath(), getZipper(), and updateParentProgresses().

     : self {
        $zipper = $this->getZipper($this->getRootId());
        $touched = [];
        $now = $this->getNow();

        $zipper = $zipper->modifyAll(
            function ($pgs) use ($now, &$touched): ilPRGProgress {
                if (!$pgs->isSuccessful() || $pgs->hasValidQualification($now)) {
                    return $pgs;
                }
                $touched[] = $pgs->getPath();
                return $pgs->invalidate();
            }
        );

        foreach ($touched as $path) {
            $zipper = $this->updateParentProgresses($settings_repo, $zipper->toPath($path));
        }

        return $this->withProgressTree($zipper->getRoot());
    }

Here is the call graph for this function:

markAccredited()

markAccredited	(	ilStudyProgrammeSettingsRepository	$settings_repo,
		ilStudyProgrammeEvents	$events,
		int	$node_id,
		int	$acting_usr_id,
		ilPRGMessageCollection	$err_collection
	)

Definition at line 374 of file ilPRGAssignmentActions.php.

References ilPRGMessageCollection\add(), ilStudyProgrammeSettingsRepository\get(), getNow(), getProgressIdString(), getZipper(), notifyProgressSuccess(), notifyScoreChange(), ilPRGProgress\STATUS_ACCREDITED, updateParentProgresses(), and updateProgressValidityFromSettings().

     : self {
        $zipper = $this->getZipper($node_id);

        $zipper = $zipper->modifyFocus(
            function ($pgs) use ($err_collection, $acting_usr_id, $settings_repo): ilPRGProgress {
                if (!$pgs->isRelevant()) {
                    $err_collection->add(false, 'will_not_modify_irrelevant_progress', $this->getProgressIdString($pgs->getNodeId()));
                    return $pgs;
                }

                $new_status = ilPRGProgress::STATUS_ACCREDITED;
                if ($pgs->getStatus() === $new_status) {
                    $err_collection->add(false, 'status_unchanged', $this->getProgressIdString($pgs->getNodeId()));
                    return $pgs;
                }
                if (!$pgs->isTransitionAllowedTo($new_status)) {
                    $err_collection->add(false, 'status_transition_not_allowed', $this->getProgressIdString($pgs->getNodeId()));
                    return $pgs;
                }

                $pgs = $pgs
                    ->markAccredited($this->getNow(), $acting_usr_id)
                    ->withCurrentAmountOfPoints($pgs->getAmountOfPoints());
                $this->notifyScoreChange($pgs);

                if (!$pgs->getValidityOfQualification()) {
                    $settings = $settings_repo->get($pgs->getNodeId())->getValidityOfQualificationSettings();
                    $pgs = $this->updateProgressValidityFromSettings($settings, $pgs);
                }

                $this->notifyProgressSuccess($pgs);
                $err_collection->add(true, 'status_changed', $this->getProgressIdString($pgs->getNodeId()));
                return $pgs;
            }
        );

        $zipper = $this->updateParentProgresses($settings_repo, $zipper);
        return $this->withProgressTree($zipper->getRoot());
    }

Here is the call graph for this function:

markNotRelevant()

markNotRelevant	(	ilStudyProgrammeSettingsRepository	$settings_repo,
		int	$node_id,
		int	$acting_usr_id,
		ilPRGMessageCollection	$err_collection
	)

Definition at line 340 of file ilPRGAssignmentActions.php.

References ilPRGMessageCollection\add(), getNow(), getProgressIdString(), getZipper(), ilPRGProgress\STATUS_COMPLETED, and updateParentProgresses().

     : self {
        $zipper = $this->getZipper($node_id);

        if ($zipper->isTop()) {
            $err_collection->add(false, 'will_not_set_top_progress_to_irrelevant', $this->getProgressIdString($node_id));
            return $this;
        }

        $zipper = $zipper->modifyFocus(
            function ($pgs) use ($err_collection, $acting_usr_id): ilPRGProgress {
                if (!$pgs->isRelevant()) {
                    $err_collection->add(false, 'will_not_modify_irrelevant_progress', $this->getProgressIdString($pgs->getNodeId()));
                    return $pgs;
                }
                if ($pgs->getStatus() === ilPRGProgress::STATUS_COMPLETED) {
                    $err_collection->add(false, 'will_not_modify_successful_progress', $this->getProgressIdString($pgs->getNodeId()));
                    return $pgs;
                }

                $pgs = $pgs->markNotRelevant($this->getNow(), $acting_usr_id);
                $err_collection->add(true, 'set_to_irrelevant', $this->getProgressIdString($pgs->getNodeId()));
                return $pgs;
            }
        );

        $zipper = $this->updateParentProgresses($settings_repo, $zipper);
        return $this->withProgressTree($zipper->getRoot());
    }

Here is the call graph for this function:

markProgressesFailedForExpiredDeadline()

markProgressesFailedForExpiredDeadline	(	ilStudyProgrammeSettingsRepository	$settings_repo,
		int	$acting_usr_id
	)

Definition at line 525 of file ilPRGAssignmentActions.php.

References $path, ilPRGProgress\DATE_FORMAT, getNow(), ILIAS\StudyProgramme\Assignment\Node\getPath(), getZipper(), notifyProgressRevertSuccess(), and updateParentProgresses().

     : self {
        $zipper = $this->getZipper($this->getRootId());
        $touched = [];

        $deadline = $this->getNow();
        $zipper = $zipper->modifyAll(
            function ($pgs) use ($acting_usr_id, $deadline, &$touched): ilPRGProgress {
                if (is_null($pgs->getDeadline())
                    || !$pgs->isInProgress()
                    || $pgs->getDeadline()->format(ilPRGProgress::DATE_FORMAT) >= $deadline->format(ilPRGProgress::DATE_FORMAT)
                ) {
                    return $pgs;
                }

                $touched[] = $pgs->getPath();
                $this->notifyProgressRevertSuccess($pgs);
                return $pgs->markFailed($this->getNow(), $acting_usr_id);
            }
        );

        foreach ($touched as $path) {
            $zipper = $this->updateParentProgresses($settings_repo, $zipper->toPath($path));
        }

        return $this->withProgressTree($zipper->getRoot());
    }

Here is the call graph for this function:

markRelevant()

markRelevant	(	ilStudyProgrammeSettingsRepository	$settings_repo,
		int	$node_id,
		int	$acting_usr_id,
		ilPRGMessageCollection	$err_collection
	)

Definition at line 317 of file ilPRGAssignmentActions.php.

References ilPRGMessageCollection\add(), getNow(), getProgressIdString(), getZipper(), recalculateProgressStatus(), and updateParentProgresses().

     : self {
        $zipper = $this->getZipper($node_id)->modifyFocus(
            function ($pgs) use ($err_collection, $acting_usr_id, $settings_repo): ilPRGProgress {
                if ($pgs->isRelevant()) {
                    $err_collection->add(false, 'will_not_modify_relevant_progress', $this->getProgressIdString($pgs->getNodeId()));
                    return $pgs;
                }
                $pgs = $pgs->markRelevant($this->getNow(), $acting_usr_id);
                $err_collection->add(true, 'set_to_relevant', $this->getProgressIdString($pgs->getNodeId()));
                $pgs = $this->recalculateProgressStatus($settings_repo, $pgs);
                return $pgs;
            }
        );

        $zipper = $this->updateParentProgresses($settings_repo, $zipper);
        return $this->withProgressTree($zipper->getRoot());
    }

Here is the call graph for this function:

notifyDeadlineChange()

notifyDeadlineChange ( ilPRGProgress  $pgs )

protected

Definition at line 280 of file ilPRGAssignmentActions.php.

References ilPRGProgress\getNodeId().

Referenced by changeProgressDeadline(), and updateProgressDeadlineFromSettings().

                                                               : void
    {
        $this->getEvents()->deadlineChange($this, $pgs->getNodeId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

notifyProgressRevertSuccess()

notifyProgressRevertSuccess ( ilPRGProgress  $pgs )

protected

Definition at line 288 of file ilPRGAssignmentActions.php.

References ilPRGProgress\getNodeId().

Referenced by applyProgressDeadline(), markProgressesFailedForExpiredDeadline(), recalculateProgressStatus(), and unmarkAccredited().

                                                                      : void
    {
        $this->getEvents()->userRevertSuccessful($this, $pgs->getNodeId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

notifyProgressSuccess()

notifyProgressSuccess ( ilPRGProgress  $pgs )

protected

Definition at line 272 of file ilPRGAssignmentActions.php.

References ilPRGProgress\getNodeId().

Referenced by markAccredited(), recalculateProgressStatus(), and succeed().

                                                                : void
    {
        $this->getEvents()->userSuccessful($this, $pgs->getNodeId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

notifyScoreChange()

notifyScoreChange ( ilPRGProgress  $pgs )

protected

Definition at line 284 of file ilPRGAssignmentActions.php.

References ilPRGProgress\getNodeId().

Referenced by markAccredited(), recalculateProgressStatus(), resetProgressToSettings(), succeed(), and unmarkAccredited().

                                                            : void
    {
        $this->getEvents()->scoreChange($this, $pgs->getNodeId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

notifyValidityChange()

notifyValidityChange ( ilPRGProgress  $pgs )

protected

Definition at line 276 of file ilPRGAssignmentActions.php.

References ilPRGProgress\getNodeId().

Referenced by changeProgressValidityDate(), recalculateProgressStatus(), resetProgressToSettings(), and updateProgressValidityFromSettings().

                                                               : void
    {
        $this->getEvents()->validityChange($this, $pgs->getNodeId());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

recalculateProgressStatus()

recalculateProgressStatus ( ilStudyProgrammeSettingsRepository  $settings_repo, ilPRGProgress  $progress  )

protected

Definition at line 55 of file ilPRGAssignmentActions.php.

References ilPRGProgress\COMPLETED_BY_SUBNODES, ilStudyProgrammeSettingsRepository\get(), ilPRGProgress\getAchievedPointsOfChildren(), ilPRGProgress\getAmountOfPoints(), ilPRGProgress\getNodeId(), getNow(), ilPRGProgress\getStatus(), ilPRGProgress\getValidityOfQualification(), ilPRGProgress\isRelevant(), ilPRGProgress\isSuccessful(), ilStudyProgrammeSettings\MODE_LP_COMPLETED, ilStudyProgrammeSettings\MODE_POINTS, ilStudyProgrammeSettings\MODE_UNDEFINED, notifyProgressRevertSuccess(), notifyProgressSuccess(), notifyScoreChange(), notifyValidityChange(), null, ilPRGProgress\STATUS_ACCREDITED, ilPRGProgress\STATUS_COMPLETED, ilPRGProgress\STATUS_IN_PROGRESS, updateProgressValidityFromSettings(), ilPRGProgress\withCurrentAmountOfPoints(), and ilPRGProgress\withStatus().

Referenced by applyProgressDeadline(), changeAmountOfPoints(), markRelevant(), and updateParentProgresses().

     : ilPRGProgress {
        if (!$progress->isRelevant()) {
            return $progress;
        }
        $node_settings = $settings_repo->get($progress->getNodeId());
        $completion_mode = $node_settings->getLPMode();

        switch ($completion_mode) {
            case ilStudyProgrammeSettings::MODE_UNDEFINED:
            case ilStudyProgrammeSettings::MODE_LP_COMPLETED:
                return $progress;
                break;
            case ilStudyProgrammeSettings::MODE_POINTS:
                $completing_crs_id = ilPRGProgress::COMPLETED_BY_SUBNODES;
                $achieved_points = $progress->getAchievedPointsOfChildren();
                break;
        }

        $progress = $progress->withCurrentAmountOfPoints($achieved_points);
        $this->notifyScoreChange($progress);

        $required_points = $progress->getAmountOfPoints();
        $successful = ($achieved_points >= $required_points);

        if ($successful && !$progress->isSuccessful()) {
            $progress = $progress
                ->withStatus(ilPRGProgress::STATUS_COMPLETED)
                ->withCompletion($completing_crs_id, $this->getNow());

            if (!$progress->getValidityOfQualification()) {
                $settings = $settings_repo->get($progress->getNodeId())->getValidityOfQualificationSettings();
                $progress = $this->updateProgressValidityFromSettings($settings, $progress);
            }
            $this->notifyProgressSuccess($progress);
        }

        if (!$successful && $progress->isSuccessful()
            && $progress->getStatus() !== ilPRGProgress::STATUS_ACCREDITED
        ) {
            $progress = $progress
                ->withStatus(ilPRGProgress::STATUS_IN_PROGRESS)
                ->withCompletion(null, null)
                ->withValidityOfQualification(null);

            $this->notifyValidityChange($progress);
            $this->notifyProgressRevertSuccess($progress);
        }

        return $progress;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

resetProgresses()

resetProgresses	(	ilStudyProgrammeSettingsRepository	$settings_repo,
		int	$acting_usr_id
	)

Definition at line 302 of file ilPRGAssignmentActions.php.

References getZipper(), resetProgressToSettings(), and updateProgressRelevanceFromSettings().

     : self {
        $zipper = $this->getZipper($this->getRootId());
        $zipper = $zipper->modifyAll(
            function ($pgs) use ($acting_usr_id, $settings_repo): ilPRGProgress {
                $pgs = $this->updateProgressRelevanceFromSettings($settings_repo, $pgs);
                $pgs = $this->resetProgressToSettings($settings_repo, $pgs, $acting_usr_id);
                return $pgs;
            }
        );
        return $this->withProgressTree($zipper->getRoot());
    }

Here is the call graph for this function:

resetProgressToSettings()

resetProgressToSettings ( ilStudyProgrammeSettingsRepository  $settings_repo, ilPRGProgress  $pgs, int  $acting_usr_id  )

protected

Definition at line 232 of file ilPRGAssignmentActions.php.

References ilStudyProgrammeSettingsRepository\get(), ilPRGProgress\getAmountOfPoints(), ilPRGProgress\getNodeId(), getNow(), ilPRGProgress\isRelevant(), ilPRGProgress\isSuccessful(), notifyScoreChange(), notifyValidityChange(), null, updateProgressDeadlineFromSettings(), updateProgressValidityFromSettings(), ilPRGProgress\withAmountOfPoints(), ilPRGProgress\withCurrentAmountOfPoints(), and ilPRGProgress\withValidityOfQualification().

Referenced by resetProgresses(), and updatePlanFromRepository().

     : ilPRGProgress {
        $settings = $settings_repo->get($pgs->getNodeId());
        if ($pgs->isRelevant()) {
            $pgs = $this->updateProgressValidityFromSettings($settings->getValidityOfQualificationSettings(), $pgs);
            $pgs = $this->updateProgressDeadlineFromSettings($settings->getDeadlineSettings(), $pgs);
        } else {
            $pgs = $pgs
                ->withValidityOfQualification(null)
                ->withDeadline(null);
            $this->notifyValidityChange($pgs);
        }

        $pgs = $pgs
            ->withAmountOfPoints($settings->getAssessmentSettings()->getPoints())
            ->withLastChange($acting_usr_id, $this->getNow())
            ->withIndividualModifications(false);

        if ($pgs->isSuccessful()) {
            $pgs = $pgs->withCurrentAmountOfPoints($pgs->getAmountOfPoints());
            $this->notifyScoreChange($pgs);
        }

        return $pgs;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

succeed()

succeed	(	ilStudyProgrammeSettingsRepository	$settings_repo,
		int	$node_id,
		int	$triggering_obj_id
	)

Definition at line 495 of file ilPRGAssignmentActions.php.

References ilPRGProgress\DATE_FORMAT, ilStudyProgrammeSettingsRepository\get(), ilPRGProgress\getDeadline(), getNow(), getZipper(), notifyProgressSuccess(), notifyScoreChange(), updateParentProgresses(), and updateProgressValidityFromSettings().

     : self {
        $zipper = $this->getZipper($node_id)->modifyFocus(
            function ($pgs) use ($settings_repo, $triggering_obj_id): ilPRGProgress {
                $deadline = $pgs->getDeadline();
                $format = ilPRGProgress::DATE_FORMAT;
                $now = $this->getNow();
                if ($pgs->isInProgress() &&
                    (is_null($deadline) || $deadline->format($format) >= $now->format($format))
                ) {
                    $pgs = $pgs->succeed($now, $triggering_obj_id)
                        ->withCurrentAmountOfPoints($pgs->getAmountOfPoints());
                    $this->notifyScoreChange($pgs);
                    $settings = $settings_repo->get($pgs->getNodeId())->getValidityOfQualificationSettings();
                    $pgs = $this->updateProgressValidityFromSettings($settings, $pgs);
                }

                $this->notifyProgressSuccess($pgs);
                return $pgs;
            }
        );

        $zipper = $this->updateParentProgresses($settings_repo, $zipper);
        return $this->withProgressTree($zipper->getRoot());
    }

Here is the call graph for this function:

unmarkAccredited()

unmarkAccredited	(	ilStudyProgrammeSettingsRepository	$settings_repo,
		int	$node_id,
		int	$acting_usr_id,
		ilPRGMessageCollection	$err_collection
	)

Definition at line 421 of file ilPRGAssignmentActions.php.

References ilPRGMessageCollection\add(), applyProgressDeadline(), getNow(), getProgressIdString(), getZipper(), notifyProgressRevertSuccess(), notifyScoreChange(), ilPRGProgress\STATUS_COMPLETED, ilPRGProgress\STATUS_IN_PROGRESS, and updateParentProgresses().

     : self {
        $zipper = $this->getZipper($node_id);

        $zipper = $zipper->modifyFocus(
            function ($pgs) use ($err_collection, $acting_usr_id, $settings_repo): ilPRGProgress {
                if (!$pgs->isRelevant()) {
                    $err_collection->add(false, 'will_not_modify_irrelevant_progress', $this->getProgressIdString($pgs->getNodeId()));
                    return $pgs;
                }

                $new_status = ilPRGProgress::STATUS_IN_PROGRESS;
                if ($pgs->getStatus() === $new_status) {
                    $err_collection->add(false, 'status_unchanged', $this->getProgressIdString($pgs->getNodeId()));
                    return $pgs;
                }
                if (!$pgs->isTransitionAllowedTo($new_status)
                    //special case: completion may not be revoked manually (but might be as a calculation-result of underlying progresses)
                    || $pgs->getStatus() === ilPRGProgress::STATUS_COMPLETED
                ) {
                    $err_collection->add(false, 'status_transition_not_allowed', $this->getProgressIdString($pgs->getNodeId()));
                    return $pgs;
                }

                $pgs = $pgs
                    ->unmarkAccredited($this->getNow(), $acting_usr_id)
                    ->withCurrentAmountOfPoints($pgs->getAchievedPointsOfChildren());
                $this->notifyScoreChange($pgs);

                $old_status = $pgs->getStatus();
                $pgs = $this->applyProgressDeadline($settings_repo, $pgs, $acting_usr_id);
                if ($pgs->getStatus() !== $old_status) {
                    $err_collection->add(false, 'status_changed_due_to_deadline', $this->getProgressIdString($pgs->getNodeId()));
                } else {
                    $err_collection->add(true, 'status_changed', $this->getProgressIdString($pgs->getNodeId()));
                }
                $this->notifyProgressRevertSuccess($pgs);
                return $pgs;
            }
        );

        $zipper = $this->updateParentProgresses($settings_repo, $zipper);
        return $this->withProgressTree($zipper->getRoot());
    }

Here is the call graph for this function:

updateParentProgresses()

updateParentProgresses ( ilStudyProgrammeSettingsRepository  $settings_repo, Zipper  $zipper  )

protected

Definition at line 109 of file ilPRGAssignmentActions.php.

References ilPRGProgress\DATE_FORMAT, getNow(), ILIAS\StudyProgramme\Assignment\Zipper\isTop(), recalculateProgressStatus(), and ILIAS\StudyProgramme\Assignment\Zipper\toParent().

Referenced by changeAmountOfPoints(), changeProgressDeadline(), invalidate(), markAccredited(), markNotRelevant(), markProgressesFailedForExpiredDeadline(), markRelevant(), succeed(), unmarkAccredited(), and updatePlanFromRepository().

     : Zipper {
        while (!$zipper->isTop()) {
            $zipper = $zipper->toParent()
                ->modifyFocus(
                    function ($pgs) use ($settings_repo) {
                        $today = $this->getNow();
                        $format = ilPRGProgress::DATE_FORMAT;
                        $deadline = $pgs->getDeadline();
                        if (!is_null($deadline)
                            && $deadline->format($format) <= $today->format($format)
                        ) {
                            return $pgs;
                        }
                        return $this->recalculateProgressStatus($settings_repo, $pgs);
                    }
                );
        }
        return $zipper;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updatePlanFromRepository()

updatePlanFromRepository	(	ilStudyProgrammeSettingsRepository	$settings_repo,
		int	$acting_usr_id,
		ilPRGMessageCollection	$err_collection
	)

Definition at line 470 of file ilPRGAssignmentActions.php.

References $path, applyProgressDeadline(), getZipper(), resetProgressToSettings(), updateParentProgresses(), and updateProgressRelevanceFromSettings().

     : self {
        $zipper = $this->getZipper($this->getRootId());
        $leafs = [];
        $zipper = $zipper->modifyAll(
            function ($pgs) use ($err_collection, $acting_usr_id, $settings_repo, &$leafs): ilPRGProgress {
                $pgs = $this->updateProgressRelevanceFromSettings($settings_repo, $pgs);
                $pgs = $this->resetProgressToSettings($settings_repo, $pgs, $acting_usr_id);
                $pgs = $this->applyProgressDeadline($settings_repo, $pgs, $acting_usr_id, false);
                if (!$pgs->getSubnodes()) {
                    $leafs[] = $pgs->getPath();
                }
                return $pgs;
            }
        );

        foreach ($leafs as $path) {
            $zipper = $this->updateParentProgresses($settings_repo, $zipper->toPath($path));
        }
        return $this->withProgressTree($zipper->getRoot());
    }

Here is the call graph for this function:

updateProgressDeadlineFromSettings()

updateProgressDeadlineFromSettings ( ilStudyProgrammeDeadlineSettings  $settings, ilPRGProgress  $progress  )

protected

Definition at line 155 of file ilPRGAssignmentActions.php.

References ilPRGProgress\getAssignmentDate(), ilStudyProgrammeDeadlineSettings\getDeadlineDate(), ilStudyProgrammeDeadlineSettings\getDeadlinePeriod(), notifyDeadlineChange(), and ilPRGProgress\withDeadline().

Referenced by resetProgressToSettings().

     : ilPRGProgress {
        $period = $settings->getDeadlinePeriod();
        $date = $settings->getDeadlineDate();

        if ($period) {
            $date = $progress->getAssignmentDate();
            $date = $date->add(new DateInterval('P' . $period . 'D'));
        }
        $this->notifyDeadlineChange($progress);
        return $progress->withDeadline($date);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateProgressRelevanceFromSettings()

updateProgressRelevanceFromSettings ( ilStudyProgrammeSettingsRepository  $settings_repo, ilPRGProgress  $pgs  )

protected

Definition at line 170 of file ilPRGAssignmentActions.php.

References ilStudyProgrammeSettingsRepository\get(), ilPRGProgress\getNodeId(), ilPRGProgress\isInProgress(), ilPRGProgress\isRelevant(), ilStudyProgrammeSettings\STATUS_ACTIVE, ilPRGProgress\STATUS_IN_PROGRESS, ilPRGProgress\STATUS_NOT_RELEVANT, and ilPRGProgress\withStatus().

Referenced by resetProgresses(), and updatePlanFromRepository().

     : ilPRGProgress {
        $programme_status = $settings_repo->get($pgs->getNodeId())->getAssessmentSettings()->getStatus();
        $active = $programme_status === ilStudyProgrammeSettings::STATUS_ACTIVE;

        if ($active && !$pgs->isRelevant()) {
            $pgs = $pgs->withStatus(ilPRGProgress::STATUS_IN_PROGRESS);
        }
        if (!$active && $pgs->isInProgress()) {
            $pgs = $pgs->withStatus(ilPRGProgress::STATUS_NOT_RELEVANT);
        }
        return $pgs;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

updateProgressValidityFromSettings()

updateProgressValidityFromSettings ( ilStudyProgrammeValidityOfAchievedQualificationSettings  $settings, ilPRGProgress  $progress  )

protected

Definition at line 132 of file ilPRGAssignmentActions.php.

References ilPRGProgress\DATE_FORMAT, ilPRGProgress\getCompletionDate(), getNow(), ilStudyProgrammeValidityOfAchievedQualificationSettings\getQualificationDate(), ilStudyProgrammeValidityOfAchievedQualificationSettings\getQualificationPeriod(), ilPRGProgress\isSuccessful(), notifyValidityChange(), and ilPRGProgress\withValidityOfQualification().

Referenced by markAccredited(), recalculateProgressStatus(), resetProgressToSettings(), and succeed().

     : ilPRGProgress {
        $cdate = $progress->getCompletionDate();
        if (!$cdate
            || $progress->isSuccessful() === false
        ) {
            return $progress;
        }
        $period = $settings->getQualificationPeriod();
        $date = $settings->getQualificationDate();

        if ($period) {
            $date = $cdate->add(new DateInterval('P' . $period . 'D'));
        }

        $validity = is_null($date) || $date->format(ilPRGProgress::DATE_FORMAT) >= $this->getNow()->format(ilPRGProgress::DATE_FORMAT);
        $this->notifyValidityChange($progress);
        return $progress->withValidityOfQualification($date)
            ->withInvalidated(!$validity);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

Variable Documentation

ilPRGAssignmentActions

trait ilPRGAssignmentActions

Initial value:

{
    abstract public function getEvents(): StudyProgrammeEvents

This trait is for (physical) separation of code only; it is actually just part of an ilPRGAssignment and MUST not be used anywhere else.

Definition at line 28 of file ilPRGAssignmentActions.php.