Represents the progress of a user at one node of a study programme. More...

Collaboration diagram for ilStudyProgrammeUserProgress:

Public Member Functions
	__construct (ilStudyProgrammeProgress $progress, ilStudyProgrammeProgressRepository $progress_repository, ilStudyProgrammeAssignmentRepository $assignment_repository, ilStudyProgrammeEvents $events)

	getStudyProgramme ()
	Get the program node this progress belongs to. More...

	getAssignmentId ()
	Get the assignment this progress belongs to. More...

	getId ()
	Get the id of the progress. More...

	getNodeId ()
	Get the id of the program node the progress belongs to. More...

	getUserId ()
	Get the id of the user who is assigned. More...

	getStatus ()
	Get the status of the progress. More...

	getAmountOfPoints ()
	Get the amount of points needed to complete the node. More...

	getCurrentAmountOfPoints ()
	Get the amount of points the user currently achieved. More...

	getLastChange ()
	Get the timestamp when the last change was made on this progress. More...

	getLastChangeBy ()
	Get the id of the user who did the last change on this progress. More...

	getCompletionBy ()
	Get the id of the user or course that lead to completion of this node. More...

	getAssignmentDate ()
	Get the assignment date of this node. More...

	getCompletionDate ()
	Get the completion date of this node. More...

	getDeadline ()
	Get the deadline of this node. More...

	setDeadline (DateTime $deadline=null)
	Set the deadline of this node. More...

	getValidityOfQualification ()
	Get validity of qualification. More...

	setValidityOfQualification (DateTime $date=null)
	Set validity of qualification. More...

	storeProgress ()

	delete ()
	Delete the assignment from database. More...

	markAccredited (int $user_id)
	Mark this progress as accredited. More...

	unmarkAccredited ()
	Set the node to in progress. More...

	markFailed (int $a_user_id)
	Mark this progress as failed. More...

	invalidate ()
	Mark this progress as failed. More...

	isInvalidated ()

	isSuccessfulExpired ()
	Check, whether a the course is passed and expired due to limited validity. More...

	markNotFailed (int $user_id)
	Set the node to in progress. More...

	markNotRelevant (int $user_id)
	Set the node to be not relevant for the user. More...

	markRelevant (int $user_id)
	Set the node to be relevant for the user. More...

	setRequiredAmountOfPoints (int $a_points, int $user_id)
	Set the amount of points the user is required to have to complete this node. More...

	getMaximumPossibleAmountOfPoints (bool $only_relevant=false)
	Get the maximum possible amount of points a user can achieve for the completion of this node. More...

	canBeCompleted ()
	Check whether the user can achieve enough points on the subnodes to be able to complete this node. More...

	hasIndividualModifications ()
	Check whether there are individual modifications for the user on this program. More...

	isSuccessful ()
	Check whether the user was successful on this node. More...

	isFailed ()
	Check whether user as failed on this node. More...

	recalculateFailedToDeadline ()
	Recalculates the status according to deadline. More...

	isAccredited ()
	Check whether the user was accredited on this node. More...

	isRelevant ()
	Check whether this node is relevant for the user. More...

	updateFromProgramNode ()
	Update the progress from its program node. More...

	setLPCompleted (int $obj_id, int $usr_id)
	Set this node to be completed due to a completed learning progress. More...

	getChildrenProgress ()
	Get the progresses on the child nodes of this node for the same assignment this progress belongs to. More...

	getNamesOfCompletedOrAccreditedChildren ()
	Get a list with the names of the children of this node that a were completed or accredited for the given assignment. More...

	updateProgress (int $user_id)
	Updates current progress. More...

	informUserForRiskToFail ()

	hasSuccessStatus ()

Static Public Member Functions
static	getPossibleActions (int $node_id, int $root_prg_id, int $status)
	Get a list with possible actions on a progress record. More...

Data Fields
const	ACTION_MARK_ACCREDITED = "mark_accredited"

const	ACTION_UNMARK_ACCREDITED = "unmark_accredited"

const	ACTION_SHOW_INDIVIDUAL_PLAN = "show_individual_plan"

const	ACTION_REMOVE_USER = "remove_user"

const	ACTION_CHANGE_EXPIRE_DATE = "change_expire_date"

const	ACTION_CHANGE_DEADLINE = "change_deadline"

Protected Member Functions
	updateStatus ()
	Updates the status of this progress based on the status of the progress on the sub nodes. More...

	hasSuccessfullChildren ()

	updateParentStatus ()
	Update the status of the parent of this node. More...

	maybeLimitProgressValidity (ilObjStudyProgramme $prg, ilStudyProgrammeAssignment $assignment)

	getParentProgresses ()
	Get the progress on the parent node for the same assignment this progress belongs to. More...

	refreshLPStatus ()

Protected Attributes
	$progress

	$progress_repository

	$assignment_repository

	$events

Detailed Description

Represents the progress of a user at one node of a study programme.

A user could have multiple progress' on one node, since he could also have multiple assignments to one node.

Definition at line 14 of file class.ilStudyProgrammeUserProgress.php.

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeUserProgress::__construct	(	ilStudyProgrammeProgress	$progress,
		ilStudyProgrammeProgressRepository	$progress_repository,
		ilStudyProgrammeAssignmentRepository	$assignment_repository,
		ilStudyProgrammeEvents	$events
	)

Definition at line 43 of file class.ilStudyProgrammeUserProgress.php.

References $assignment_repository, $events, $progress, and $progress_repository.

       {
         $this->progress = $progress;
         $this->progress_repository = $progress_repository;
         $this->assignment_repository = $assignment_repository;
         $this->events = $events;
     }

Member Function Documentation

◆ canBeCompleted()

ilStudyProgrammeUserProgress::canBeCompleted ( )

Check whether the user can achieve enough points on the subnodes to be able to complete this node.

