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

Collaboration diagram for ilStudyProgrammeUserProgress:

Public Member Functions
	__construct ($a_ids_or_model)
	Throws when id does not refer to a study programme progress. More...

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

	getAssignment ()
	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...

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

	markAccredited ($a_user_id)
	Mark this progress as accredited. More...

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

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

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

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

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

	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 ($a_obj_id, $a_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...

Static Public Member Functions
static	getInstance ($a_assignment_id, $a_program_id, $a_user_id)
	Get an instance. More...

static	getInstanceById ($a_prgrs_id)
	Get an instance by progress id. More...

static	getInstancesForUser ($a_program_id, $a_user_id)
	Get the instances that user has on program. More...

static	getInstanceForAssignment ($a_program_id, $a_assignment_id)
	Get the instance for the assignment on the program. More...

static	getInstancesForAssignment ($a_assignment_id)
	Get the instance for an assignment. More...

static	getInstancesForProgram ($a_program_id)
	Get the instances for a program node. More...

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

static	getPossibleActions ($a_node_id, $a_root_prg_id, $a_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"

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

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

	refreshLPStatus ()

Protected Attributes
	$progress

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.

Author: : Richard Klees richa.nosp@m.rd.k.nosp@m.lees@.nosp@m.conc.nosp@m.epts-.nosp@m.and-.nosp@m.train.nosp@m.ing..nosp@m.de

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

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeUserProgress::__construct ( $a_ids_or_model )

Throws when id does not refer to a study programme progress.

Expects an array [assignment_id, program_node_id, user_id] or an ilStudyProgress as first parameter.

Exceptions

ilException

Parameters

int[] | ilStudyProgrammeAssignment $a_ids_or_model

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

References ActiveRecord\where().

                                                      {
                 if ($a_ids_or_model instanceof ilStudyProgrammeProgress) {
                         $this->progress = $a_ids_or_model;
                 }
                 else {
                         if (count($a_ids_or_model) != 3) {
                                 throw new ilException("ilStudyProgrammeUserProgress::__construct: "
                                                                          ."expected array with 3 items.");
                         }
                         
                         // TODO: ActiveRecord won't be caching the model objects, since
                         // we are not using find. Maybe we should do this ourselves??
                         // Or should we instead cache in getInstance?
                         $this->progress = array_shift(
                                 ilStudyProgrammeProgress::where(array
                                                         ( "assignment_id" => $a_ids_or_model[0]
                                                         , "prg_id" => $a_ids_or_model[1]
                                                         , "usr_id" => $a_ids_or_model[2]
                                                         ))->get());
                 }
                 if ($this->progress === null) {
                         throw new ilException("ilStudyProgrammeUserProgress::__construct: Could not find progress.");
                 }
         }

Here is the call graph for this function:

Member Function Documentation

◆ canBeCompleted()

ilStudyProgrammeUserProgress::canBeCompleted ( )

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

Returns: bool

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

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

Referenced by ilStudyProgrammeIndividualPlanProgressListGUI\buildProgressStatus().

                                          {
                 $prg = $this->getStudyProgramme();
                 
                 if ($prg->getLPMode() == ilStudyProgramme::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 303 of file class.ilStudyProgrammeUserProgress.php.

                                  {
                 $this->progress->delete();
         }

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

Returns: int

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

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

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

Here is the caller graph for this function:

◆ getAssignment()

ilStudyProgrammeUserProgress::getAssignment ( )

Get the assignment this progress belongs to.

Returns: ilStudyProgrammeUserAssignment

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

References ilStudyProgrammeUserAssignment\getInstance().

Referenced by getParentProgress(), and ilStudyProgrammeEvents\userSuccessful().

                                         {
                 require_once("Modules/StudyProgramme/classes/class.ilStudyProgrammeUserAssignment.php");
                 return ilStudyProgrammeUserAssignment::getInstance($this->progress->getAssignmentId());
         }

Here is the call graph for this function:

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.

Returns: ilStudyProgrammeUserProgress[]

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

References getStudyProgramme(), and ilStudyProgramme\MODE_LP_COMPLETED.

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

                                               {
                 $prg = $this->getStudyProgramme();
                 if ($prg->getLPMode() == ilStudyProgramme::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());
         }

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.

Returns: int | null

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

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

◆ getCurrentAmountOfPoints()

ilStudyProgrammeUserProgress::getCurrentAmountOfPoints ( )

Get the amount of points the user currently achieved.

Returns: int

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

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

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

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

◆ getId()

ilStudyProgrammeUserProgress::getId ( )

Get the id of the progress.

Returns: int

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

Referenced by getParentProgress(), ilStudyProgrammeProgressListGUI\getTitleAndIconTarget(), and refreshLPStatus().

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

Here is the caller graph for this function:

◆ getInstance()

static ilStudyProgrammeUserProgress::getInstance	(	$a_assignment_id,
		$a_program_id,
		$a_user_id
	)

static

Get an instance.

Just wraps constructor.

Exceptions

ilException

Parameters

int	$a_assignment_id
int	$a_program_id
int	$a_user_id

Returns: ilStudyProgrammeUserProgress

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

Referenced by ilStudyProgrammeIndividualPlanTableGUI\fetchData().

                                                                                         {
                 return new ilStudyProgrammeUserProgress(array($a_assignment_id, $a_program_id, $a_user_id));
         }

Here is the caller graph for this function:

◆ getInstanceById()

static ilStudyProgrammeUserProgress::getInstanceById ( $a_prgrs_id )

static

Get an instance by progress id.

Parameters

int $a_prgrs_id

Returns: ilStudyProgrammeUserProgress

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

Referenced by ilObjStudyProgrammeMembersGUI\getProgressObject(), ilObjStudyProgrammeIndividualPlanGUI\updateRequiredPoints(), and ilObjStudyProgrammeIndividualPlanGUI\updateStatus().

                                                             {
                 $prgrs = ilStudyProgrammeProgress::find($a_prgrs_id);
                 if ($prgrs === null) {
                         throw new ilException("Unknown progress id $a_prgrs_id.");
                 }
                 return new ilStudyProgrammeUserProgress($prgrs);
         }

Here is the caller graph for this function:

◆ getInstanceForAssignment()

static ilStudyProgrammeUserProgress::getInstanceForAssignment	(	$a_program_id,
		$a_assignment_id
	)

static

Get the instance for the assignment on the program.

Throws when the node does not belong to the assignment.

Exceptions

ilException

Parameters

int	$a_program_id
int	$a_user_id

Returns: ilStudyProgrammeUserProgress

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

References ActiveRecord\where().

Referenced by ilStudyProgrammeMembersTableGUI\fetchData(), and ilObjStudyProgramme\getProgressForAssignment().

                                                                                          {
                 $progresses = ilStudyProgrammeProgress::where(array
                                                         ( "prg_id" => $a_program_id
                                                         , "assignment_id" => $a_assignment_id
                                                         ))->get();
                 if (count($progresses) == 0) {
                         require_once("Modules/StudyProgramme/classes/exceptions/class.ilStudyProgrammeNoProgressForAssignmentException.php");
                         throw new ilStudyProgrammeNoProgressForAssignmentException
                                                                 ("ilStudyProgrammeUserProgress::getInstanceForAssignment: "
                                                                 ."Assignment '$a_assignment_id' does not belong to program "
                                                                 ."'$a_program_id'");
                 }
                 return new ilStudyProgrammeUserProgress(array_shift($progresses));
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstancesForAssignment()

static ilStudyProgrammeUserProgress::getInstancesForAssignment ( $a_assignment_id )

static

Get the instance for an assignment.

Throws when the node does not belong to the assignment.

Exceptions

ilException

Parameters

int	$a_program_id
int	$a_user_id

Returns: ilStudyProgrammeUserProgress

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

References ActiveRecord\where().

Referenced by ilStudyProgrammeUserAssignment\delete().

                                                                            {
                 $progresses = ilStudyProgrammeProgress::where(array
                                                         ( "assignment_id" => $a_assignment_id
                                                         ))->get();
                 if (count($progresses) == 0) {
                         require_once("Modules/StudyProgramme/classes/exceptions/class.ilStudyProgrammeNoProgressForAssignmentException.php");
                         throw new ilStudyProgrammeNoProgressForAssignmentException
                                                                 ("ilStudyProgrammeUserProgress::getInstancesForAssignment: "
                                                                 ."Can't find progresses for assignment '$a_assignment_id'.");
                 }
                 return array_map(function($dat) {
                         return new ilStudyProgrammeUserProgress($dat);
                 }, $progresses);
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstancesForProgram()

static ilStudyProgrammeUserProgress::getInstancesForProgram ( $a_program_id )

static

Get the instances for a program node.

Parameters

int $a_program_id

Returns: ilStudyProgrammeUserProgress[]

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

References ActiveRecord\where().

Referenced by ilObjStudyProgramme\getProgresses().

                                                                      {
                 $progresses = ilStudyProgrammeProgress::where(array
                                                         ( "prg_id" => $a_program_id
                                                         ))->get();
                 return array_values(array_map(function($dat) {
                         return new ilStudyProgrammeUserProgress($dat);
                 }, $progresses));
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getInstancesForUser()

static ilStudyProgrammeUserProgress::getInstancesForUser	(	$a_program_id,
		$a_user_id
	)

static

Get the instances that user has on program.

Parameters

int	$a_program_id
int	$a_user_id

Returns: ilStudyProgrammeUserProgress[]

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

References ActiveRecord\where().

Referenced by ilObjStudyProgramme\getProgressesOf().

                                                                               {
                 $progresses = ilStudyProgrammeProgress::where(array
                                                         ( "prg_id" => $a_program_id
                                                         , "usr_id" => $a_user_id
                                                         ))->get();
                 return array_values(array_map(function($dat) {
                         return new ilStudyProgrammeUserProgress($dat);
                 }, $progresses));
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getLastChange()

ilStudyProgrammeUserProgress::getLastChange ( )

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

Returns: ilDateTime

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

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

◆ getLastChangeBy()

ilStudyProgrammeUserProgress::getLastChangeBy ( )

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

Returns: int

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

Referenced by hasIndividualModifications().

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

Here is the caller graph for this function:

◆ getMaximumPossibleAmountOfPoints()

ilStudyProgrammeUserProgress::getMaximumPossibleAmountOfPoints ( $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.

Parameters

$only_relevant boolean true if check is nesserary the progress is relevant

Returns: int

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

References getAmountOfPoints(), getStudyProgramme(), and ilStudyProgramme\MODE_LP_COMPLETED.

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

                                                                                  {
                 $prg = $this->getStudyProgramme();
                 if ($prg->getLPMode() == ilStudyProgramme::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.

Parameters

int $a_assignment_id

Returns: string[]

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

References getStudyProgramme().

                                                                   {
                 $prg = $this->getStudyProgramme();
                 $children = $prg->getChildren();
                 $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.

Returns: int

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

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

◆ getParentProgress()

ilStudyProgrammeUserProgress::getParentProgress ( )

protected

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

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

References getAssignment(), getId(), and getStudyProgramme().

Referenced by updateParentStatus().

                                                {
                 $prg = $this->getStudyProgramme();
                 $parent = $prg->getParent();
                 if (!$parent) {
                         return null;
                 }
 
                 if($this->getStudyProgramme()->getId() == $this->getAssignment()->getStudyProgramme()->getId()) {
                         return null;
                 }
 
                 return $parent->getProgressForAssignment($this->progress->getAssignmentId());
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getPossibleActions()

static ilStudyProgrammeUserProgress::getPossibleActions	(	$a_node_id,
		$a_root_prg_id,
		$a_status
	)

static

Get a list with possible actions on a progress record.

Parameters

int	$a_node_id	object_id!
int	$a_belongs	object_id!
int	$a_status

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

References ilStudyProgrammeProgress\STATUS_ACCREDITED, and ilStudyProgrammeProgress\STATUS_IN_PROGRESS.

Referenced by ilStudyProgrammeMembersTableGUI\fetchData().

                                                                                          {
                 $actions = array();
                 if ($a_node_id == $a_root_prg_id) {
                         $actions[] = self::ACTION_SHOW_INDIVIDUAL_PLAN;
                         $actions[] = self::ACTION_REMOVE_USER;
                 }
                 if ($a_status == ilStudyProgrammeProgress::STATUS_ACCREDITED) {
                         $actions[] = self::ACTION_UNMARK_ACCREDITED;
                 }
                 else if ($a_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.

Returns: ilStudyProgrammeProgress::$STATUS

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

Referenced by isAccredited(), isRelevant(), isSuccessful(), markAccredited(), updateFromProgramNode(), and updateStatus().

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

Here is the caller graph for this function:

◆ getStudyProgramme()

ilStudyProgrammeUserProgress::getStudyProgramme ( )

Get the program node where this progress belongs to was made.

Throws when program this assignment is about has no ref id.

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

Exceptions

ilException

Returns: ilObjStudyProgramme

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

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

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

                                             {
                 require_once("./Modules/StudyProgramme/classes/class.ilObjStudyProgramme.php");
                 $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.

Returns: int

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

Referenced by refreshLPStatus(), and setLPCompleted().

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

Here is the caller graph for this function:

◆ hasIndividualModifications()

ilStudyProgrammeUserProgress::hasIndividualModifications ( )

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

Returns: bool

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

References getLastChangeBy().

Referenced by updateFromProgramNode().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ hasSuccessfullChildren()

ilStudyProgrammeUserProgress::hasSuccessfullChildren ( )

protected

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

References getChildrenProgress().

Referenced by updateStatus().

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

◆ isAccredited()

ilStudyProgrammeUserProgress::isAccredited ( )

Check whether the user was accredited on this node.

Returns: bool

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

References getStatus(), and ilStudyProgrammeProgress\STATUS_ACCREDITED.

Referenced by getCurrentAmountOfPoints().

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

Here is the call graph for this function:

Here is the caller graph for this function:

◆ isRelevant()

ilStudyProgrammeUserProgress::isRelevant ( )

Check whether this node is relevant for the user.

Returns: bool

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

References getStatus(), and ilStudyProgrammeProgress\STATUS_NOT_RELEVANT.

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

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

Returns: bool

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

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

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

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

◆ markAccredited()

ilStudyProgrammeUserProgress::markAccredited ( $a_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

Parameters

int $a_user_id The user who performed the operation.

Returns: $this

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

References getStatus(), getStudyProgramme(), ilStudyProgrammeProgress\STATUS_ACCREDITED, ilStudyProgrammeProgress\STATUS_NOT_RELEVANT, ilStudyProgramme\STATUS_OUTDATED, updateParentStatus(), and ilStudyProgrammeEvents\userSuccessful().

                                                    {
                 if ($this->getStatus() == ilStudyProgrammeProgress::STATUS_NOT_RELEVANT) {
                         $prg = $this->getStudyProgramme();
                         if ($prg->getStatus() == ilStudyProgramme::STATUS_OUTDATED) {
                                 throw new ilException("ilStudyProgrammeUserProgress::markAccredited: "
                                                                          ."Can't mark as accredited since program is outdated.");
                         }
                 }
                 
                 $this->progress->setStatus(ilStudyProgrammeProgress::STATUS_ACCREDITED)
                                            ->setCompletionBy($a_user_id)
                                            ->update();
                 
                 require_once("Modules/StudyProgramme/classes/class.ilStudyProgrammeEvents.php");
                 ilStudyProgrammeEvents::userSuccessful($this);
                 
                 $this->updateParentStatus();
                 return $this;
         }

Here is the call graph for this function:

◆ markNotRelevant()

ilStudyProgrammeUserProgress::markNotRelevant ( $a_user_id )

Set the node to be not relevant for the user.

Throws when status is COMPLETED.

Exceptions

ilException

Parameters

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

Returns: $this

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

References ilStudyProgrammeProgress\STATUS_NOT_RELEVANT, and updateStatus().

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

Here is the call graph for this function:

◆ markRelevant()

ilStudyProgrammeUserProgress::markRelevant ( $a_user_id )

Set the node to be relevant for the user.

Throws when status is not NOT_RELEVANT.

Exceptions

ilException

Parameters

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

Returns: $this

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

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

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

Here is the call graph for this function:

◆ refreshLPStatus()

ilStudyProgrammeUserProgress::refreshLPStatus ( )

protected

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

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

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

                                              {
                 require_once("Services/Tracking/classes/class.ilLPStatusWrapper.php");
                 ilLPStatusWrapper::_refreshStatus($this->getStudyProgramme()->getId(), array($this->getUserId()));
         }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setLPCompleted()

ilStudyProgrammeUserProgress::setLPCompleted	(	$a_obj_id,
		$a_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

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

References getStudyProgramme(), getUserId(), isRelevant(), isSuccessful(), ilStudyProgramme\MODE_LP_COMPLETED, refreshLPStatus(), ilStudyProgrammeProgress\STATUS_COMPLETED, updateParentStatus(), and ilStudyProgrammeEvents\userSuccessful().

                                                              {
                 if ($this->isSuccessful() || !$this->isRelevant()) {
                         return true;
                 }
                 
                 $prg = $this->getStudyProgramme();
                 if ($prg->getLPMode() != ilStudyProgramme::MODE_LP_COMPLETED) {
                         throw new ilException("ilStudyProgrammeUserProgress::setLPCompleted: "
                                                                  ."The node '".$prg->getId()."' is not in LP_COMPLETED mode.");
                 }
                 if ($this->getUserId() != $a_usr_id) {
                         throw new ilException("ilStudyProgrammeUserProgress::setLPCompleted: "
                                                                  ."This progress does belong to user '".$this->getUserId()
                                                                  ."' and not to user '$a_usr_id'");
                 }
                 if (!in_array($a_obj_id, $prg->getLPChildrenIds())) {
                         throw new ilException("ilStudyProgrammeUserProgress::setLPCompleted: "
                                                                  ."Object '$a_obj_id' is no child of node '".$prg->getId()."'.");
                 }
                 
                 $this->progress->setStatus(ilStudyProgrammeProgress::STATUS_COMPLETED)
                                            ->setCompletionBy($a_obj_id)
                                            ->update();
                 
                 require_once("Modules/StudyProgramme/classes/class.ilStudyProgrammeEvents.php");
                 ilStudyProgrammeEvents::userSuccessful($this);
                 
                 $this->refreshLPStatus();
                 $this->updateParentStatus();
         }

Here is the call graph for this function:

◆ setRequiredAmountOfPoints()

ilStudyProgrammeUserProgress::setRequiredAmountOfPoints	(	$a_points,
		$a_user_id
	)

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

Throws when status is completed.

Exceptions

ilException

Parameters

int	$a_points	The amount of points the user needs for completion.
int	$a_user_id	The id of the user who did the modification.

Returns: $this

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

References updateStatus().

                                                                          {
                 $this->progress->setAmountOfPoints($a_points)
                                            ->setLastChangeBy($a_user_id)
                                            ->update();
                 
                 $this->updateStatus();
                 return $this;
         }

Here is the call graph for this function:

◆ statusToRepr()

static ilStudyProgrammeUserProgress::statusToRepr ( $a_status )

static

Get a user readable representation of a status.

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

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

Referenced by ilStudyProgrammeIndividualPlanTableGUI\fillRow(), and ilStudyProgrammeMembersTableGUI\fillRow().

                                                        {
                 global $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");
                 }
                 throw new ilException("Unknown status: '$a_status'");
         }

Here is the caller graph for this function:

◆ unmarkAccredited()

ilStudyProgrammeUserProgress::unmarkAccredited ( )

Set the node to in progress.

Throws when status is not ACCREDITED.

Exceptions

ilException

Returns: $this

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

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

                                            {
                 if ($this->progress->getStatus() != ilStudyProgrammeProgress::STATUS_ACCREDITED) {
                         throw new ilException("Expected status ACCREDITED.");
                 }
                 
                 $this->progress->setStatus(ilStudyProgrammeProgress::STATUS_IN_PROGRESS)
                                            ->setCompletionBy(null)
                                            ->update();
 
                 $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.

Returns: bool

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

References getStatus(), getStudyProgramme(), hasIndividualModifications(), ilStudyProgramme\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();
                 $this->progress->setAmountOfPoints($prg->getPoints())
                                            ->setStatus($prg->getStatus() == ilStudyProgramme::STATUS_ACTIVE 
                                                                         ? ilStudyProgrammeProgress::STATUS_IN_PROGRESS
                                                                         : ilStudyProgrammeProgress::STATUS_NOT_RELEVANT
                                                                    )
                                            ->update();
                 
                 $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 608 of file class.ilStudyProgrammeUserProgress.php.

References getParentProgress().

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

                                                 {
                 $parent = $this->getParentProgress();
                 if ($parent) {
                         $parent->updateStatus();
                 }
         }

Here is the call graph for this function:

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.

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

References getAmountOfPoints(), getChildrenProgress(), getStatus(), getStudyProgramme(), hasSuccessfullChildren(), ilStudyProgramme\MODE_LP_COMPLETED, refreshLPStatus(), ilStudyProgrammeProgress\STATUS_ACCREDITED, ilStudyProgrammeProgress\STATUS_COMPLETED, ilStudyProgrammeProgress\STATUS_IN_PROGRESS, ilStudyProgrammeProgress\STATUS_NOT_RELEVANT, updateParentStatus(), and ilStudyProgrammeEvents\userSuccessful().

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

                                           {
                 $prg = $this->getStudyProgramme();
                 if ((   $prg->getLPMode() == ilStudyProgramme::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();
                 $status = $this->getStatus();
                 
                 $this->progress->setCurrentAmountOfPoints($achieved_points);
                 if ($successful) {
                         $this->progress->setStatus(ilStudyProgrammeProgress::STATUS_COMPLETED);
                         require_once("Modules/StudyProgramme/classes/class.ilStudyProgrammeEvents.php");
                         ilStudyProgrammeEvents::userSuccessful($this);
                 } else {
                         $this->progress->setStatus(ilStudyProgrammeProgress::STATUS_IN_PROGRESS);
                 }
                 
                 $this->progress->update();
                 $this->refreshLPStatus();
                 $this->updateParentStatus();
         }