A Progress is the status of a user on a single node of an assignment; it is unique by assignment_id:usr_id:node_id. More...

Inheritance diagram for ilPRGProgress:

Collaboration diagram for ilPRGProgress:

Public Member Functions
	__construct (int $prg_obj_id, int $status=self::STATUS_NOT_RELEVANT)

	getNodeId ()

	getAmountOfPoints ()

	withAmountOfPoints (int $points)

	getCurrentAmountOfPoints ()

	withCurrentAmountOfPoints (int $points_cur)

	getStatus ()

	withStatus (int $status)

	isTransitionAllowedTo (int $new_status)

	getLastChangeBy ()

	getLastChange ()

	withLastChange (int $last_change_by, \DateTimeImmutable $last_change)

	getAssignmentDate ()

	withAssignmentDate (?\DateTimeImmutable $assignment_date)

	getCompletionDate ()

	getCompletionBy ()

	withCompletion (?int $usr_or_obj_id=null, ?\DateTimeImmutable $completion_date=null)

	getDeadline ()

	withDeadline (?\DateTimeImmutable $deadline=null)

	getValidityOfQualification ()

	withValidityOfQualification (?\DateTimeImmutable $date=null)

	hasIndividualModifications ()

	withIndividualModifications (bool $individual)

	isSuccessful ()

	hasValidQualification (\DateTimeImmutable $now)
	There may be no qualification at all (since the PRG is not passed), or the qualification is valid or invalid due to a date. More...

	isRelevant ()

	isFailed ()

	isAccredited ()

	isInProgress ()

	getAchievedPointsOfChildren ()

	getPossiblePointsOfRelevantChildren ()

	invalidate ()

	isInvalidated ()

	withInvalidated (bool $invalidated)

	markAccredited (\DateTimeImmutable $date, int $acting_usr_id)

	unmarkAccredited (\DateTimeImmutable $date, int $acting_usr_id)

	markFailed (\DateTimeImmutable $date, int $acting_usr_id)

	markNotFailed (\DateTimeImmutable $date, int $acting_usr_id)

	succeed (\DateTimeImmutable $date, int $triggering_obj_id)

	markNotRelevant (\DateTimeImmutable $date, int $acting_usr_id)

	markRelevant (\DateTimeImmutable $date, int $acting_usr_id)

Public Member Functions inherited from ILIAS\StudyProgramme\Assignment\Node
	__construct ($id)

	setSubnodes (array $subnodes)

	withContainer (Node $node)
	this is only used internally - do not use apart from constructing the tree! More...

	withSubnode ($node)

	getSubnodes ()

	getSubnode (string $id)

	getPath ()

	findSubnodePath (string $id, ?Node $node=null)

	getId ()

Static Public Member Functions
static	getAllowedTargetStatusFor (int $status_from)

Data Fields
const	STATUS_IN_PROGRESS = 1

const	STATUS_COMPLETED = 2

const	STATUS_ACCREDITED = 3

const	STATUS_NOT_RELEVANT = 4

const	STATUS_FAILED = 5

const	COMPLETED_BY_SUBNODES = -2

const	DATE_TIME_FORMAT = ilPRGAssignment::DATE_TIME_FORMAT

const	DATE_FORMAT = ilPRGAssignment::DATE_FORMAT

Static Public Attributes
static	$STATUS

Protected Attributes
int	$prg_obj_id

int	$points = 0

int	$points_cur = 0

int	$status = 4

int	$completion_by = null

DateTimeImmutable	$last_change

int	$last_change_by = -1

DateTimeImmutable	$assignment_date = null

DateTimeImmutable	$completion_date = null

DateTimeImmutable	$deadline = null

DateTimeImmutable	$vq_date = null

bool	$invalidated = false

bool	$is_individual = false

Protected Attributes inherited from ILIAS\StudyProgramme\Assignment\Node
array	$subnodes = []

Node	$container = null

string	$id

int	$current_points = 0

Additional Inherited Members
Protected Member Functions inherited from ILIAS\StudyProgramme\Assignment\Node
	getContainer ()

Detailed Description

A Progress is the status of a user on a single node of an assignment; it is unique by assignment_id:usr_id:node_id.

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

