ilPRGProgress Class Reference

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.

References $prg_obj_id, $status, and ILIAS\MetaData\Repository\Validation\Data\__construct().

      {
        $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, []);
    }

Here is the call graph for this function:

Member Function Documentation

getAchievedPointsOfChildren()

ilPRGProgress::getAchievedPointsOfChildren

(

)

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

References ILIAS\StudyProgramme\Assignment\Node\getSubnodes().

Referenced by recalculateProgressStatus().

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

Here is the call graph for this function:

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.

Referenced by ilStudyProgrammeIndividualPlanTableGUI\getManualStatusSelect().

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

Here is the caller graph for this function:

getAmountOfPoints()

ilPRGProgress::getAmountOfPoints

(

)

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

References $points.

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

                                       : int
    {
        return $this->points;
    }

Here is the caller graph for this function:

getAssignmentDate()

ilPRGProgress::getAssignmentDate

(

)

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

References $assignment_date.

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

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

Here is the caller graph for this function:

getCompletionBy()

ilPRGProgress::getCompletionBy

(

)

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

References $completion_by.

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

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

Here is the caller graph for this function:

getCompletionDate()

ilPRGProgress::getCompletionDate

(

)

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

References $completion_date.

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

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

Here is the caller graph for this function:

getCurrentAmountOfPoints()

ilPRGProgress::getCurrentAmountOfPoints

(

)

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

References $points_cur.

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

                                              : int
    {
        return $this->points_cur;
    }

Here is the caller graph for this function:

getDeadline()

ilPRGProgress::getDeadline

(

)

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

References $deadline.

Referenced by applyProgressDeadline(), ilPRGActionNoteBuilder\sortByDeadline(), ilPRGAssignmentDBRepository\storeProgressRow(), and succeed().

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

Here is the caller graph for this function:

getLastChange()

ilPRGProgress::getLastChange

(

)

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

References $last_change.

Referenced by ilPRGAssignmentDBRepository\storeProgressRow().

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

Here is the caller graph for this function:

getLastChangeBy()

ilPRGProgress::getLastChangeBy

(

)

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

References $last_change_by.

Referenced by ilPRGAssignmentDBRepository\storeProgressRow().

                                     : int
    {
        return $this->last_change_by;
    }

Here is the caller graph for this function:

getNodeId()

ilPRGProgress::getNodeId

(

)

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

References $prg_obj_id.

Referenced by applyProgressDeadline(), ilStudyProgrammeIndividualPlanProgressListGUI\buildProgressStatus(), ilStudyProgrammeProgressListGUI\buildProgressStatus(), ilStudyProgrammeUserTable\completionByToCollection(), ilStudyProgrammeIndividualPlanTableGUI\fetchData(), notifyDeadlineChange(), notifyProgressRevertSuccess(), notifyProgressSuccess(), notifyScoreChange(), notifyValidityChange(), recalculateProgressStatus(), resetProgressToSettings(), ilStudyProgrammeExpandableProgressListGUI\shouldShowSubProgress(), ilPRGAssignmentDBRepository\storeProgressRow(), and updateProgressRelevanceFromSettings().

                               : int
    {
        return $this->prg_obj_id;
    }

Here is the caller graph for this function:

getPossiblePointsOfRelevantChildren()

ilPRGProgress::getPossiblePointsOfRelevantChildren

(

)

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

References ILIAS\StudyProgramme\Assignment\Node\getSubnodes().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getStatus()

ilPRGProgress::getStatus

(

)

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

References $status.

Referenced by applyProgressDeadline(), isAccredited(), isFailed(), isInProgress(), isRelevant(), isSuccessful(), recalculateProgressStatus(), ilPRGAssignmentDBRepository\storeProgressRow(), and withStatus().

                               : int
    {
        return $this->status;
    }

Here is the caller graph for this function:

getValidityOfQualification()

ilPRGProgress::getValidityOfQualification

(

)

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

References $vq_date.

Referenced by hasValidQualification(), recalculateProgressStatus(), and ilPRGAssignmentDBRepository\storeProgressRow().

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

