ilStudyProgrammeProgress Class Reference

Class ilStudyProgrammeProgress. More...

Collaboration diagram for ilStudyProgrammeProgress:

Public Member Functions
	__construct (int $id)
	getId ()
	Get the id of the progress. More...
	getAssignmentId ()
	Get the assignment this progress belongs to. More...
	withAssignmentId (int $assignment_id)
	getNodeId ()
	Get the obj_id of the program node this progress belongs to. More...
	withNodeId (int $prg_id)
	getUserId ()
	Get the id of the user this progress is for. More...
	withUserId (int $usr_id)
	getAmountOfPoints ()
	Get the amount of points the user needs to achieve on the subnodes of this node. More...
	withAmountOfPoints (int $points)
	Throws when amount of points is smaller then zero. More...
	getCurrentAmountOfPoints ()
	withCurrentAmountOfPoints (int $points_cur)
	Set the amount of points the user currently has achieved on this node. More...
	getStatus ()
	Get the status the user has on this node. More...
	withStatus (int $status)
	Set the status of this node. More...
	isTransitionAllowedTo (int $new_status)
	getLastChangeBy ()
	Get the id of the user/object who/which invoked the last change on this assignment. More...
	getLastChange ()
	withLastChange (int $last_change_by, DateTimeImmutable $timestamp)
	getAssignmentDate ()
	withAssignmentDate (DateTimeImmutable $assignment_date)
	getCompletionDate ()
	getCompletionBy ()
	Get the id of object or user that lead to the successful completion of this node. More...
	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 ()
	invalidate ()
	isInvalidated ()
	isSuccessfulExpired ()
	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)

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	DATE_TIME_FORMAT = 'Y-m-d H:i:s'
const	DATE_FORMAT = 'Y-m-d'
const	DATE_FORMAT_ENDOFDAY = 'Y-m-d 23:59:59'

Static Public Attributes
static	$STATUS

Protected Attributes
	$id
	$assignment_id
	$prg_id
	$usr_id
	$points = 0
	$points_cur = 0
	$status
	$completion_by
	$last_change
	$last_change_by
	$assignment_date
	$completion_date
	$deadline
	$vq_date
	$invalidated = false
	$is_individual = false

Detailed Description

Class ilStudyProgrammeProgress.

Represents the progress of a user for one program assignment on one node of the program.

The user has one progress per assignment and program node in the subtree of the assigned program.

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

: Denis Klöpfer 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

: Nils Haagen nils..nosp@m.haag.nosp@m.en@co.nosp@m.ncep.nosp@m.ts-an.nosp@m.d-tr.nosp@m.ainin.nosp@m.g.de

Definition at line 20 of file class.ilStudyProgrammeProgress.php.

Constructor & Destructor Documentation

__construct()

ilStudyProgrammeProgress::__construct

(

int

$id

)

Definition at line 175 of file class.ilStudyProgrammeProgress.php.

References $id.

    {
        $this->id = $id;
    }

Member Function Documentation

getAllowedTargetStatusFor()

static ilStudyProgrammeProgress::getAllowedTargetStatusFor ( int  $status_from )

static

Definition at line 320 of file class.ilStudyProgrammeProgress.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,
                ];
            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()

ilStudyProgrammeProgress::getAmountOfPoints

(

)

Get the amount of points the user needs to achieve on the subnodes of this node.

Also the amount of points, this node yields for the progress on the nodes above.

Definition at line 240 of file class.ilStudyProgrammeProgress.php.

References $points.

Referenced by ilStudyProgrammeProgressListGUI\buildProgressBar(), ilStudyProgrammeProgressListGUI\buildProgressStatus(), ilStudyProgrammeProgressListGUI\buildToolTip(), ilObjStudyProgramme\canBeCompleted(), ilObjStudyProgramme\recalculateProgressStatus(), and ilStudyProgrammeProgressDBRepository\update().

                                        : int
    {
        return $this->points;
    }

Here is the caller graph for this function:

getAssignmentDate()

ilStudyProgrammeProgress::getAssignmentDate

(

)

Definition at line 396 of file class.ilStudyProgrammeProgress.php.

References $assignment_date.

Referenced by ilStudyProgrammeProgressDBRepository\update().

                                        : DateTimeImmutable
    {
        return $this->assignment_date;
    }

Here is the caller graph for this function:

getAssignmentId()

ilStudyProgrammeProgress::getAssignmentId

(

)

Get the assignment this progress belongs to.

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

References $assignment_id.

Referenced by ilObjStudyProgramme\getAssignmentForProgress(), ilObjStudyProgramme\getParentProgress(), ilStudyProgrammeEvents\informUserByMailToRestart(), ilStudyProgrammeProgressDBRepository\update(), and ilStudyProgrammeEvents\userSuccessful().

                                      : int
    {
        return $this->assignment_id;
    }