Constructor & Destructor Documentation

◆ __construct()

ilPRGProgress::__construct	(	int	$prg_obj_id,
		int	$status = `self::STATUS_NOT_RELEVANT`
	)

Definition at line 63 of file class.ilPRGProgress.php.

      {
        $this->prg_obj_id = $prg_obj_id;
        $this->status = $status;
        $this->last_change = new \DateTimeImmutable();
        $this->assignment_date = new \DateTimeImmutable();
        parent::__construct((string) $prg_obj_id, []);
    }

References $prg_obj_id, $status, and ILIAS\GlobalScreen\Provider\__construct().

Here is the call graph for this function:

Member Function Documentation

◆ getAchievedPointsOfChildren()

ilPRGProgress::getAchievedPointsOfChildren ( )

Definition at line 316 of file class.ilPRGProgress.php.

                                                 : int
    {
        $sum = 0;
        $children = $this->getSubnodes();
        foreach ($children as $child_progress) {
            if ($child_progress->isSuccessful()) {
                $sum += $child_progress->getAmountOfPoints();
            }
        }
        return $sum;
    }

Referenced by unmarkAccredited().

Here is the caller graph for this function:

◆ getAllowedTargetStatusFor()

static ilPRGProgress::getAllowedTargetStatusFor ( int $status_from )

static

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

                                                                      : array
    {
        switch ($status_from) {
            case self::STATUS_IN_PROGRESS:
                return [
                    self::STATUS_ACCREDITED,
                    self::STATUS_COMPLETED,
                    self::STATUS_FAILED,
                    self::STATUS_NOT_RELEVANT
                ];
            case self::STATUS_ACCREDITED:
                return [
                    self::STATUS_IN_PROGRESS,
                    self::STATUS_COMPLETED,
                    self::STATUS_FAILED,
                    self::STATUS_NOT_RELEVANT
                ];
            case self::STATUS_COMPLETED:
                return [
                    self::STATUS_IN_PROGRESS, // deaccriditation of sub-progress might revert completion,
                    self::STATUS_NOT_RELEVANT
                ];
            case self::STATUS_FAILED:
                return [
                    self::STATUS_IN_PROGRESS,
                    self::STATUS_COMPLETED, // with re-calculation of deadline, progress might directly be completed.
                    self::STATUS_NOT_RELEVANT
                ];
            case self::STATUS_NOT_RELEVANT:
                return[
                    self::STATUS_IN_PROGRESS
                ];
        }
 
        return [];
    }

References STATUS_ACCREDITED, STATUS_COMPLETED, STATUS_FAILED, STATUS_IN_PROGRESS, and STATUS_NOT_RELEVANT.

Referenced by ilStudyProgrammeIndividualPlanTableGUI\getManualStatusSelect().

Here is the caller graph for this function:

◆ getAmountOfPoints()

ilPRGProgress::getAmountOfPoints ( )

Definition at line 80 of file class.ilPRGProgress.php.

                                       : int
    {
        return $this->points;
    }

References $points.

Referenced by ilStudyProgrammeProgressListGUI\buildProgressBar(), ilStudyProgrammeProgressListGUI\buildProgressStatus(), ilStudyProgrammeProgressListGUI\buildToolTip(), ilObjStudyProgramme\canBeCompleted(), markAccredited(), and ilPRGAssignmentDBRepository\storeProgressRow().

Here is the caller graph for this function:

◆ getAssignmentDate()

ilPRGProgress::getAssignmentDate ( )

Definition at line 202 of file class.ilPRGProgress.php.

                                       : ?\DateTimeImmutable
    {
        return $this->assignment_date;
    }

Referenced by ilPRGAssignmentDBRepository\storeProgressRow(), and updateProgressDeadlineFromSettings().

Here is the caller graph for this function:

◆ getCompletionBy()

ilPRGProgress::getCompletionBy ( )

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

                                     : ?int
    {
        return $this->completion_by;
    }

Referenced by ilStudyProgrammeUserTable\completionByToCollection(), ilStudyProgrammeUserTable\completionByToRepresent(), and ilPRGAssignmentDBRepository\storeProgressRow().

Here is the caller graph for this function:

◆ getCompletionDate()