Here is the caller graph for this function:

hasIndividualModifications()

ilPRGProgress::hasIndividualModifications

(

)

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

References $is_individual.

Referenced by ilPRGAssignmentDBRepository\storeProgressRow().

                                                : bool
    {
        return $this->is_individual;
    }

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.

References getValidityOfQualification(), and isSuccessful().

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

Here is the call graph for this function:

invalidate()

ilPRGProgress::invalidate

(

)

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

References withInvalidated().

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

Here is the call graph for this function:

isAccredited()

ilPRGProgress::isAccredited

(

)

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

References getStatus().

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

Here is the call graph for this function:

isFailed()

ilPRGProgress::isFailed

(

)

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

References getStatus().

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

Here is the call graph for this function:

isInProgress()

ilPRGProgress::isInProgress

(

)

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

References getStatus().

Referenced by updateProgressRelevanceFromSettings().

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

Here is the call graph for this function:

Here is the caller graph for this function:

isInvalidated()

ilPRGProgress::isInvalidated

(

)

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

References $invalidated.

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

                                   : bool
    {
        return $this->invalidated;
    }

Here is the caller graph for this function:

isRelevant()

ilPRGProgress::isRelevant

(

)

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

References getStatus().

Referenced by recalculateProgressStatus(), resetProgressToSettings(), ilStudyProgrammeExpandableProgressListGUI\shouldShowSubProgress(), and updateProgressRelevanceFromSettings().

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

Here is the call graph for this function:

Here is the caller graph for this function:

isSuccessful()

ilPRGProgress::isSuccessful

(

)

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

References getStatus().

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

isTransitionAllowedTo()

ilPRGProgress::isTransitionAllowedTo

(

int

$new_status

)

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

Referenced by withStatus().

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

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

markFailed()

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

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

Referenced by applyProgressDeadline().

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

Here is the caller graph for this function:

markNotFailed()

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

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

Referenced by applyProgressDeadline().

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

Here is the caller graph for this function:

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

withAmountOfPoints()

ilPRGProgress::withAmountOfPoints

(

int

$points

)

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

References $points.

Referenced by ilStudyProgrammeAssignmentActionsTest\getProgressesWithDefaultStatus(), and resetProgressToSettings().

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

Here is the caller graph for this function:

withAssignmentDate()

ilPRGProgress::withAssignmentDate

(

?\DateTimeImmutable

$assignment_date

)

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

References $assignment_date.

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

withCompletion()

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

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

References $completion_date.

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

References $points_cur.

Referenced by recalculateProgressStatus(), and resetProgressToSettings().

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

Here is the caller graph for this function:

withDeadline()

ilPRGProgress::withDeadline

(

?\DateTimeImmutable

$deadline = null

)

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

References $deadline.

Referenced by updateProgressDeadlineFromSettings().

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

Here is the caller graph for this function:

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.

References $invalidated.

Referenced by invalidate().

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

Here is the caller graph for this function:

withLastChange()

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

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

References $last_change, and $last_change_by.

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

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

Referenced by recalculateProgressStatus(), and updateProgressRelevanceFromSettings().

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

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.

Referenced by resetProgressToSettings(), and updateProgressValidityFromSettings().

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

Here is the caller graph for this function:

Field Documentation

$assignment_date

DateTimeImmutable ilPRGProgress::$assignment_date = null

protected

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

Referenced by getAssignmentDate(), and withAssignmentDate().

$completion_by

int ilPRGProgress::$completion_by = null

protected

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

Referenced by getCompletionBy().

$completion_date

DateTimeImmutable ilPRGProgress::$completion_date = null

protected

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

Referenced by getCompletionDate(), and withCompletion().

$deadline

DateTimeImmutable ilPRGProgress::$deadline = null

protected

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

Referenced by getDeadline(), and withDeadline().

$invalidated

bool ilPRGProgress::$invalidated = false

protected

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

Referenced by isInvalidated(), and withInvalidated().

$is_individual

bool ilPRGProgress::$is_individual = false