Exceptions

ilException

Definition at line 519 of file class.ilStudyProgrammeUserProgress.php.

References $progress, getAmountOfPoints(), getChildrenProgress(), getMaximumPossibleAmountOfPoints(), getStudyProgramme(), and ilStudyProgrammeSettings\MODE_LP_COMPLETED.

Referenced by ilStudyProgrammeIndividualPlanProgressListGUI\buildProgressStatus().

                                      : bool
     {
         $prg = $this->getStudyProgramme();
 
         if ($prg->getLPMode() == ilStudyProgrammeSettings::MODE_LP_COMPLETED) {
             return true;
         }
 
         if ($this->getMaximumPossibleAmountOfPoints(true) < $this->getAmountOfPoints()) {
             // Fast track
             return false;
         }
 
         $children_progress = $this->getChildrenProgress();
         foreach ($children_progress as $progress) {
             if ($progress->isRelevant() && !$progress->canBeCompleted()) {
                 return false;
             }
         }
 
         return true;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ delete()

ilStudyProgrammeUserProgress::delete ( )

Delete the assignment from database.

Definition at line 224 of file class.ilStudyProgrammeUserProgress.php.

                              : void
     {
         $this->progress_repository->delete($this->progress);
     }

◆ getAmountOfPoints()

ilStudyProgrammeUserProgress::getAmountOfPoints ( )

Get the amount of points needed to complete the node.

This is the amount of points yielded for the completion of the node above as well.

Definition at line 122 of file class.ilStudyProgrammeUserProgress.php.

Referenced by ilStudyProgrammeProgressListGUI\buildProgressBar(), ilStudyProgrammeProgressListGUI\buildProgressStatus(), ilStudyProgrammeProgressListGUI\buildToolTip(), canBeCompleted(), getCurrentAmountOfPoints(), getMaximumPossibleAmountOfPoints(), and updateStatus().

                                         : int
     {
         return $this->progress->getAmountOfPoints();
     }

Here is the caller graph for this function:

◆ getAssignmentDate()

ilStudyProgrammeUserProgress::getAssignmentDate ( )

Get the assignment date of this node.

Definition at line 169 of file class.ilStudyProgrammeUserProgress.php.

                                         : DateTime
     {
         return $this->progress->getAssignmentDate();
     }

◆ getAssignmentId()

ilStudyProgrammeUserProgress::getAssignmentId ( )

Get the assignment this progress belongs to.

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

Referenced by markAccredited(), setLPCompleted(), updateStatus(), ilStudyProgrammeEvents\userRiskyToFail(), and ilStudyProgrammeEvents\userSuccessful().

                                       : int
     {
         return $this->progress->getAssignmentId();
     }

Here is the caller graph for this function:

◆ getChildrenProgress()

ilStudyProgrammeUserProgress::getChildrenProgress ( )

Get the progresses on the child nodes of this node for the same assignment this progress belongs to.

Exceptions

ilException

Returns: ilStudyProgrammeUserProgress[]

Definition at line 859 of file class.ilStudyProgrammeUserProgress.php.

References getStudyProgramme(), and ilStudyProgrammeSettings\MODE_LP_COMPLETED.

Referenced by canBeCompleted(), hasSuccessfullChildren(), and updateStatus().

                                           : array
     {
         $prg = $this->getStudyProgramme();
         if ($prg->getLPMode() == ilStudyProgrammeSettings::MODE_LP_COMPLETED) {
             throw new ilException(
                 "ilStudyProgrammeUserProgress::getChildrenProgress: "
                 . "There is some problem in the implementation. This "
                 . "method should only be callled for nodes in points "
                 . "mode."
             );
         }
 
         $ass_id = $this->progress->getAssignmentId();
 
         return array_map(function ($child) use ($ass_id) {
             return $child->getProgressForAssignment($ass_id);
         }, $prg->getChildren(true));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getCompletionBy()

ilStudyProgrammeUserProgress::getCompletionBy ( )

Get the id of the user or course that lead to completion of this node.

Definition at line 161 of file class.ilStudyProgrammeUserProgress.php.

     {
         return $this->progress->getCompletionBy();
     }

◆ getCompletionDate()

ilStudyProgrammeUserProgress::getCompletionDate ( )

Get the completion date of this node.

Definition at line 177 of file class.ilStudyProgrammeUserProgress.php.

Referenced by ilStudyProgrammeMailTemplateContext\getNewestProgressForUser().

                                         : ?DateTime
     {
         return $this->progress->getCompletionDate();
     }

Here is the caller graph for this function:

◆ getCurrentAmountOfPoints()

ilStudyProgrammeUserProgress::getCurrentAmountOfPoints ( )

Get the amount of points the user currently achieved.

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

References getAmountOfPoints(), getStudyProgramme(), isAccredited(), and isSuccessful().

Referenced by ilStudyProgrammeProgressListGUI\buildProgressBar(), ilStudyProgrammeProgressListGUI\buildProgressStatus(), and ilStudyProgrammeProgressListGUI\buildToolTip().

                                                : int
     {
         if (
             $this->isAccredited() ||
             ($this->isSuccessful() && $this->getStudyProgramme()->hasLPChildren())
         ) {
             return $this->getAmountOfPoints();
         }
 
         return $this->progress->getCurrentAmountOfPoints();
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getDeadline()

ilStudyProgrammeUserProgress::getDeadline ( )

Get the deadline of this node.

Definition at line 185 of file class.ilStudyProgrammeUserProgress.php.

Referenced by recalculateFailedToDeadline().

     {
         return $this->progress->getDeadline();
     }

Here is the caller graph for this function:

◆ getId()

ilStudyProgrammeUserProgress::getId ( )

Get the id of the progress.

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

Referenced by ilStudyProgrammeProgressListGUI\buildProgressBar(), getParentProgresses(), ilStudyProgrammeProgressListGUI\getTitleAndIconTarget(), refreshLPStatus(), ilObjStudyProgrammeIndividualPlanGUI\updateDeadline(), and ilStudyProgrammeEvents\userRiskyToFail().

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

Here is the caller graph for this function:

◆ getLastChange()

ilStudyProgrammeUserProgress::getLastChange ( )

Get the timestamp when the last change was made on this progress.

Definition at line 145 of file class.ilStudyProgrammeUserProgress.php.

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

◆ getLastChangeBy()

ilStudyProgrammeUserProgress::getLastChangeBy ( )

Get the id of the user who did the last change on this progress.

Definition at line 153 of file class.ilStudyProgrammeUserProgress.php.

Referenced by hasIndividualModifications().

                                       : ?int
     {
         return $this->progress->getLastChangeBy();
     }

Here is the caller graph for this function:

◆ getMaximumPossibleAmountOfPoints()

ilStudyProgrammeUserProgress::getMaximumPossibleAmountOfPoints ( bool $only_relevant = false )

Get the maximum possible amount of points a user can achieve for the completion of this node.

If the program node runs in LP-mode this will be equal getAmountOfPoints.

TODO: Maybe caching this value would be a good idea.

Exceptions

ilException

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

References Vendor\Package\$a, Vendor\Package\$b, getAmountOfPoints(), getStudyProgramme(), and ilStudyProgrammeSettings\MODE_LP_COMPLETED.

Referenced by ilStudyProgrammeProgressListGUI\buildProgressBar(), ilStudyProgrammeProgressListGUI\buildProgressStatus(), and canBeCompleted().

                                                                                   : int
     {
         $prg = $this->getStudyProgramme();
         if ($prg->getLPMode() == ilStudyProgrammeSettings::MODE_LP_COMPLETED) {
             return $this->getAmountOfPoints();
         }
 
         $children = $prg->getChildren();
         $ass = $this->progress->getAssignmentId();
         $points = array_map(function ($child) use ($ass, $only_relevant) {
             $relevant = $child->getProgressForAssignment($ass)->isRelevant();
             if ($only_relevant) {
                 if ($relevant) {
                     return $child->getProgressForAssignment($ass)->getAmountOfPoints();
                 } else {
                     return 0;
                 }
             } else {
                 return $child->getProgressForAssignment($ass)->getAmountOfPoints();
             }
         }, $children);
 
         return array_reduce($points, function ($a, $b) {
             return $a + $b;
         }, 0);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getNamesOfCompletedOrAccreditedChildren()

ilStudyProgrammeUserProgress::getNamesOfCompletedOrAccreditedChildren ( )

Get a list with the names of the children of this node that a were completed or accredited for the given assignment.

Exceptions

ilException

Returns: string[]

Definition at line 885 of file class.ilStudyProgrammeUserProgress.php.

References getStudyProgramme().

                                                               : array
     {
         $prg = $this->getStudyProgramme();
         $children = $prg->getChildren(true);
         $ass_id = $this->progress->getAssignmentId();
         $names = array();
 
         foreach ($children as $child) {
             $prgrs = $child->getProgressForAssignment($ass_id);
             if (!$prgrs->isSuccessful()) {
                 continue;
             }
             $names[] = $child->getTitle();
         }
 
         return $names;
     }

Here is the call graph for this function:

◆ getNodeId()

ilStudyProgrammeUserProgress::getNodeId ( )

Get the id of the program node the progress belongs to.

Definition at line 97 of file class.ilStudyProgrammeUserProgress.php.

                                 : int
     {
         return $this->progress->getNodeId();
     }

◆ getParentProgresses()

ilStudyProgrammeUserProgress::getParentProgresses ( )

protected

Get the progress on the parent node for the same assignment this progress belongs to.

Exceptions

ilException

Returns: ilStudyProgrammeUserProgress[]

Definition at line 826 of file class.ilStudyProgrammeUserProgress.php.

References getId(), and getStudyProgramme().

Referenced by updateParentStatus().

                                              : array
     {
         if ($this->getStudyProgramme()->getId() == $this->assignment_repository->read($this->getAssignmentId())->getRootId()) {
             return [];
         }
 
         $overall_parents = [];
         $prg = $this->getStudyProgramme();
         $parent = $prg->getParent();
 
         if ($parent) {
             $overall_parents[] = $parent;
         }
 
         foreach ($prg->getReferencesToSelf() as $ref) {
             $overall_parents[] = $ref->getParent();
         }
 
         return array_map(
             function ($parent) {
                 return $parent->getProgressForAssignment($this->progress->getAssignmentId());
             },
             $overall_parents
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPossibleActions()

static ilStudyProgrammeUserProgress::getPossibleActions	(	int	$node_id,
		int	$root_prg_id,
		int	$status
	)

static

Get a list with possible actions on a progress record.

Returns: string[]

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

References ilStudyProgrammeProgress\STATUS_ACCREDITED, and ilStudyProgrammeProgress\STATUS_IN_PROGRESS.

Referenced by ilStudyProgrammeMembersTableGUI\fetchData(), and ilStudyProgrammeUserProgressTest\testPossibleActions().

       : array {
         $actions = array();
 
         if ($node_id == $root_prg_id) {
             $actions[] = self::ACTION_SHOW_INDIVIDUAL_PLAN;
             $actions[] = self::ACTION_REMOVE_USER;
         }
 
         if ($status == ilStudyProgrammeProgress::STATUS_ACCREDITED) {
             $actions[] = self::ACTION_UNMARK_ACCREDITED;
         } elseif ($status == ilStudyProgrammeProgress::STATUS_IN_PROGRESS) {
             $actions[] = self::ACTION_MARK_ACCREDITED;
         }
 
         return $actions;
     }

Here is the caller graph for this function:

◆ getStatus()

ilStudyProgrammeUserProgress::getStatus ( )

Get the status of the progress.

Definition at line 113 of file class.ilStudyProgrammeUserProgress.php.

Referenced by hasSuccessStatus(), invalidate(), isAccredited(), isFailed(), isRelevant(), isSuccessful(), markAccredited(), markFailed(), updateFromProgramNode(), and updateStatus().

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

Here is the caller graph for this function:

◆ getStudyProgramme()

ilStudyProgrammeUserProgress::getStudyProgramme ( )

Get the program node this progress belongs to.

Throws when the according program has no ref id.

TODO: I'm quite sure, this will profit from caching.

Exceptions

ilException

Definition at line 64 of file class.ilStudyProgrammeUserProgress.php.

References ilObject\_getAllReferences(), and ilObjStudyProgramme\getInstanceByRefId().

Referenced by ilStudyProgrammeProgressListGUI\buildProgressStatus(), canBeCompleted(), getChildrenProgress(), getCurrentAmountOfPoints(), getMaximumPossibleAmountOfPoints(), getNamesOfCompletedOrAccreditedChildren(), getParentProgresses(), markAccredited(), refreshLPStatus(), setLPCompleted(), ilStudyProgrammeExpandableProgressListGUI\shouldShowSubProgress(), updateFromProgramNode(), updateStatus(), and ilStudyProgrammeEvents\userSuccessful().

                                         : ilObjStudyProgramme
     {
         $refs = ilObject::_getAllReferences($this->progress->getNodeId());
         if (!count($refs)) {
             throw new ilException(
                 "ilStudyProgrammeUserAssignment::getStudyProgramme: "
                 . "could not find ref_id for program '"
                 . $this->progress->getNodeId() . "'."
             )
             ;
         }
         return ilObjStudyProgramme::getInstanceByRefId(array_shift($refs));
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUserId()

ilStudyProgrammeUserProgress::getUserId ( )

Get the id of the user who is assigned.

Definition at line 105 of file class.ilStudyProgrammeUserProgress.php.

Referenced by refreshLPStatus(), and setLPCompleted().

                                 : int
     {
         return $this->progress->getUserId();
     }

Here is the caller graph for this function:

◆ getValidityOfQualification()

ilStudyProgrammeUserProgress::getValidityOfQualification ( )

Get validity of qualification.

Returns: DateTime | null

Definition at line 203 of file class.ilStudyProgrammeUserProgress.php.

Referenced by isSuccessfulExpired().

                                                  : ?DateTime
     {
         return $this->progress->getValidityOfQualification();
     }

Here is the caller graph for this function:

◆ hasIndividualModifications()

ilStudyProgrammeUserProgress::hasIndividualModifications ( )

Check whether there are individual modifications for the user on this program.

Definition at line 545 of file class.ilStudyProgrammeUserProgress.php.

References getLastChangeBy().

Referenced by updateFromProgramNode().

                                                  : bool
     {
         return $this->getLastChangeBy() !== null;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasSuccessfullChildren()

ilStudyProgrammeUserProgress::hasSuccessfullChildren ( )

protected

Exceptions

ilException

Definition at line 710 of file class.ilStudyProgrammeUserProgress.php.

References getChildrenProgress().

Referenced by updateStatus().

                                                 : bool
     {
         foreach ($this->getChildrenProgress() as $child) {
             if ($child->isSuccessful()) {
                 return true;
             }
         }
 
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasSuccessStatus()

ilStudyProgrammeUserProgress::hasSuccessStatus ( )

Definition at line 1010 of file class.ilStudyProgrammeUserProgress.php.

References getStatus(), ilStudyProgrammeProgress\STATUS_ACCREDITED, and ilStudyProgrammeProgress\STATUS_COMPLETED.

                                        : bool
     {
         return in_array(
             $this->getStatus(),
             [
                 ilStudyProgrammeProgress::STATUS_COMPLETED,
                 ilStudyProgrammeProgress::STATUS_ACCREDITED
             ]
         );
     }

Here is the call graph for this function:

◆ informUserForRiskToFail()

ilStudyProgrammeUserProgress::informUserForRiskToFail ( )

Definition at line 952 of file class.ilStudyProgrammeUserProgress.php.

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

                                               : void
     {
         $this->events->userRiskyToFail($this);
     }

Here is the call graph for this function:

◆ invalidate()

ilStudyProgrammeUserProgress::invalidate ( )

Mark this progress as failed.

Throws when status is not STATUS_COMPLETED, STATUS_ACCREDITED, STATUS_NOT_RELEVANT.

Exceptions

ilException

Definition at line 333 of file class.ilStudyProgrammeUserProgress.php.

References getStatus(), isSuccessfulExpired(), refreshLPStatus(), ilStudyProgrammeProgress\STATUS_ACCREDITED, ilStudyProgrammeProgress\STATUS_COMPLETED, and ilStudyProgrammeProgress\STATUS_NOT_RELEVANT.

                                  : ilStudyProgrammeUserProgress
     {
         $status = array(
             ilStudyProgrammeProgress::STATUS_COMPLETED,
             ilStudyProgrammeProgress::STATUS_ACCREDITED,
             ilStudyProgrammeProgress::STATUS_NOT_RELEVANT
         );
 
         if (in_array($this->getStatus(), $status) && !$this->isSuccessfulExpired()) {
             throw new ilException("Can't mark as failed since program is passed.");
         }
 
         $this->progress_repository->update(
             $this->progress->invalidate()
         );
 
         $this->refreshLPStatus();
 
         return $this;
     }

Here is the call graph for this function:

◆ isAccredited()

ilStudyProgrammeUserProgress::isAccredited ( )

Check whether the user was accredited on this node.

Definition at line 598 of file class.ilStudyProgrammeUserProgress.php.

References getStatus(), and ilStudyProgrammeProgress\STATUS_ACCREDITED.

Referenced by getCurrentAmountOfPoints(), and ilStudyProgrammeMailTemplateContext\getNewestProgressForUser().

                                    : bool
     {
         return $this->getStatus() == ilStudyProgrammeProgress::STATUS_ACCREDITED;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isFailed()

ilStudyProgrammeUserProgress::isFailed ( )

Check whether user as failed on this node.

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

References getStatus(), and ilStudyProgrammeProgress\STATUS_FAILED.

                                : bool
     {
         $status = $this->getStatus();
 
         return $status == ilStudyProgrammeProgress::STATUS_FAILED;
     }

Here is the call graph for this function:

◆ isInvalidated()

ilStudyProgrammeUserProgress::isInvalidated ( )

Definition at line 354 of file class.ilStudyProgrammeUserProgress.php.

                                     : bool
     {
         return $this->progress->isInvalidated();
     }

◆ isRelevant()

ilStudyProgrammeUserProgress::isRelevant ( )

Check whether this node is relevant for the user.

Definition at line 606 of file class.ilStudyProgrammeUserProgress.php.

References getStatus(), and ilStudyProgrammeProgress\STATUS_NOT_RELEVANT.

Referenced by setLPCompleted(), and ilStudyProgrammeExpandableProgressListGUI\shouldShowSubProgress().

                                  : bool
     {
         return $this->getStatus() != ilStudyProgrammeProgress::STATUS_NOT_RELEVANT;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSuccessful()

ilStudyProgrammeUserProgress::isSuccessful ( )

Check whether the user was successful on this node.

This is the case, when the node was accredited or completed.

Definition at line 554 of file class.ilStudyProgrammeUserProgress.php.

References getStatus(), ilStudyProgrammeProgress\STATUS_ACCREDITED, and ilStudyProgrammeProgress\STATUS_COMPLETED.

Referenced by ilStudyProgrammeProgressListGUI\buildProgressBar(), ilStudyProgrammeIndividualPlanProgressListGUI\buildProgressStatus(), getCurrentAmountOfPoints(), ilStudyProgrammeMailTemplateContext\getNewestProgressForUser(), isSuccessfulExpired(), and setLPCompleted().

                                    : bool
     {
         $status = $this->getStatus();
 
         return
             $status == ilStudyProgrammeProgress::STATUS_ACCREDITED ||
             $status == ilStudyProgrammeProgress::STATUS_COMPLETED
         ;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isSuccessfulExpired()

ilStudyProgrammeUserProgress::isSuccessfulExpired ( )

Check, whether a the course is passed and expired due to limited validity.

Definition at line 362 of file class.ilStudyProgrammeUserProgress.php.

References getValidityOfQualification(), and isSuccessful().

Referenced by ilStudyProgrammeMailTemplateContext\getNewestProgressForUser(), and invalidate().

                                           : bool
     {
         if ($this->getValidityOfQualification() === null) {
             return false;
         }
 
         if (!$this->isSuccessful()) {
             return false;
         }
 
         if (
             $this->getValidityOfQualification()->format('Y-m-d') < (new DateTime())->format('Y-m-d')
         ) {
             return true;
         }
 
         return false;
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ markAccredited()

ilStudyProgrammeUserProgress::markAccredited ( int $user_id )

Mark this progress as accredited.

Throws when status is not IN_PROGRESS. Throws when program node is outdated and current status is NOT_RELEVANT.

Exceptions

ilException

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

References $progress, getAssignmentId(), getStatus(), getStudyProgramme(), maybeLimitProgressValidity(), ilStudyProgrammeProgress\STATUS_ACCREDITED, ilStudyProgrammeProgress\STATUS_NOT_RELEVANT, ilStudyProgrammeSettings\STATUS_OUTDATED, and updateParentStatus().

                                                  : ilStudyProgrammeUserProgress
     {
         $prg = $this->getStudyProgramme();
         if ($this->getStatus() == ilStudyProgrammeProgress::STATUS_NOT_RELEVANT) {
             if ($prg->getStatus() == ilStudyProgrammeSettings::STATUS_OUTDATED) {
                 throw new ilException(
                     "ilStudyProgrammeUserProgress::markAccredited: "
                     . "Can't mark as accredited since program is outdated."
                 );
             }
         }
         $progress = $this->progress
             ->setStatus(ilStudyProgrammeProgress::STATUS_ACCREDITED)
             ->setCompletionBy($user_id)
             ->setLastChangeBy($user_id)
             ->setLastChange(new DateTime())
             ->setCompletionDate(new DateTime())
         ;
 
         $this->progress_repository->update($progress);
 
         $assignment = $this->assignment_repository->read($this->getAssignmentId());
         if ((int) $prg->getId() === $assignment->getRootId()) {
             $this->maybeLimitProgressValidity($prg, $assignment);
         }
 
         $this->events->userSuccessful($this);
         $this->updateParentStatus();
 
         return $this;
     }

Here is the call graph for this function:

◆ markFailed()

ilStudyProgrammeUserProgress::markFailed ( int $a_user_id )

Mark this progress as failed.

Throws when status is not STATUS_COMPLETED, STATUS_ACCREDITED, STATUS_NOT_RELEVANT.

Exceptions

ilException

Definition at line 303 of file class.ilStudyProgrammeUserProgress.php.

References getStatus(), refreshLPStatus(), ilStudyProgrammeProgress\STATUS_ACCREDITED, ilStudyProgrammeProgress\STATUS_COMPLETED, ilStudyProgrammeProgress\STATUS_FAILED, and ilStudyProgrammeProgress\STATUS_NOT_RELEVANT.

                                                : ilStudyProgrammeUserProgress
     {
         $status = array(
             ilStudyProgrammeProgress::STATUS_COMPLETED,
             ilStudyProgrammeProgress::STATUS_ACCREDITED,
             ilStudyProgrammeProgress::STATUS_NOT_RELEVANT
         );
 
         if (in_array($this->getStatus(), $status)) {
             throw new ilException("Can't mark as failed since program is passed.");
         }
 
         $this->progress
             ->setStatus(ilStudyProgrammeProgress::STATUS_FAILED)
             ->setLastChangeBy($a_user_id)
             ->setCompletionDate(null);
 
         $this->progress_repository->update($this->progress);
         $this->refreshLPStatus();
 
         return $this;
     }

Here is the call graph for this function:

◆ markNotFailed()

ilStudyProgrammeUserProgress::markNotFailed ( int $user_id )

Set the node to in progress.

Throws when status is not FAILED.

Exceptions

ilException

Definition at line 388 of file class.ilStudyProgrammeUserProgress.php.

References refreshLPStatus(), ilStudyProgrammeProgress\STATUS_FAILED, and ilStudyProgrammeProgress\STATUS_IN_PROGRESS.

                                                 : ilStudyProgrammeUserProgress
     {
         if ($this->progress->getStatus() != ilStudyProgrammeProgress::STATUS_FAILED) {
             throw new ilException("Expected status FAILED.");
         }
 
         $this->progress_repository->update(
             $this->progress
                 ->setStatus(ilStudyProgrammeProgress::STATUS_IN_PROGRESS)
                 ->setCompletionBy(null)
                 ->setLastChangeBy($user_id)
         );
 
         $this->refreshLPStatus();
 
         return $this;
     }

Here is the call graph for this function:

◆ markNotRelevant()

ilStudyProgrammeUserProgress::markNotRelevant ( int $user_id )

Set the node to be not relevant for the user.

Throws when status is COMPLETED.

Exceptions

ilException

Parameters

int $user_id The user who marks the node as not relevant.

Returns: $this

Definition at line 415 of file class.ilStudyProgrammeUserProgress.php.

References ilStudyProgrammeProgress\STATUS_NOT_RELEVANT, and updateStatus().

                                                   : ilStudyProgrammeUserProgress
     {
         $this->progress_repository->update(
             $this->progress
                 ->setStatus(ilStudyProgrammeProgress::STATUS_NOT_RELEVANT)
                 ->setCompletionBy($user_id)
                 ->setLastChangeBy($user_id)
         );
 
         $this->updateStatus();
 
         return $this;
     }

Here is the call graph for this function:

◆ markRelevant()

ilStudyProgrammeUserProgress::markRelevant ( int $user_id )

Set the node to be relevant for the user.

Throws when status is not NOT_RELEVANT.

Exceptions

ilException

Definition at line 436 of file class.ilStudyProgrammeUserProgress.php.

References ilStudyProgrammeProgress\STATUS_IN_PROGRESS, ilStudyProgrammeProgress\STATUS_NOT_RELEVANT, and updateStatus().

                                                : ilStudyProgrammeUserProgress
     {
         if ($this->progress->getStatus() != ilStudyProgrammeProgress::STATUS_NOT_RELEVANT) {
             throw new ilException("Expected status IN_PROGRESS.");
         }
 
         $this->progress_repository->update(
             $this->progress
                 ->setStatus(ilStudyProgrammeProgress::STATUS_IN_PROGRESS)
                 ->setCompletionBy($user_id)
                 ->setLastChangeBy($user_id)
         );
 
         $this->updateStatus();
 
         return $this;
     }

Here is the call graph for this function:

◆ maybeLimitProgressValidity()

ilStudyProgrammeUserProgress::maybeLimitProgressValidity	(	ilObjStudyProgramme	$prg,
		ilStudyProgrammeAssignment	$assignment
	)

protected

Exceptions

Exception

Definition at line 792 of file class.ilStudyProgrammeUserProgress.php.

References ilObjStudyProgramme\getValidityOfQualificationSettings(), ilStudyProgrammeSettings\NO_RESTART, ilStudyProgrammeSettings\NO_VALIDITY_OF_QUALIFICATION_PERIOD, and ilStudyProgrammeAssignment\setRestartDate().

Referenced by markAccredited(), setLPCompleted(), and updateStatus().

       : void {
         $qualification_date = $prg->getValidityOfQualificationSettings()->getQualificationDate();
         $qualification_period = $prg->getValidityOfQualificationSettings()->getQualificationPeriod();
         if (!is_null($qualification_date)) {
             $date = $qualification_date;
         } elseif (
             ilStudyProgrammeSettings::NO_VALIDITY_OF_QUALIFICATION_PERIOD !== $qualification_period
         ) {
             $date = new DateTime();
             $date->add(new DateInterval('P' . $qualification_period . 'D'));
         } else {
             // nothing to do
             return;
         }
 
         $this->progress_repository->update($this->progress->setValidityOfQualification($date));
 
         $restart_period = $prg->getValidityOfQualificationSettings()->getRestartPeriod();
         if (ilStudyProgrammeSettings::NO_RESTART !== $restart_period) {
             $date->sub(new DateInterval('P' . $restart_period . 'D'));
             $this->assignment_repository->update($assignment->setRestartDate($date));
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ recalculateFailedToDeadline()

ilStudyProgrammeUserProgress::recalculateFailedToDeadline ( )

Recalculates the status according to deadline.

Exceptions

ilException

Definition at line 579 of file class.ilStudyProgrammeUserProgress.php.

References ilStudyProgrammeProgress\DATE_FORMAT, getDeadline(), ilStudyProgrammeProgress\STATUS_FAILED, and ilStudyProgrammeProgress\STATUS_IN_PROGRESS.

                                                   : void
     {
         $deadline = $this->getDeadline();
         $today = date(ilStudyProgrammeProgress::DATE_FORMAT);
 
         if ($deadline
             && $deadline->format(ilStudyProgrammeProgress::DATE_FORMAT) < $today
             && $this->progress->getStatus() === ilStudyProgrammeProgress::STATUS_IN_PROGRESS
         ) {
             $this->progress_repository->update(
                 $this->progress
                     ->setStatus(ilStudyProgrammeProgress::STATUS_FAILED)
             );
         }
     }

Here is the call graph for this function:

◆ refreshLPStatus()

ilStudyProgrammeUserProgress::refreshLPStatus ( )

protected

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

References ilLPStatusWrapper\_refreshStatus(), ilLPStatusWrapper\_resetInfoCaches(), getId(), getStudyProgramme(), and getUserId().

Referenced by invalidate(), markFailed(), markNotFailed(), setLPCompleted(), unmarkAccredited(), and updateStatus().

                                          : void
     {
         // thanks to some caching within ilLPStatusWrapper
         // the status may not be read properly otherwise ...
         ilLPStatusWrapper::_resetInfoCaches($this->progress->getNodeId());
         ilLPStatusWrapper::_refreshStatus(
             $this->getStudyProgramme()->getId(),
             array($this->getUserId())
         );
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setDeadline()

ilStudyProgrammeUserProgress::setDeadline ( DateTime $deadline = null )

Set the deadline of this node.

Definition at line 193 of file class.ilStudyProgrammeUserProgress.php.

References ilStudyProgrammeProgress\setDeadline().

Referenced by ilObjStudyProgrammeIndividualPlanGUI\updateDeadline().

                                                            : ilStudyProgrammeProgress
     {
         return $this->progress->setDeadline($deadline);
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setLPCompleted()

ilStudyProgrammeUserProgress::setLPCompleted	(	int	$obj_id,
		int	$usr_id
	)

Set this node to be completed due to a completed learning progress.

Will only set the progress if this node is relevant and not successful.

Throws when this node is not in LP-Mode. Throws when object that was completed is no child of the node or user does not belong to this progress.

Exceptions

ilException

Returns: bool | void

Definition at line 742 of file class.ilStudyProgrammeUserProgress.php.

References getAssignmentId(), getStudyProgramme(), getUserId(), isRelevant(), isSuccessful(), maybeLimitProgressValidity(), ilStudyProgrammeSettings\MODE_LP_COMPLETED, refreshLPStatus(), ilStudyProgrammeProgress\STATUS_COMPLETED, and updateParentStatus().

     {
         if ($this->isSuccessful() || !$this->isRelevant()) {
             return true;
         }
 
         $prg = $this->getStudyProgramme();
         if ($prg->getLPMode() != ilStudyProgrammeSettings::MODE_LP_COMPLETED) {
             throw new ilException(
                 "ilStudyProgrammeUserProgress::setLPCompleted: "
                 . "The node '" . $prg->getId() . "' is not in LP_COMPLETED mode."
             );
         }
 
         if ($this->getUserId() != $usr_id) {
             throw new ilException(
                 "ilStudyProgrammeUserProgress::setLPCompleted: "
                 . "This progress does belong to user '" . $this->getUserId()
                 . "' and not to user '$usr_id'"
             );
         }
 
         if (!in_array($obj_id, $prg->getLPChildrenIds())) {
             throw new ilException(
                 "ilStudyProgrammeUserProgress::setLPCompleted: "
                 . "Object '$obj_id' is no child of node '" . $prg->getId() . "'."
             );
         }
 
         $this->progress_repository->update(
             $this->progress
                 ->setStatus(ilStudyProgrammeProgress::STATUS_COMPLETED)
                 ->setCompletionBy($obj_id)
                 ->setCompletionDate(new DateTime())
         );
 
         $this->refreshLPStatus();
 
         $assignment = $this->assignment_repository->read($this->getAssignmentId());
         if ((int) $prg->getId() === $assignment->getRootId()) {
             $this->maybeLimitProgressValidity($prg, $assignment);
         }
 
         $this->events->userSuccessful($this);
         $this->updateParentStatus();
     }

Here is the call graph for this function:

◆ setRequiredAmountOfPoints()

ilStudyProgrammeUserProgress::setRequiredAmountOfPoints	(	int	$a_points,
		int	$user_id
	)

Set the amount of points the user is required to have to complete this node.

Throws when status is completed.

Exceptions

ilException

Definition at line 461 of file class.ilStudyProgrammeUserProgress.php.

References updateStatus().

       : ilStudyProgrammeUserProgress {
         $this->progress_repository->update(
             $this->progress
                 ->setAmountOfPoints($a_points)
                 ->setLastChangeBy($user_id)
         );
 
         $this->updateStatus();
 
         return $this;
     }

Here is the call graph for this function:

◆ setValidityOfQualification()

ilStudyProgrammeUserProgress::setValidityOfQualification ( DateTime $date = null )

Set validity of qualification.

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

                                                                       : void
     {
         $this->progress->setValidityOfQualification($date);
     }

◆ storeProgress()

ilStudyProgrammeUserProgress::storeProgress ( )

Definition at line 216 of file class.ilStudyProgrammeUserProgress.php.

                                     : void
     {
         $this->progress_repository->update($this->progress);
     }

◆ unmarkAccredited()

ilStudyProgrammeUserProgress::unmarkAccredited ( )

Set the node to in progress.

Throws when status is not ACCREDITED.

Exceptions

ilException

Definition at line 277 of file class.ilStudyProgrammeUserProgress.php.

References refreshLPStatus(), ilStudyProgrammeProgress\STATUS_ACCREDITED, ilStudyProgrammeProgress\STATUS_IN_PROGRESS, and updateParentStatus().

                                        : ilStudyProgrammeUserProgress
     {
         if ($this->progress->getStatus() != ilStudyProgrammeProgress::STATUS_ACCREDITED) {
             throw new ilException("Expected status ACCREDITED.");
         }
 
         $this->progress_repository->update(
             $this->progress
                 ->setStatus(ilStudyProgrammeProgress::STATUS_IN_PROGRESS)
                 ->setCompletionBy(null)
                 ->setCompletionDate(null)
         );
 
         $this->refreshLPStatus();
         $this->updateParentStatus();
 
         return $this;
     }

Here is the call graph for this function:

◆ updateFromProgramNode()

ilStudyProgrammeUserProgress::updateFromProgramNode ( )

Update the progress from its program node.

Will only update when the node does not have individual modifications and is not completed. Return false, when update could not be performed and true otherwise.

Exceptions

ilException

Returns: bool | void

Definition at line 619 of file class.ilStudyProgrammeUserProgress.php.

References getStatus(), getStudyProgramme(), hasIndividualModifications(), ilStudyProgrammeSettings\STATUS_ACTIVE, ilStudyProgrammeProgress\STATUS_COMPLETED, ilStudyProgrammeProgress\STATUS_IN_PROGRESS, ilStudyProgrammeProgress\STATUS_NOT_RELEVANT, and updateStatus().

     {
         if ($this->hasIndividualModifications()) {
             return false;
         }
 
         if ($this->getStatus() == ilStudyProgrammeProgress::STATUS_COMPLETED) {
             return false;
         }
 
         $prg = $this->getStudyProgramme();
 
         $status = ilStudyProgrammeProgress::STATUS_NOT_RELEVANT;
         if ($prg->getStatus() == ilStudyProgrammeSettings::STATUS_ACTIVE) {
             $status = ilStudyProgrammeProgress::STATUS_IN_PROGRESS;
         }
 
         $this->progress_repository->update(
             $this->progress
                 ->setAmountOfPoints($prg->getPoints())
                 ->setStatus($status)
         );
 
         $this->updateStatus();
     }

Here is the call graph for this function:

◆ updateParentStatus()

ilStudyProgrammeUserProgress::updateParentStatus ( )

protected

Update the status of the parent of this node.

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

References getParentProgresses().

Referenced by markAccredited(), setLPCompleted(), unmarkAccredited(), and updateStatus().

                                             : void
     {
         foreach ($this->getParentProgresses() as $parent) {
             $parent->updateStatus();
         }
     }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateProgress()

ilStudyProgrammeUserProgress::updateProgress ( int $user_id )

Updates current progress.

Exceptions

ilException

Definition at line 945 of file class.ilStudyProgrammeUserProgress.php.

Referenced by ilObjStudyProgrammeIndividualPlanGUI\updateDeadline().

                                                  : void
     {
         $this->progress_repository->update(
             $this->progress->setLastChangeBy($user_id)
         );
     }

Here is the caller graph for this function:

◆ updateStatus()

ilStudyProgrammeUserProgress::updateStatus ( )

protected

Updates the status of this progress based on the status of the progress on the sub nodes.

Then update the status of the parent.

Exceptions

ilException

Returns: int | void

Definition at line 652 of file class.ilStudyProgrammeUserProgress.php.

References Vendor\Package\$a, Vendor\Package\$b, getAmountOfPoints(), getAssignmentId(), getChildrenProgress(), getStatus(), getStudyProgramme(), hasSuccessfullChildren(), maybeLimitProgressValidity(), ilStudyProgrammeSettings\MODE_LP_COMPLETED, refreshLPStatus(), ilStudyProgrammeProgress\STATUS_ACCREDITED, ilStudyProgrammeProgress\STATUS_COMPLETED, ilStudyProgrammeProgress\STATUS_IN_PROGRESS, ilStudyProgrammeProgress\STATUS_NOT_RELEVANT, and updateParentStatus().

Referenced by markNotRelevant(), markRelevant(), setRequiredAmountOfPoints(), and updateFromProgramNode().

     {
         $prg = $this->getStudyProgramme();
         if (
             ($prg->getLPMode() == ilStudyProgrammeSettings::MODE_LP_COMPLETED &&
              $this->getStatus() != ilStudyProgrammeProgress::STATUS_ACCREDITED) ||
             $this->getStatus() == ilStudyProgrammeProgress::STATUS_NOT_RELEVANT
         ) {
             // Nothing to do here, as the status will be set by LP.
             // OR current status is NOT RELEVANT
             return;
         }
 
         $add = function ($a, $b) {
             return $a + $b;
         };
         $get_points = function ($child) {
             if (!$child->isSuccessful()) {
                 return 0;
             }
             return $child->getAmountOfPoints();
         };
 
         $achieved_points = array_reduce(array_map($get_points, $this->getChildrenProgress()), $add);
         if (!$achieved_points) {
             $achieved_points = 0;
         }
 
         $successful = $achieved_points >= $this->getAmountOfPoints() && $this->hasSuccessfullChildren();
         $this->progress->setCurrentAmountOfPoints($achieved_points);
 
         if ($successful) {
             $this->progress->setStatus(ilStudyProgrammeProgress::STATUS_COMPLETED);
             if (!$this->progress->getCompletionDate()) {
                 $this->progress->setCompletionDate(new DateTime());
             }
 
             $assignment = $this->assignment_repository->read($this->getAssignmentId());
             if ((int) $prg->getId() === $assignment->getRootId()) {
                 $this->maybeLimitProgressValidity($prg, $assignment);
             }
             $this->events->userSuccessful($this);
         } else {
             $this->progress->setStatus(ilStudyProgrammeProgress::STATUS_IN_PROGRESS);
             $this->progress->setCompletionDate(null);
         }
 
         $this->progress_repository->update(
             $this->progress
         );
 
         $this->refreshLPStatus();
         $this->updateParentStatus();
     }