ilPRGProgress::getCompletionDate ( )

Definition at line 214 of file class.ilPRGProgress.php.

                                       : ?\DateTimeImmutable
    {
        return $this->completion_date;
    }

Referenced by ilPRGAssignmentDBRepository\storeProgressRow().

Here is the caller graph for this function:

◆ getCurrentAmountOfPoints()

ilPRGProgress::getCurrentAmountOfPoints ( )

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

                                              : int
    {
        return $this->points_cur;
    }

References $points_cur.

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

Here is the caller graph for this function:

◆ getDeadline()

ilPRGProgress::getDeadline ( )

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

                                 : ?\DateTimeImmutable
    {
        return $this->deadline;
    }

Referenced by ilPRGAssignmentDBRepository\storeProgressRow().

Here is the caller graph for this function:

◆ getLastChange()

ilPRGProgress::getLastChange ( )

Definition at line 187 of file class.ilPRGProgress.php.

                                   : \DateTimeImmutable
    {
        return $this->last_change;
    }

References $last_change.

Referenced by ilPRGAssignmentDBRepository\storeProgressRow().

Here is the caller graph for this function:

◆ getLastChangeBy()

ilPRGProgress::getLastChangeBy ( )

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

                                     : int
    {
        return $this->last_change_by;
    }

References $last_change_by.

Referenced by ilPRGAssignmentDBRepository\storeProgressRow().

Here is the caller graph for this function:

◆ getNodeId()

ilPRGProgress::getNodeId ( )

Definition at line 74 of file class.ilPRGProgress.php.

                               : int
    {
        return $this->prg_obj_id;
    }

References $prg_obj_id.

Referenced by ilStudyProgrammeIndividualPlanProgressListGUI\buildProgressStatus(), ilStudyProgrammeProgressListGUI\buildProgressStatus(), changeAmountOfPoints(), changeProgressDeadline(), changeProgressValidityDate(), ilStudyProgrammeUserTable\completionByToCollection(), ilStudyProgrammeIndividualPlanTableGUI\fetchData(), markAccredited(), markRelevant(), notifyDeadlineChange(), notifyProgressRevertSuccess(), notifyProgressSuccess(), notifyScoreChange(), notifyValidityChange(), ilStudyProgrammeExpandableProgressListGUI\shouldShowSubProgress(), and ilPRGAssignmentDBRepository\storeProgressRow().

Here is the caller graph for this function:

◆ getPossiblePointsOfRelevantChildren()

ilPRGProgress::getPossiblePointsOfRelevantChildren ( )

Definition at line 328 of file class.ilPRGProgress.php.

                                                         : int
    {
        $sum = 0;
        $children = $this->getSubnodes();
        foreach ($children as $child_progress) {
            if ($child_progress->isRelevant()) {
                $sum += $child_progress->getAmountOfPoints();
            }
        }
        return $sum;
    }

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

Here is the caller graph for this function:

◆ getStatus()

ilPRGProgress::getStatus ( )

Definition at line 114 of file class.ilPRGProgress.php.

                               : int
    {
        return $this->status;
    }

References $status.

Referenced by markAccredited(), ilPRGAssignmentDBRepository\storeProgressRow(), unmarkAccredited(), and withStatus().

Here is the caller graph for this function:

◆ getValidityOfQualification()

ilPRGProgress::getValidityOfQualification ( )

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

                                                : ?\DateTimeImmutable
    {
        return $this->vq_date;
    }

Referenced by markAccredited(), and ilPRGAssignmentDBRepository\storeProgressRow().

Here is the caller graph for this function:

◆ hasIndividualModifications()

ilPRGProgress::hasIndividualModifications ( )

Definition at line 258 of file class.ilPRGProgress.php.

                                                : bool
    {
        return $this->is_individual;
    }

Referenced by ilPRGAssignmentDBRepository\storeProgressRow().

Here is the caller graph for this function:

◆ hasValidQualification()

ilPRGProgress::hasValidQualification ( \DateTimeImmutable $now )

There may be no qualification at all (since the PRG is not passed), or the qualification is valid or invalid due to a date.