Here is the caller graph for this function:

getCompletionBy()

ilStudyProgrammeProgress::getCompletionBy

(

)

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

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

References $completion_by.

Referenced by ilStudyProgrammeProgressDBRepository\update().

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

Here is the caller graph for this function:

getCompletionDate()

ilStudyProgrammeProgress::getCompletionDate

(

)

Definition at line 408 of file class.ilStudyProgrammeProgress.php.

References $completion_date.

Referenced by ilStudyProgrammeMailTemplateContext\getNewestProgressForUser(), ilStudyProgrammeProgressDBRepository\update(), and ilObjStudyProgramme\updateProgressValidityFromSettings().

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

Here is the caller graph for this function:

getCurrentAmountOfPoints()

ilStudyProgrammeProgress::getCurrentAmountOfPoints

(

)

Definition at line 260 of file class.ilStudyProgrammeProgress.php.

References $points_cur.

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

                                               : int
    {
        return $this->points_cur;
    }

Here is the caller graph for this function:

getDeadline()

ilStudyProgrammeProgress::getDeadline

(

)

Definition at line 432 of file class.ilStudyProgrammeProgress.php.

References $deadline.

Referenced by ilObjStudyProgramme\applyProgressDeadline(), and ilStudyProgrammeProgressDBRepository\update().

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

Here is the caller graph for this function:

getId()

ilStudyProgrammeProgress::getId

(

)

Get the id of the progress.

Returns

int

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

References $id.

Referenced by ilStudyProgrammeProgressListGUI\buildProgressBar(), ilObjStudyProgramme\getProgressIdString(), ilStudyProgrammeProgressListGUI\getTitleAndIconTarget(), ilStudyProgrammeEvents\informUserByMailToRestart(), ilStudyProgrammeProgressDBRepository\update(), ilStudyProgrammeEvents\userRiskyToFail(), and withStatus().

                            : int
    {
        return $this->id;
    }

Here is the caller graph for this function:

getLastChange()

ilStudyProgrammeProgress::getLastChange

(

)

Definition at line 366 of file class.ilStudyProgrammeProgress.php.

References $last_change.

Referenced by ilStudyProgrammeProgressDBRepository\update(), and withLastChange().

                                    : ?DateTimeImmutable
    {
        if ($this->last_change) {
            return DateTimeImmutable::createFromFormat(self::DATE_TIME_FORMAT, $this->last_change);
        }
        return $this->last_change;
    }

Here is the caller graph for this function:

getLastChangeBy()

ilStudyProgrammeProgress::getLastChangeBy

(

)

Get the id of the user/object who/which invoked the last change on this assignment.

Returns

int

Definition at line 361 of file class.ilStudyProgrammeProgress.php.

References $last_change_by.

Referenced by ilStudyProgrammeProgressDBRepository\update().

    {
        return $this->last_change_by;
    }

Here is the caller graph for this function:

getNodeId()

ilStudyProgrammeProgress::getNodeId

(

)

Get the obj_id of the program node this progress belongs to.

Definition at line 208 of file class.ilStudyProgrammeProgress.php.

References $prg_id.

Referenced by ilStudyProgrammeProgressListGUI\buildProgressBar(), ilStudyProgrammeIndividualPlanProgressListGUI\buildProgressStatus(), ilStudyProgrammeProgressListGUI\buildProgressStatus(), ilObjStudyProgramme\getParentProgress(), ilObjStudyProgramme\getProgrammeSettingsForProgress(), ilObjStudyProgramme\recalculateProgressStatus(), ilStudyProgrammeExpandableProgressListGUI\shouldShowSubProgress(), ilStudyProgrammeProgressDBRepository\update(), and ilStudyProgrammeEvents\userSuccessful().

                                : int
    {
        return $this->prg_id;
    }

Here is the caller graph for this function:

getStatus()

ilStudyProgrammeProgress::getStatus

(

)

Get the status the user has on this node.

Returns

int - one of ilStudyProgrammeProgress::STATUS_*

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

References $status.

Referenced by ilObjStudyProgramme\applyProgressDeadline(), isAccredited(), isFailed(), isInProgress(), isRelevant(), isSuccessful(), ilStudyProgrammeProgressDBRepository\update(), and withStatus().

                                : int
    {
        return $this->status;
    }

Here is the caller graph for this function:

getUserId()

ilStudyProgrammeProgress::getUserId

(

)

Get the id of the user this progress is for.

Definition at line 223 of file class.ilStudyProgrammeProgress.php.

References $usr_id.