protected

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

Referenced by hasIndividualModifications().

$last_change

DateTimeImmutable ilPRGProgress::$last_change

protected

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

Referenced by getLastChange(), and withLastChange().

$last_change_by

int ilPRGProgress::$last_change_by = -1

protected

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

Referenced by getLastChangeBy(), and withLastChange().

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

Referenced by getValidityOfQualification().

COMPLETED_BY_SUBNODES

const ilPRGProgress::COMPLETED_BY_SUBNODES = -2

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

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

DATE_FORMAT

const ilPRGProgress::DATE_FORMAT = ilPRGAssignment::DATE_FORMAT

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

Referenced by applyProgressDeadline(), ilPRGAssignmentDBRepository\buildProgressByRow(), changeProgressValidityDate(), ilPRGAssignmentDBRepository\getPassedDeadline(), ilPRGAssignmentDBRepository\getRiskyToFail(), markProgressesFailedForExpiredDeadline(), ilPRGAssignmentDBRepository\storeProgressRow(), succeed(), updateParentProgresses(), and updateProgressValidityFromSettings().

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.

Referenced by ilPRGAssignmentDBRepository\getCertificateRelevantAssignmentIds(), ilPRGAssignmentDBRepository\getExpiredAndNotInvalidated(), ilPRGAssignmentFilter\getItemConfig(), ilStudyProgrammeIndividualPlanTableGUI\getManualStatusSelect(), ilPRGAssignmentDBRepository\getPassedDeadline(), ilStudyProgrammeMembersTableGUI\getPossibleActions(), ilPRGAssignmentDBRepository\getRiskyToFail(), ilStudyProgrammeDashboardViewGUI\initData(), markAccredited(), recalculateProgressStatus(), ilStudyProgrammeProgressTest\status(), ilStudyProgrammeMailTemplateContext\statusToRepr(), ilObjStudyProgramme\statusToRepr(), ilStudyProgrammeUserTable\statusToRepresent(), ilStudyProgrammeAssignmentActionsTest\testPRGAssignmentActionsMarkAccredited(), ilStudyProgrammeProgressTest\testPRGProgressAllowedTransitionsForAccredited(), ilStudyProgrammeProgressTest\testPRGProgressAllowedTransitionsForInProgress(), ilStudyProgrammeProgressTest\testPRGProgressStatusActionsMarkAccredited(), ilStudyProgrammeProgressTest\testPRGProgressStatusChecker(), ilPRGAssignmentFilter\toConditions(), and ilObjStudyProgrammeIndividualPlanGUI\updateStatus().

STATUS_COMPLETED

const ilPRGProgress::STATUS_COMPLETED = 2

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

Referenced by ilPRGAssignmentDBRepository\getCertificateRelevantAssignmentIds(), ilPRGAssignmentDBRepository\getExpiredAndNotInvalidated(), ilPRGAssignmentFilter\getItemConfig(), ilStudyProgrammeMembersTableGUI\getPossibleActions(), ilPRGAssignmentDBRepository\getRiskyToFail(), ilStudyProgrammeDashboardViewGUI\initData(), markNotRelevant(), recalculateProgressStatus(), ilStudyProgrammeProgressTest\status(), ilStudyProgrammeMailTemplateContext\statusToRepr(), ilObjStudyProgramme\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 applyProgressDeadline(), ilPRGAssignmentFilter\getItemConfig(), ilStudyProgrammeProgressTest\status(), ilStudyProgrammeMailTemplateContext\statusToRepr(), ilObjStudyProgramme\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.