Definition at line 285 of file class.ilPRGProgress.php.

                                                                  : ?bool
    {
        if (!$this->isSuccessful()) {
            return null;
        }
        return (
            is_null($this->getValidityOfQualification()) ||
            $this->getValidityOfQualification()->format(self::DATE_FORMAT) >= $now->format(self::DATE_FORMAT)
        );
    }

◆ invalidate()

ilPRGProgress::invalidate ( )

Definition at line 340 of file class.ilPRGProgress.php.

                                : self
    {
        if (!$this->vq_date) {
            throw new ilException("may not invalidate non-expired progress (no invalidation date)");
        }
        if ($this->vq_date->format(self::DATE_FORMAT) > date(self::DATE_FORMAT)) {
            $msg = $this->vq_date->format(self::DATE_FORMAT) . ' > ' . date(self::DATE_FORMAT);
            throw new ilException("may not invalidate non-expired progress ($msg)");
        }
        return $this->withInvalidated(true);
    }

◆ isAccredited()

ilPRGProgress::isAccredited ( )

Definition at line 306 of file class.ilPRGProgress.php.

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

◆ isFailed()

ilPRGProgress::isFailed ( )

Definition at line 301 of file class.ilPRGProgress.php.

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

◆ isInProgress()

ilPRGProgress::isInProgress ( )

Definition at line 311 of file class.ilPRGProgress.php.

                                  : bool
    {
        return $this->getStatus() == self::STATUS_IN_PROGRESS;
    }

◆ isInvalidated()

ilPRGProgress::isInvalidated ( )

Definition at line 352 of file class.ilPRGProgress.php.

                                   : bool
    {
        return $this->invalidated;
    }

Referenced by ilPRGAssignmentDBRepository\storeProgressRow(), and ilStudyProgrammeUserTable\validToRepresent().

Here is the caller graph for this function:

◆ isRelevant()

ilPRGProgress::isRelevant ( )

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

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

Referenced by markAccredited(), ilStudyProgrammeExpandableProgressListGUI\shouldShowSubProgress(), and unmarkAccredited().

Here is the caller graph for this function:

◆ isSuccessful()

ilPRGProgress::isSuccessful ( )

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

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

Referenced by ilStudyProgrammeProgressListGUI\buildProgressBar(), ilStudyProgrammeIndividualPlanProgressListGUI\buildProgressStatus(), ilStudyProgrammeUserTable\completionByToCollection(), ilStudyProgrammeIndividualPlanTableGUI\fetchData(), and ilStudyProgrammeUserTable\validToRepresent().

Here is the caller graph for this function:

◆ isTransitionAllowedTo()

ilPRGProgress::isTransitionAllowedTo ( int $new_status )

Definition at line 138 of file class.ilPRGProgress.php.

                                                          : bool
    {
        return is_null($this->status) ||
            $this->status === $new_status ||
            in_array($new_status, self::getAllowedTargetStatusFor($this->status));
    }

Referenced by markAccredited(), unmarkAccredited(), and withStatus().

Here is the caller graph for this function:

◆ markAccredited()

ilPRGProgress::markAccredited	(	\DateTimeImmutable	$date,
		int	$acting_usr_id
	)

Definition at line 364 of file class.ilPRGProgress.php.

                                                                                : self
    {
        return $this
            ->withStatus(self::STATUS_ACCREDITED)
            ->withCompletion($acting_usr_id, $date)
            ->withLastChange($acting_usr_id, $date);
    }

Referenced by markAccredited().

Here is the caller graph for this function:

◆ markFailed()

ilPRGProgress::markFailed	(	\DateTimeImmutable	$date,
		int	$acting_usr_id
	)

Definition at line 381 of file class.ilPRGProgress.php.

                                                                            : self
    {
        return $this
            ->withStatus(self::STATUS_FAILED)
            ->withCompletion(null, null)
            ->withLastChange($acting_usr_id, $date);
    }

◆ markNotFailed()

ilPRGProgress::markNotFailed	(	\DateTimeImmutable	$date,
		int	$acting_usr_id
	)

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

                                                                               : self
    {
        return $this
            ->withStatus(self::STATUS_IN_PROGRESS)
            ->withCompletion(null, null)
            ->withLastChange($acting_usr_id, $date);
    }