Referenced by ilObjStudyProgramme\getProgressIdString(), ilStudyProgrammeEvents\informUserByMailToRestart(), ilObjStudyProgramme\recalculateProgressStatus(), ilStudyProgrammeProgressDBRepository\update(), and ilStudyProgrammeEvents\userRiskyToFail().

                                : int
    {
        return $this->usr_id;
    }

Here is the caller graph for this function:

getValidityOfQualification()

ilStudyProgrammeProgress::getValidityOfQualification

(

)

Definition at line 444 of file class.ilStudyProgrammeProgress.php.

References $vq_date.

Referenced by hasValidQualification(), isSuccessfulExpired(), and ilStudyProgrammeProgressDBRepository\update().

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

Here is the caller graph for this function:

hasIndividualModifications()

ilStudyProgrammeProgress::hasIndividualModifications

(

)

Definition at line 456 of file class.ilStudyProgrammeProgress.php.

References $is_individual.

Referenced by ilStudyProgrammeProgressTest\testIndividualPlan(), and ilStudyProgrammeProgressDBRepository\update().

                                                 : bool
    {
        return $this->is_individual;
    }

Here is the caller graph for this function:

hasValidQualification()

ilStudyProgrammeProgress::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 483 of file class.ilStudyProgrammeProgress.php.

References getValidityOfQualification(), and isSuccessful().

                                                                  : ?bool
    {
        if (!$this->isSuccessful()) {
            return null;
        }
        return (
            is_null($this->getValidityOfQualification()) ||
            $this->getValidityOfQualification()->format('Y-m-d') >= $now->format('Y-m-d')
        );
    }

Here is the call graph for this function:

invalidate()

ilStudyProgrammeProgress::invalidate

(

)

Definition at line 514 of file class.ilStudyProgrammeProgress.php.

Referenced by ilStudyProgrammeProgressDBRepository\buildByRow().

                                 : ilStudyProgrammeProgress
    {
        if (!$this->vq_date || $this->vq_date->format('Y-m-d') > date('Y-m-d')) {
            throw new ilException("may not invalidate non-expired progress");
        }
        $clone = clone $this;
        $clone->invalidated = true;
        return $clone;
    }

Here is the caller graph for this function:

isAccredited()

ilStudyProgrammeProgress::isAccredited

(

)

Definition at line 504 of file class.ilStudyProgrammeProgress.php.

References getStatus().

Referenced by ilStudyProgrammeMailTemplateContext\getNewestProgressForUser().

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

Here is the call graph for this function:

Here is the caller graph for this function:

isFailed()

ilStudyProgrammeProgress::isFailed

(

)

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

References getStatus().

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

Here is the call graph for this function:

isInProgress()

ilStudyProgrammeProgress::isInProgress

(

)

Definition at line 509 of file class.ilStudyProgrammeProgress.php.

References getStatus().

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

Here is the call graph for this function:

isInvalidated()

ilStudyProgrammeProgress::isInvalidated

(

)

Definition at line 524 of file class.ilStudyProgrammeProgress.php.

References $invalidated.

Referenced by ilStudyProgrammeProgressDBRepository\update().

                                    : bool
    {
        return $this->invalidated;
    }

Here is the caller graph for this function:

isRelevant()

ilStudyProgrammeProgress::isRelevant

(

)

Definition at line 494 of file class.ilStudyProgrammeProgress.php.

References getStatus().

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

                                 : 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()

ilStudyProgrammeProgress::isSuccessful

(

)

Definition at line 468 of file class.ilStudyProgrammeProgress.php.

References getStatus().

Referenced by ilStudyProgrammeProgressListGUI\buildProgressBar(), ilStudyProgrammeIndividualPlanProgressListGUI\buildProgressStatus(), ilStudyProgrammeMailTemplateContext\getNewestProgressForUser(), hasValidQualification(), and ilObjStudyProgramme\recalculateProgressStatus().

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

isSuccessfulExpired()

ilStudyProgrammeProgress::isSuccessfulExpired

(

)

Deprecated:

Definition at line 532 of file class.ilStudyProgrammeProgress.php.

References getValidityOfQualification().