Referenced by applyProgressDeadline(), ilPRGAssignmentFilter\getItemConfig(), ilStudyProgrammeIndividualPlanTableGUI\getManualStatusSelect(), ilPRGAssignmentDBRepository\getPassedDeadline(), ilStudyProgrammeMembersTableGUI\getPossibleActions(), ilStudyProgrammeIndividualPlanTableGUI\getRequiredPointsInput(), recalculateProgressStatus(), ilStudyProgrammeProgressTest\status(), ilStudyProgrammeMailTemplateContext\statusToRepr(), ilObjStudyProgramme\statusToRepr(), ilStudyProgrammeUserTable\statusToRepresent(), ilStudyProgrammeAssignmentActionsTest\testPRGAssignmentActionsMarkAccredited(), ilStudyProgrammeAssignmentActionsTest\testPRGAssignmentActionsMarkRelevant(), ilStudyProgrammeAssignmentActionsTest\testPRGAssignmentActionsSucceedAndDeadline(), ilStudyProgrammeProgressTest\testPRGProgressAllowedTransitionsForAccredited(), ilStudyProgrammeProgressTest\testPRGProgressAllowedTransitionsForCompleted(), ilStudyProgrammeProgressTest\testPRGProgressAllowedTransitionsForFailed(), ilStudyProgrammeProgressTest\testPRGProgressAllowedTransitionsForInProgress(), ilStudyProgrammeProgressTest\testPRGProgressAllowedTransitionsForIrrelevant(), ilStudyProgrammeProgressTest\testPRGProgressHasValidQualification(), ilStudyProgrammeProgressTest\testPRGProgressInvalidation(), ilStudyProgrammeProgressTest\testPRGProgressPointsOfChildren(), ilStudyProgrammeProgressTest\testPRGProgressProperties(), ilStudyProgrammeProgressTest\testPRGProgressStatusActionsMarkAccredited(), ilStudyProgrammeProgressTest\testPRGProgressStatusActionsMarkFailed(), ilStudyProgrammeProgressTest\testPRGProgressStatusActionsMarkNotFailed(), ilStudyProgrammeProgressTest\testPRGProgressStatusActionsMarkNotRelevant(), ilStudyProgrammeProgressTest\testPRGProgressStatusActionsMarkRelevant(), ilStudyProgrammeProgressTest\testPRGProgressStatusActionsSucceed(), ilStudyProgrammeProgressTest\testPRGProgressStatusActionsUnmarkAccredited(), ilStudyProgrammeProgressTest\testPRGProgressStatusChecker(), unmarkAccredited(), updateProgressRelevanceFromSettings(), and ilObjStudyProgrammeIndividualPlanGUI\updateStatus().

STATUS_NOT_RELEVANT

const ilPRGProgress::STATUS_NOT_RELEVANT = 4

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

Referenced by ilPRGAssignmentFilter\getItemConfig(), ilStudyProgrammeIndividualPlanTableGUI\getManualStatusSelect(), ilStudyProgrammeMembersTableGUI\getPossibleActions(), ilPRGAssignmentDBRepository\getRiskyToFail(), ilStudyProgrammeAssignmentActionsTest\setUp(), ilStudyProgrammeProgressTest\status(), ilStudyProgrammeMailTemplateContext\statusToRepr(), ilObjStudyProgramme\statusToRepr(), ilStudyProgrammeUserTable\statusToRepresent(), ilStudyProgrammeAssignmentActionsTest\testPRGAssignmentActionsMarkRelevant(), ilStudyProgrammeProgressTest\testPRGProgressAllowedTransitionsForAccredited(), ilStudyProgrammeProgressTest\testPRGProgressAllowedTransitionsForCompleted(), ilStudyProgrammeProgressTest\testPRGProgressAllowedTransitionsForFailed(), ilStudyProgrammeProgressTest\testPRGProgressAllowedTransitionsForInProgress(), ilStudyProgrammeProgressTest\testPRGProgressAllowedTransitionsForIrrelevant(), ilStudyProgrammeProgressTest\testPRGProgressPointsOfChildren(), ilStudyProgrammeProgressTest\testPRGProgressStatusActionsMarkNotRelevant(), ilStudyProgrammeProgressTest\testPRGProgressStatusChecker(), ilPRGAssignmentFilter\toConditions(), updateProgressRelevanceFromSettings(), and ilObjStudyProgrammeIndividualPlanGUI\updateStatus().

---

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

• Modules/StudyProgramme/classes/model/Assignments/class.ilPRGProgress.php