◆ markNotRelevant()

ilPRGProgress::markNotRelevant	(	\DateTimeImmutable	$date,
		int	$acting_usr_id
	)

Definition at line 405 of file class.ilPRGProgress.php.

                                                                                 : self
    {
        return $this
            ->withStatus(self::STATUS_NOT_RELEVANT)
            ->withLastChange($acting_usr_id, $date)
            ->withValidityOfQualification(null)
            ->withDeadline(null)
            ->withCompletion(null, null)
            ->withCurrentAmountOfPoints(0)
            ->withIndividualModifications(true);
    }

◆ markRelevant()

ilPRGProgress::markRelevant	(	\DateTimeImmutable	$date,
		int	$acting_usr_id
	)

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

                                                                              : self
    {
        return $this
            ->withStatus(self::STATUS_IN_PROGRESS)
            ->withCompletion(null, null)
            ->withLastChange($acting_usr_id, $date)
            ->withIndividualModifications(true);
    }

◆ succeed()

ilPRGProgress::succeed	(	\DateTimeImmutable	$date,
		int	$triggering_obj_id
	)

Definition at line 397 of file class.ilPRGProgress.php.

                                                                             : self
    {
        return $this
            ->withStatus(self::STATUS_COMPLETED)
            ->withCompletion($triggering_obj_id, $date)
            ->withLastChange($triggering_obj_id, $date);
    }

◆ unmarkAccredited()

ilPRGProgress::unmarkAccredited	(	\DateTimeImmutable	$date,
		int	$acting_usr_id
	)

Definition at line 372 of file class.ilPRGProgress.php.

                                                                                  : self
    {
        return $this
            ->withStatus(self::STATUS_IN_PROGRESS)
            ->withCompletion(null, null)
            ->withValidityOfQualification(null)
            ->withLastChange($acting_usr_id, $date);
    }

Referenced by unmarkAccredited().

Here is the caller graph for this function:

◆ withAmountOfPoints()

ilPRGProgress::withAmountOfPoints ( int $points )

Definition at line 85 of file class.ilPRGProgress.php.

                                                   : self
    {
        if ($points < 0) {
            throw new ilException("ilPRGProgress::setAmountOfPoints: "
                                 . "Expected a number >= 0 as argument, got '$points'");
        }
 
        $clone = clone $this;
        $clone->points = $points;
        return $clone;
    }

References $points.

Referenced by ilStudyProgrammeAssignmentActionsTest\getProgressesWithDefaultStatus().

Here is the caller graph for this function:

◆ withAssignmentDate()

ilPRGProgress::withAssignmentDate ( ?\DateTimeImmutable $assignment_date )

Definition at line 207 of file class.ilPRGProgress.php.

                                                                            : self
    {
        $clone = clone $this;
        $clone->assignment_date = $assignment_date;
        return $clone;
    }

Referenced by initAssignmentDates().

Here is the caller graph for this function:

◆ withCompletion()

ilPRGProgress::withCompletion	(	?int	$usr_or_obj_id = `null`,
		?\DateTimeImmutable	$completion_date = `null`
	)

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

     : self {
        $clone = clone $this;
        $clone->completion_by = $usr_or_obj_id;
        $clone->completion_date = $completion_date;
        return $clone;
    }

◆ withCurrentAmountOfPoints()

ilPRGProgress::withCurrentAmountOfPoints ( int $points_cur )

Definition at line 102 of file class.ilPRGProgress.php.

                                                              : self
    {
        if ($points_cur < 0) {
            throw new ilException("ilPRGProgress::setAmountOfPoints: "
                                 . "Expected a number >= 0 as argument, got '$points'");
        }
 
        $clone = clone $this;
        $clone->points_cur = $points_cur;
        return $clone;
    }

References $points_cur.

◆ withDeadline()

ilPRGProgress::withDeadline ( ?\DateTimeImmutable $deadline = null )

Definition at line 239 of file class.ilPRGProgress.php.

                                                                      : self
    {
        $clone = clone $this;
        $clone->deadline = $deadline;
        return $clone;
    }

◆ withIndividualModifications()

ilPRGProgress::withIndividualModifications ( bool $individual )