Referenced by ilStudyProgrammeMailTemplateContext\getNewestProgressForUser().

                                          : bool
    {
        if (
            !is_null($this->getValidityOfQualification()) &&
            $this->getValidityOfQualification()->format('Y-m-d') < (new DateTimeImmutable())->format('Y-m-d')
        ) {
            return true;
        }
        return false;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isTransitionAllowedTo()

ilStudyProgrammeProgress::isTransitionAllowedTo

(

int

$new_status

)

Definition at line 313 of file class.ilStudyProgrammeProgress.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()

ilStudyProgrammeProgress::markAccredited	(	DateTimeImmutable	$date,
		int	$acting_usr_id
	)

Definition at line 543 of file class.ilStudyProgrammeProgress.php.

References withStatus().

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

Here is the call graph for this function:

markFailed()

ilStudyProgrammeProgress::markFailed	(	DateTimeImmutable	$date,
		int	$acting_usr_id
	)

Definition at line 560 of file class.ilStudyProgrammeProgress.php.

References withStatus().

Referenced by ilObjStudyProgramme\applyProgressDeadline().

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

Here is the call graph for this function:

Here is the caller graph for this function:

markNotFailed()

ilStudyProgrammeProgress::markNotFailed	(	DateTimeImmutable	$date,
		int	$acting_usr_id
	)

Definition at line 568 of file class.ilStudyProgrammeProgress.php.

References withStatus().

Referenced by ilObjStudyProgramme\applyProgressDeadline().

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

Here is the call graph for this function:

Here is the caller graph for this function:

markNotRelevant()

ilStudyProgrammeProgress::markNotRelevant	(	DateTimeImmutable	$date,
		int	$acting_usr_id
	)

Definition at line 584 of file class.ilStudyProgrammeProgress.php.

References withStatus().

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

Here is the call graph for this function:

markRelevant()

ilStudyProgrammeProgress::markRelevant	(	DateTimeImmutable	$date,
		int	$acting_usr_id
	)

Definition at line 594 of file class.ilStudyProgrammeProgress.php.

References withStatus().

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

Here is the call graph for this function:

succeed()

ilStudyProgrammeProgress::succeed	(	DateTimeImmutable	$date,
		int	$triggering_obj_id
	)

Definition at line 576 of file class.ilStudyProgrammeProgress.php.

References withStatus().

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

Here is the call graph for this function:

unmarkAccredited()

ilStudyProgrammeProgress::unmarkAccredited	(	DateTimeImmutable	$date,
		int	$acting_usr_id
	)

Definition at line 551 of file class.ilStudyProgrammeProgress.php.

References withStatus().

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

Here is the call graph for this function:

withAmountOfPoints()

ilStudyProgrammeProgress::withAmountOfPoints

(

int

$points

)

Throws when amount of points is smaller then zero.

Definition at line 248 of file class.ilStudyProgrammeProgress.php.

References $points.

Referenced by ilObjStudyProgramme\resetProgressToSettings().

                                                    : ilStudyProgrammeProgress
    {
        if ($points < 0) {
            throw new ilException("ilStudyProgrammeProgress::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()

ilStudyProgrammeProgress::withAssignmentDate

(

DateTimeImmutable

$assignment_date

)

Definition at line 401 of file class.ilStudyProgrammeProgress.php.

References $assignment_date.

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

withAssignmentId()

ilStudyProgrammeProgress::withAssignmentId

(

int

$assignment_id

)

Definition at line 198 of file class.ilStudyProgrammeProgress.php.

References $assignment_id.

                                                         : ilStudyProgrammeProgress
    {
        $clone = clone $this;
        $clone->assignment_id = $assignment_id;
        return $clone;
    }

withCompletion()

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

Definition at line 422 of file class.ilStudyProgrammeProgress.php.

References $completion_date.

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

withCurrentAmountOfPoints()

ilStudyProgrammeProgress::withCurrentAmountOfPoints

(

int

$points_cur

)

Set the amount of points the user currently has achieved on this node.

Exceptions

when	amount of points is smaller then zero.

Definition at line 269 of file class.ilStudyProgrammeProgress.php.

References $points_cur.

Referenced by ilObjStudyProgramme\recalculateProgressStatus().

                                                               : ilStudyProgrammeProgress
    {
        if ($points_cur < 0) {
            throw new ilException("ilStudyProgrammeProgress::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()

ilStudyProgrammeProgress::withDeadline

(

DateTimeImmutable

$deadline = null

)

Definition at line 437 of file class.ilStudyProgrammeProgress.php.

References $deadline.

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

withIndividualModifications()

ilStudyProgrammeProgress::withIndividualModifications

(

bool

$individual

)

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

Referenced by ilStudyProgrammeProgressTest\testIndividualPlan().

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

Here is the caller graph for this function:

withLastChange()

ilStudyProgrammeProgress::withLastChange	(	int	$last_change_by,
		DateTimeImmutable	$timestamp
	)

Exceptions

ilException

if new date is earlier than the existing one

Definition at line 377 of file class.ilStudyProgrammeProgress.php.

References $last_change_by, and getLastChange().

Referenced by ilObjStudyProgramme\resetProgressToSettings().

      : ilStudyProgrammeProgress {
        $new_date = $timestamp->format(self::DATE_TIME_FORMAT);
        if ($this->getLastChange() && $this->getLastChange()->format(self::DATE_TIME_FORMAT) > $new_date) {
            throw new ilException(
                "Cannot set last change to an earlier date:"
                . "\ncurrent: " . $this->getLastChange()->format(self::DATE_TIME_FORMAT)
                . "\nnew: " . $new_date,
                1
            );
        }
        $clone = clone $this;
        $clone->last_change = $new_date;
        $clone->last_change_by = $last_change_by;
        return $clone;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

withNodeId()

ilStudyProgrammeProgress::withNodeId

(

int

$prg_id

)

Definition at line 213 of file class.ilStudyProgrammeProgress.php.

References $prg_id.

                                            : ilStudyProgrammeProgress
    {
        $clone = clone $this;
        $clone->prg_id = $prg_id;
        return $clone;
    }

withStatus()

ilStudyProgrammeProgress::withStatus

(

int

$status

)

Set the status of this node.

Exceptions

when	status is none of ilStudyProgrammeProgress::STATUS_*.

Definition at line 294 of file class.ilStudyProgrammeProgress.php.

References $status, getId(), getStatus(), and isTransitionAllowedTo().

Referenced by markAccredited(), markFailed(), markNotFailed(), markNotRelevant(), markRelevant(), ilObjStudyProgramme\recalculateProgressStatus(), succeed(), unmarkAccredited(), and ilObjStudyProgramme\updateProgressRelevanceFromSettings().

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

withUserId()

ilStudyProgrammeProgress::withUserId

(

int

$usr_id

)

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

References $usr_id.

                                            : ilStudyProgrammeProgress
    {
        $clone = clone $this;
        $clone->usr_id = $usr_id;
        return $clone;
    }

withValidityOfQualification()

ilStudyProgrammeProgress::withValidityOfQualification

(

DateTimeImmutable

$date = null

)

Definition at line 449 of file class.ilStudyProgrammeProgress.php.

Referenced by ilObjStudyProgramme\resetProgressToSettings().

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

Here is the caller graph for this function:

Field Documentation

$assignment_date

ilStudyProgrammeProgress::$assignment_date

protected

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

Referenced by getAssignmentDate(), and withAssignmentDate().

$assignment_id

ilStudyProgrammeProgress::$assignment_id

protected

Definition at line 68 of file class.ilStudyProgrammeProgress.php.

Referenced by getAssignmentId(), and withAssignmentId().

$completion_by

ilStudyProgrammeProgress::$completion_by

protected

Definition at line 115 of file class.ilStudyProgrammeProgress.php.

Referenced by getCompletionBy().

$completion_date

ilStudyProgrammeProgress::$completion_date

protected

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

Referenced by getCompletionDate(), and withCompletion().

$deadline

ilStudyProgrammeProgress::$deadline

protected

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

Referenced by getDeadline(), and withDeadline().

$id

ilStudyProgrammeProgress::$id

protected

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

Referenced by __construct(), and getId().

$invalidated

ilStudyProgrammeProgress::$invalidated = false

protected

Definition at line 166 of file class.ilStudyProgrammeProgress.php.

Referenced by isInvalidated().

$is_individual

ilStudyProgrammeProgress::$is_individual = false

protected

Definition at line 171 of file class.ilStudyProgrammeProgress.php.

Referenced by hasIndividualModifications().

$last_change

ilStudyProgrammeProgress::$last_change

protected

Definition at line 124 of file class.ilStudyProgrammeProgress.php.

Referenced by getLastChange().

$last_change_by

ilStudyProgrammeProgress::$last_change_by

protected

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

Referenced by getLastChangeBy(), and withLastChange().

$points

ilStudyProgrammeProgress::$points = 0

protected

Definition at line 91 of file class.ilStudyProgrammeProgress.php.

Referenced by getAmountOfPoints(), and withAmountOfPoints().

$points_cur

ilStudyProgrammeProgress::$points_cur = 0

protected

Definition at line 98 of file class.ilStudyProgrammeProgress.php.

Referenced by getCurrentAmountOfPoints(), and withCurrentAmountOfPoints().

$prg_id

ilStudyProgrammeProgress::$prg_id

protected

Definition at line 75 of file class.ilStudyProgrammeProgress.php.

Referenced by getNodeId(), and withNodeId().

$STATUS

ilStudyProgrammeProgress::$STATUS

static

Initial value:

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

Definition at line 38 of file class.ilStudyProgrammeProgress.php.

$status

ilStudyProgrammeProgress::$status

protected

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

Referenced by getStatus(), and withStatus().

$usr_id

ilStudyProgrammeProgress::$usr_id

protected

Definition at line 82 of file class.ilStudyProgrammeProgress.php.

Referenced by getUserId(), and withUserId().

$vq_date

ilStudyProgrammeProgress::$vq_date

protected

Definition at line 159 of file class.ilStudyProgrammeProgress.php.

Referenced by getValidityOfQualification().

DATE_FORMAT

const ilStudyProgrammeProgress::DATE_FORMAT = 'Y-m-d'

Definition at line 47 of file class.ilStudyProgrammeProgress.php.

Referenced by ilObjStudyProgramme\applyProgressDeadline(), ilStudyProgrammeProgressDBRepository\buildByRow(), ilStudyProgrammeProgressDBRepository\getRiskyToFail(), ilStudyProgrammeProgressDBRepository\loadExpiredSuccessful(), ilStudyProgrammeProgressDBRepository\loadPassedDeadline(), ilStudyProgrammeProgressDBRepository\loadRiskyToFailInstance(), ilStudyProgrammeProgressRepositoryTest\test_query_ByIds(), ilStudyProgrammeProgressRepositoryTest\test_save_and_load(), ilStudyProgrammeProgressTest\testMarkAccredited(), ilStudyProgrammeProgressTest\testMarkFailed(), ilStudyProgrammeProgressTest\testMarkNotFailed(), ilStudyProgrammeProgressTest\testMarkNotRelevant(), ilStudyProgrammeProgressTest\testMarkRelevant(), ilStudyProgrammeProgressTest\testSucceed(), ilStudyProgrammeProgressTest\testUnmarkAccredited(), and ilStudyProgrammeProgressDBRepository\update().

DATE_FORMAT_ENDOFDAY

const ilStudyProgrammeProgress::DATE_FORMAT_ENDOFDAY = 'Y-m-d 23:59:59'

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

Referenced by ilStudyProgrammeProgressDBRepository\getAboutToExpire().

DATE_TIME_FORMAT

const ilStudyProgrammeProgress::DATE_TIME_FORMAT = 'Y-m-d H:i:s'

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

Referenced by ilStudyProgrammeProgressDBRepository\buildByRow(), and ilStudyProgrammeProgressDBRepository\update().

STATUS_ACCREDITED

const ilStudyProgrammeProgress::STATUS_ACCREDITED = 3

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

Referenced by ilObjStudyProgrammeAccess\checkCondition(), ilStudyProgrammeMembersTableGUI\fetchData(), ilStudyProgrammeDashboardViewGUI\findValid(), ilStudyProgrammeMembersTableGUI\getFilterWhere(), ilStudyProgrammeIndividualPlanTableGUI\getManualStatusSelect(), ilStudyProgrammeMembersTableGUI\getPossibleActions(), ilStudyProgrammeMembersTableGUI\getStatusOptions(), ilStudyProgrammeProgressDBRepository\loadExpiredSuccessful(), ilStudyProgrammeProgressDBRepository\loadPassedDeadline(), ilStudyProgrammeProgressDBRepository\loadRiskyToFailInstance(), ilStudyProgrammeProgressTest\status(), ilStudyProgrammeMailTemplateContext\statusToRepr(), ilObjStudyProgramme\statusToRepr(), ilStudyProgrammeProgressRepositoryTest\test_query_ByIds(), ilStudyProgrammeProgressRepositoryTest\test_query_past_succsessful_1(), ilStudyProgrammeProgressRepositoryTest\test_query_past_succsessful_2(), ilPrgInvalidateExpiredProgressesCronJobTest\test_run(), ilStudyProgrammeProgressRepositoryTest\test_save_and_load(), ilStudyProgrammeProgressTest\testAllowedTransitionsForAccredited(), ilStudyProgrammeProgressTest\testAllowedTransitionsForInProgress(), ilStudyProgrammeUserProgressTest\testMarkAccredited(), ilStudyProgrammeProgressTest\testMarkAccredited(), ilStudyProgrammeProgressCalculationsTest\testMarkAccreditedOnLPNode(), ilStudyProgrammeProgressCalculationsTest\testMarkAccreditedShouldCompleteParentBySufficientPoints(), ilStudyProgrammeProgressCalculationsTest\testMarkAccreditedShouldNotChangeIrrelevantParent(), ilStudyProgrammeProgressCalculationsTest\testMarkRelevantShouldRecalculateStatusAndPoints(), ilStudyProgrammeUserProgressTest\testPossibleActions(), ilStudyProgrammeProgressCalculationTest\testProgress2(), ilStudyProgrammeProgressCalculationsTest\testTranstitionToProgressWithPastDeadline(), and ilObjStudyProgrammeIndividualPlanGUI\updateStatus().

STATUS_COMPLETED

const ilStudyProgrammeProgress::STATUS_COMPLETED = 2

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

Referenced by ilObjStudyProgrammeAccess\checkCondition(), ilStudyProgrammeMembersTableGUI\fetchData(), ilStudyProgrammeDashboardViewGUI\findValid(), ilStudyProgrammeMembersTableGUI\getFilterWhere(), ilStudyProgrammeMembersTableGUI\getStatusOptions(), ilStudyProgrammeProgressDBRepository\loadExpiredSuccessful(), ilStudyProgrammeProgressDBRepository\loadRiskyToFailInstance(), ilObjStudyProgramme\markNotRelevant(), ilObjStudyProgramme\recalculateProgressStatus(), ilStudyProgrammeProgressTest\status(), ilStudyProgrammeMailTemplateContext\statusToRepr(), ilObjStudyProgramme\statusToRepr(), ilStudyProgrammeProgressRepositoryTest\test_query_past_succsessful_1(), ilPrgInvalidateExpiredProgressesCronJobTest\test_run(), ilStudyProgrammeProgressTest\testAllowedTransitionsForAccredited(), ilStudyProgrammeProgressTest\testAllowedTransitionsForCompleted(), ilStudyProgrammeProgressTest\testAllowedTransitionsForFailed(), ilStudyProgrammeProgressTest\testAllowedTransitionsForInProgress(), ilStudyProgrammeProgressCalculationsTest\testChangingValidity(), ilStudyProgrammeProgressCalculationsTest\testDontChangeDeadlineForCompleted(), ilStudyProgrammeProgressCalculationsTest\testDontFailByDeadlineIfSucceeded(), ilStudyProgrammeProgressTest\testHasValidQualification(), ilStudyProgrammeProgressCalculationTest\testInitialProgressOnOptionalNodes(), ilStudyProgrammeUserProgressTest\testMarkAccredited(), ilStudyProgrammeProgressCalculationsTest\testMarkAccreditedOnLPNode(), ilStudyProgrammeProgressCalculationsTest\testMarkAccreditedShouldCompleteParentBySufficientPoints(), ilStudyProgrammeProgressCalculationsTest\testMarkRelevantShouldRecalculateStatusAndPoints(), ilStudyProgrammeProgressCalculationTest\testProgress1(), ilStudyProgrammeProgressCalculationTest\testProgress2(), ilStudyProgrammeProgressCalculationTest\testProgress3(), ilStudyProgrammeProgressCalculationTest\testProgress4(), ilStudyProgrammeProgressTest\testSucceed(), and ilStudyProgrammeProgressCalculationsTest\testSuccessionCompletingParents().

STATUS_FAILED

const ilStudyProgrammeProgress::STATUS_FAILED = 5

Definition at line 36 of file class.ilStudyProgrammeProgress.php.

Referenced by ilObjStudyProgramme\applyProgressDeadline(), ilStudyProgrammeMembersTableGUI\getStatusOptions(), ilStudyProgrammeProgressTest\status(), ilStudyProgrammeMailTemplateContext\statusToRepr(), ilObjStudyProgramme\statusToRepr(), ilStudyProgrammeProgressRepositoryTest\test_query_past_succsessful_2(), ilStudyProgrammeProgressTest\testAllowedTransitionsForAccredited(), ilStudyProgrammeProgressTest\testAllowedTransitionsForFailed(), ilStudyProgrammeProgressTest\testAllowedTransitionsForInProgress(), ilStudyProgrammeProgressCalculationsTest\testChangingDeadline(), ilStudyProgrammeProgressCalculationsTest\testFailByDeadline(), ilStudyProgrammeProgressCalculationsTest\testInternalTreeIntegrity(), ilStudyProgrammeUserProgressTest\testMarkFailed(), ilStudyProgrammeProgressTest\testMarkFailed(), ilStudyProgrammeUserProgressTest\testMarkNotFailed(), ilStudyProgrammeUserAssignmentTest\testRstartAssignment(), and ilStudyProgrammeProgressCalculationsTest\testTranstitionToProgressWithPastDeadline().

STATUS_IN_PROGRESS

const ilStudyProgrammeProgress::STATUS_IN_PROGRESS = 1

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

Referenced by ilObjStudyProgramme\applyProgressDeadline(), ilStudyProgrammeProgressCalculationsTest\buildProgramme(), ilStudyProgrammeProgressDBRepository\createFor(), ilStudyProgrammeIndividualPlanTableGUI\getManualStatusSelect(), ilStudyProgrammeMembersTableGUI\getPossibleActions(), ilStudyProgrammeIndividualPlanTableGUI\getRequiredPointsInput(), ilStudyProgrammeMembersTableGUI\getStatusOptions(), ilStudyProgrammeDashboardViewGUI\isInProgress(), ilStudyProgrammeProgressDBRepository\loadPassedDeadline(), ilObjStudyProgramme\recalculateProgressStatus(), ilObjStudyProgramme\removeMemberFromProgrammes(), ilPrgUpdateProgressCronJob\run(), ilObjStudyProgramme\setProgressesCompletedIfParentIsProgrammeInLPCompletedMode(), ilStudyProgrammeProgressTest\status(), ilStudyProgrammeMailTemplateContext\statusToRepr(), ilObjStudyProgramme\statusToRepr(), ilStudyProgrammeProgressRepositoryTest\test_create(), ilStudyProgrammeProgressRepositoryTest\test_save_and_load(), ilStudyProgrammeProgressTest\testAllowedTransitionsForAccredited(), ilStudyProgrammeProgressTest\testAllowedTransitionsForCompleted(), ilStudyProgrammeProgressTest\testAllowedTransitionsForFailed(), ilStudyProgrammeProgressTest\testAllowedTransitionsForInProgress(), ilStudyProgrammeProgressTest\testAllowedTransitionsForIrrelevant(), ilStudyProgrammeProgressCalculationsTest\testDontChangeValidityForIncomplete(), ilStudyProgrammeProgressCalculationsTest\testDontFailByFutureDeadline(), ilStudyProgrammeProgressTest\testHasValidQualification(), ilStudyProgrammeUserProgressTest\testInitialProgressActive(), ilStudyProgrammeUserProgressTest\testInitialProgressDraft(), ilStudyProgrammeProgressCalculationTest\testInitialProgressOnOptionalNodes(), ilStudyProgrammeUserProgressTest\testInitialProgressOutdated(), ilStudyProgrammeProgressCalculationsTest\testInternalRunIntegrity(), ilStudyProgrammeProgressCalculationsTest\testInternalTreeIntegrity(), ilStudyProgrammeUserProgressTest\testMarkAccredited(), ilStudyProgrammeProgressCalculationsTest\testMarkAccreditedOnLPNode(), ilStudyProgrammeProgressCalculationsTest\testMarkAccreditedShouldNotChangeIrrelevantParent(), ilStudyProgrammeUserProgressTest\testMarkFailed(), ilStudyProgrammeProgressCalculationsTest\testMarkIrrelevantDoesNotCompleteParent(), ilStudyProgrammeUserProgressTest\testMarkNotFailed(), ilStudyProgrammeProgressTest\testMarkNotFailed(), ilStudyProgrammeUserProgressTest\testMarkNotRelevant(), ilStudyProgrammeProgressTest\testMarkRelevant(), ilStudyProgrammeUserProgressTest\testPossibleActions(), ilStudyProgrammeProgressCalculationTest\testProgress4(), ilStudyProgrammeUserAssignmentTest\testRstartAssignment(), ilStudyProgrammeUserProgressTest\testUnmarkAccredited(), ilStudyProgrammeProgressTest\testUnmarkAccredited(), ilObjStudyProgramme\updateProgressRelevanceFromSettings(), and ilObjStudyProgrammeIndividualPlanGUI\updateStatus().

STATUS_NOT_RELEVANT

const ilStudyProgrammeProgress::STATUS_NOT_RELEVANT = 4

Definition at line 34 of file class.ilStudyProgrammeProgress.php.

Referenced by ilObjStudyProgramme\addMissingProgresses(), ilObjStudyProgramme\canBeRemoved(), ilStudyProgrammeIndividualPlanTableGUI\getManualStatusSelect(), ilStudyProgrammeMembersTableGUI\getStatusOptions(), ilStudyProgrammeProgressTest\status(), ilStudyProgrammeMailTemplateContext\statusToRepr(), ilObjStudyProgramme\statusToRepr(), ilStudyProgrammeProgressTest\testAllowedTransitionsForAccredited(), ilStudyProgrammeProgressTest\testAllowedTransitionsForFailed(), ilStudyProgrammeProgressTest\testAllowedTransitionsForInProgress(), ilStudyProgrammeProgressTest\testAllowedTransitionsForIrrelevant(), ilStudyProgrammeUserProgressTest\testInitialProgressDraft(), ilStudyProgrammeUserProgressTest\testInitialProgressOutdated(), ilStudyProgrammeProgressCalculationsTest\testMarkAccreditedShouldNotChangeIrrelevantParent(), ilStudyProgrammeProgressTest\testMarkNotRelevant(), ilStudyProgrammeUserProgressTest\testMarkNotRelevant(), ilStudyProgrammeProgressCalculationsTest\testMarkRelevantShouldRecalculateStatusAndPoints(), ilStudyProgrammeUserProgressTest\testNewNodesAreNotRelevant(), ilStudyProgrammeUserProgressTest\testOutdatedNodesCantBeSetToRelevant(), ilStudyProgrammeUserProgressTest\testPossibleActions(), ilStudyProgrammeProgressCalculationTest\testProgress3(), ilStudyProgrammeProgressCalculationTest\testProgress4(), ilObjStudyProgramme\updateProgressRelevanceFromSettings(), and ilObjStudyProgrammeIndividualPlanGUI\updateStatus().

---

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

• Modules/StudyProgramme/classes/model/Progress/class.ilStudyProgrammeProgress.php