Definition at line 263 of file class.ilPRGProgress.php.

                                                                 : self
    {
        $clone = clone $this;
        $clone->is_individual = $individual;
        return $clone;
    }

◆ withInvalidated()

ilPRGProgress::withInvalidated ( bool $invalidated )

Definition at line 357 of file class.ilPRGProgress.php.

                                                      : self
    {
        $clone = clone $this;
        $clone->invalidated = $invalidated;
        return $clone;
    }

◆ withLastChange()

ilPRGProgress::withLastChange	(	int	$last_change_by,
		\DateTimeImmutable	$last_change
	)

Definition at line 192 of file class.ilPRGProgress.php.

     : self {
        $clone = clone $this;
        $clone->last_change = $last_change;
        $clone->last_change_by = $last_change_by;
        return $clone;
    }

◆ withStatus()

ilPRGProgress::withStatus ( int $status )

Definition at line 119 of file class.ilPRGProgress.php.

                                           : self
    {
        if (!in_array($status, self::$STATUS)) {
            throw new ilException("No such status: " . "'$status'");
        }
 
        if (!$this->isTransitionAllowedTo($status)) {
            throw new ilException(
                "Changing progress with status " . $this->getStatus()
                . " cannot change to status " . "'$status'"
                . ' (progress_id: ' . $this->getId() . ')'
            );
        }
 
        $clone = clone $this;
        $clone->status = $status;
        return $clone;
    }

References $status, ILIAS\StudyProgramme\Assignment\Node\getId(), getStatus(), and isTransitionAllowedTo().

Referenced by updateProgressRelevanceFromSettings().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ withValidityOfQualification()

ilPRGProgress::withValidityOfQualification ( ?\DateTimeImmutable $date = null )

Definition at line 251 of file class.ilPRGProgress.php.

                                                                                 : self
    {
        $clone = clone $this;
        $clone->vq_date = $date;
        return $clone;
    }

Field Documentation

◆ $assignment_date

DateTimeImmutable ilPRGProgress::$assignment_date = null

protected

Definition at line 55 of file class.ilPRGProgress.php.

◆ $completion_by

int ilPRGProgress::$completion_by = null

protected

Definition at line 52 of file class.ilPRGProgress.php.

◆ $completion_date

DateTimeImmutable ilPRGProgress::$completion_date = null

protected

Definition at line 56 of file class.ilPRGProgress.php.

◆ $deadline

DateTimeImmutable ilPRGProgress::$deadline = null

protected

Definition at line 57 of file class.ilPRGProgress.php.

◆ $invalidated

bool ilPRGProgress::$invalidated = false

protected

Definition at line 59 of file class.ilPRGProgress.php.

◆ $is_individual

bool ilPRGProgress::$is_individual = false

protected

Definition at line 60 of file class.ilPRGProgress.php.

◆ $last_change

DateTimeImmutable ilPRGProgress::$last_change

protected

Definition at line 53 of file class.ilPRGProgress.php.

Referenced by getLastChange().

◆ $last_change_by

int ilPRGProgress::$last_change_by = -1

protected

Definition at line 54 of file class.ilPRGProgress.php.

Referenced by getLastChangeBy().

◆ $points

int ilPRGProgress::$points = 0

protected

Definition at line 49 of file class.ilPRGProgress.php.

Referenced by getAmountOfPoints(), and withAmountOfPoints().

◆ $points_cur

int ilPRGProgress::$points_cur = 0

protected

Definition at line 50 of file class.ilPRGProgress.php.

Referenced by getCurrentAmountOfPoints(), and withCurrentAmountOfPoints().

◆ $prg_obj_id

int ilPRGProgress::$prg_obj_id

protected

Definition at line 48 of file class.ilPRGProgress.php.

Referenced by __construct(), and getNodeId().

◆ $STATUS

ilPRGProgress::$STATUS

static

Initial value:

= [
        self::STATUS_IN_PROGRESS,
        self::STATUS_COMPLETED,
        self::STATUS_ACCREDITED,
        self::STATUS_NOT_RELEVANT,
        self::STATUS_FAILED
    ]

Definition at line 35 of file class.ilPRGProgress.php.

◆ $status

int ilPRGProgress::$status = 4

protected

Definition at line 51 of file class.ilPRGProgress.php.

Referenced by __construct(), getStatus(), and withStatus().

◆ $vq_date

DateTimeImmutable ilPRGProgress::$vq_date = null

protected

Definition at line 58 of file class.ilPRGProgress.php.

◆ COMPLETED_BY_SUBNODES

const ilPRGProgress::COMPLETED_BY_SUBNODES = -2

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

Referenced by ilStudyProgrammeUserTable\completionByToCollection(), ilStudyProgrammeUserTable\completionByToRepresent(), and ilStudyProgrammeIndividualPlanTableGUI\fetchData().

◆ DATE_FORMAT

const ilPRGProgress::DATE_FORMAT = ilPRGAssignment::DATE_FORMAT

Definition at line 46 of file class.ilPRGProgress.php.

Referenced by ilPRGAssignmentDBRepository\buildProgressByRow(), ilPRGAssignmentDBRepository\getPassedDeadline(), ilPRGAssignmentDBRepository\storeProgressRow(), and updateParentProgresses().

◆ DATE_TIME_FORMAT

const ilPRGProgress::DATE_TIME_FORMAT = ilPRGAssignment::DATE_TIME_FORMAT

Definition at line 45 of file class.ilPRGProgress.php.

Referenced by ilPRGAssignmentDBRepository\buildProgressByRow(), ilPRGAssignmentDBRepository\storeProgressRow(), ilStudyProgrammeProgressTest\testPRGProgressStatusActionsMarkAccredited(), ilStudyProgrammeProgressTest\testPRGProgressStatusActionsMarkFailed(), ilStudyProgrammeProgressTest\testPRGProgressStatusActionsMarkNotFailed(), ilStudyProgrammeProgressTest\testPRGProgressStatusActionsMarkNotRelevant(), ilStudyProgrammeProgressTest\testPRGProgressStatusActionsMarkRelevant(), ilStudyProgrammeProgressTest\testPRGProgressStatusActionsSucceed(), and ilStudyProgrammeProgressTest\testPRGProgressStatusActionsUnmarkAccredited().

◆ STATUS_ACCREDITED

const ilPRGProgress::STATUS_ACCREDITED = 3

Definition at line 31 of file class.ilPRGProgress.php.

◆ STATUS_COMPLETED

const ilPRGProgress::STATUS_COMPLETED = 2

Definition at line 30 of file class.ilPRGProgress.php.

Referenced by getAllowedTargetStatusFor(), ilPRGAssignmentDBRepository\getCertificateRelevantAssignmentIds(), ilPRGAssignmentDBRepository\getExpiredAndNotInvalidated(), ilPRGAssignmentFilter\getItemConfig(), ilStudyProgrammeProgressTest\ilPRGProgressStatus(), ilStudyProgrammeDashboardViewGUI\initData(), ilObjStudyProgramme\statusToRepr(), ilStudyProgrammeMailTemplateContext\statusToRepr(), ilStudyProgrammeUserTable\statusToRepresent(), ilStudyProgrammeCronAboutToExpireTest\testAboutToExpireEvents(), ilStudyProgrammeCronAboutToExpireTest\testAboutToExpireForRelevantProgrammes(), ilStudyProgrammeAssignmentActionsTest\testPRGAssignmentActionsMarkAccredited(), ilStudyProgrammeAssignmentActionsTest\testPRGAssignmentActionsSucceedAndDeadline(), ilStudyProgrammeProgressTest\testPRGProgressAllowedTransitionsForAccredited(), ilStudyProgrammeProgressTest\testPRGProgressAllowedTransitionsForCompleted(), ilStudyProgrammeProgressTest\testPRGProgressAllowedTransitionsForFailed(), ilStudyProgrammeProgressTest\testPRGProgressAllowedTransitionsForInProgress(), ilStudyProgrammeProgressTest\testPRGProgressHasValidQualification(), ilStudyProgrammeProgressTest\testPRGProgressInvalidation(), ilStudyProgrammeProgressTest\testPRGProgressInvalidInvalidation(), ilStudyProgrammeProgressTest\testPRGProgressPointsOfChildren(), ilStudyProgrammeProgressTest\testPRGProgressProperties(), ilStudyProgrammeProgressTest\testPRGProgressStatusActionsSucceed(), ilPrgRestartAssignmentsCronJobTest\testRestartAssignmentsEvents(), ilPrgRestartAssignmentsCronJobTest\testRestartAssignmentsForRelevantProgrammes(), ilStudyProgrammeCronRiskyToFailTest\testRiskyToFailEvents(), ilStudyProgrammeCronRiskyToFailTest\testRiskyToFailForRelevantProgrammes(), ilPRGAssignmentFilter\toConditions(), and unmarkAccredited().

◆ STATUS_FAILED

const ilPRGProgress::STATUS_FAILED = 5

Definition at line 33 of file class.ilPRGProgress.php.

Referenced by getAllowedTargetStatusFor(), ilPRGAssignmentFilter\getItemConfig(), ilStudyProgrammeProgressTest\ilPRGProgressStatus(), ilObjStudyProgramme\statusToRepr(), ilStudyProgrammeMailTemplateContext\statusToRepr(), ilStudyProgrammeUserTable\statusToRepresent(), ilStudyProgrammeAssignmentActionsTest\testPRGAssignmentActionsSucceedAndDeadline(), ilStudyProgrammeProgressTest\testPRGProgressAllowedTransitionsForAccredited(), ilStudyProgrammeProgressTest\testPRGProgressAllowedTransitionsForFailed(), ilStudyProgrammeProgressTest\testPRGProgressAllowedTransitionsForInProgress(), ilStudyProgrammeProgressTest\testPRGProgressStatusActionsMarkFailed(), and ilStudyProgrammeProgressTest\testPRGProgressStatusChecker().

◆ STATUS_IN_PROGRESS

const ilPRGProgress::STATUS_IN_PROGRESS = 1

Definition at line 29 of file class.ilPRGProgress.php.

◆ STATUS_NOT_RELEVANT

const ilPRGProgress::STATUS_NOT_RELEVANT = 4

Definition at line 32 of file class.ilPRGProgress.php.

The documentation for this class was generated from the following file:

components/ILIAS/StudyProgramme/classes/model/Assignments/class.ilPRGProgress.php

Public Member Functions

Static Public Member Functions

Data Fields

Static Public Attributes

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getAchievedPointsOfChildren()

◆ getAllowedTargetStatusFor()

◆ getAmountOfPoints()

◆ getAssignmentDate()

◆ getCompletionBy()

◆ getCompletionDate()

◆ getCurrentAmountOfPoints()

◆ getDeadline()

◆ getLastChange()

◆ getLastChangeBy()

◆ getNodeId()

◆ getPossiblePointsOfRelevantChildren()

◆ getStatus()

◆ getValidityOfQualification()

◆ hasIndividualModifications()

◆ hasValidQualification()

◆ invalidate()

◆ isAccredited()

◆ isFailed()

◆ isInProgress()

◆ isInvalidated()

◆ isRelevant()

◆ isSuccessful()

◆ isTransitionAllowedTo()

◆ markAccredited()

◆ markFailed()

◆ markNotFailed()

◆ markNotRelevant()

◆ markRelevant()

◆ succeed()

◆ unmarkAccredited()

◆ withAmountOfPoints()

◆ withAssignmentDate()

◆ withCompletion()

◆ withCurrentAmountOfPoints()

◆ withDeadline()

◆ withIndividualModifications()

◆ withInvalidated()

◆ withLastChange()

◆ withStatus()

◆ withValidityOfQualification()

Field Documentation

◆ $assignment_date

◆ $completion_by

◆ $completion_date

◆ $deadline

◆ $invalidated

◆ $is_individual

◆ $last_change

◆ $last_change_by

◆ $points

◆ $points_cur

◆ $prg_obj_id

◆ $STATUS

◆ $status

◆ $vq_date

◆ COMPLETED_BY_SUBNODES

◆ DATE_FORMAT

◆ DATE_TIME_FORMAT

◆ STATUS_ACCREDITED

◆ STATUS_COMPLETED

◆ STATUS_FAILED

◆ STATUS_IN_PROGRESS

◆ STATUS_NOT_RELEVANT