ilPRGAssignment Class Reference

Assignments are relations of users to a PRG; They hold progress-information for (sub-)nodes of the PRG-tree. More...

Collaboration diagram for ilPRGAssignment:

Public Member Functions
	__construct (int $id, int $usr_id)
	getId ()
	getUserId ()
	getLastChangeBy ()
	getLastChange ()
	withLastChange (int $last_change_by, \DateTimeImmutable $last_change)
	getRestartDate ()
	getRestartedAssignmentId ()
	isRestarted ()
	withRestarted (int $restarted_asssignment_id, ?\DateTimeImmutable $restart_date=null)
	isManuallyAssigned ()
	withManuallyAssigned (bool $manual)
	withUserInformation (ilPRGUserInformation $user_info)
	getUserInformation ()
	withProgressTree (ilPRGProgress $progress)
	getProgressTree ()
	getRootId ()
	getProgresses (array &$ret=[], ?ilPRGProgress $pgs=null)
	getProgressForNode (int $node_id)
	getProgressesWithDeadline (DateTimeImmutable $deadline)
	withEvents (StudyProgrammeEvents $events)
	getEvents ()

Data Fields
const	DATE_TIME_FORMAT = 'Y-m-d H:i:s'
const	DATE_FORMAT = 'Y-m-d'
const	NO_RESTARTED_ASSIGNMENT = -1
const	AUTO_ASSIGNED_BY_ROLE = -1
const	AUTO_ASSIGNED_BY_ORGU = -2
const	AUTO_ASSIGNED_BY_COURSE = -3
const	AUTO_ASSIGNED_BY_GROUP = -4
const	AUTO_ASSIGNED_BY_RESTART = -5

Protected Attributes
int	$id
int	$usr_id
DateTimeImmutable	$last_change = null
int	$last_change_by = null
DateTimeImmutable	$restart_date = null
int	$restarted_asssignment_id = self::NO_RESTARTED_ASSIGNMENT
bool	$manually_assigned
array	$progresses = []
ilPRGProgress	$progress
ilPRGUserInformation	$user_info
StudyProgrammeEvents	$events

Detailed Description

Assignments are relations of users to a PRG; They hold progress-information for (sub-)nodes of the PRG-tree.

Definition at line 28 of file class.ilPRGAssignment.php.

Constructor & Destructor Documentation

__construct()

ilPRGAssignment::__construct	(	int	$id,
		int	$usr_id
	)

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

References $id, and $usr_id.

    {
        $this->id = $id;
        $this->usr_id = $usr_id;
        $this->events = new PRGNullEvents();
    }

Member Function Documentation

getEvents()

ilPRGAssignment::getEvents

(

)

Definition at line 212 of file class.ilPRGAssignment.php.

References $events.

                               : StudyProgrammeEvents
    {
        return $this->events;
    }

getId()

ilPRGAssignment::getId

(

)

Definition at line 65 of file class.ilPRGAssignment.php.

References $id.

Referenced by PRGEventsDelayed\deadlineChange(), ilStudyProgrammeEvents\deadlineChange(), PRGEventsDelayed\informUserByMailToRestart(), ilStudyProgrammeEvents\informUserByMailToRestart(), ilObjStudyProgramme\removeAssignment(), ilPRGAssignmentDBRepository\resetExpiryInfoSentFor(), ilPRGAssignmentDBRepository\resetRiskyToFailSentFor(), PRGEventsDelayed\scoreChange(), ilStudyProgrammeEvents\scoreChange(), ilPRGAssignmentDBRepository\store(), ilPRGAssignmentDBRepository\storeExpiryInfoSentFor(), ilPRGAssignmentDBRepository\storeRiskyToFailSentFor(), ilStudyProgrammeUserTable\toRow(), PRGEventsDelayed\userAssigned(), ilStudyProgrammeEvents\userAssigned(), PRGEventsDelayed\userDeassigned(), ilStudyProgrammeEvents\userDeassigned(), PRGEventsDelayed\userReAssigned(), ilStudyProgrammeEvents\userReAssigned(), PRGEventsDelayed\userRevertSuccessful(), ilStudyProgrammeEvents\userRevertSuccessful(), PRGEventsDelayed\userRiskyToFail(), ilStudyProgrammeEvents\userRiskyToFail(), PRGEventsDelayed\userSuccessful(), ilStudyProgrammeEvents\userSuccessful(), PRGEventsDelayed\validityChange(), and ilStudyProgrammeEvents\validityChange().

                           : int
    {
        return $this->id;
    }

Here is the caller graph for this function:

getLastChange()

ilPRGAssignment::getLastChange

(

)

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

References $last_change.

Referenced by ilPRGAssignmentDBRepository\store(), and withLastChange().

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

Here is the caller graph for this function:

getLastChangeBy()

ilPRGAssignment::getLastChangeBy

(

)

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

References $last_change_by.

Referenced by ilPRGAssignmentDBRepository\store(), and ilStudyProgrammeUserTable\toRow().

                                     : int
    {
        return $this->last_change_by;
    }

Here is the caller graph for this function:

getProgresses()

ilPRGAssignment::getProgresses	(	array &	$ret = [],
		?ilPRGProgress	$pgs = null
	)

Definition at line 170 of file class.ilPRGAssignment.php.

References getProgressTree().

Referenced by getProgressesWithDeadline(), ilObjStudyProgramme\removeAssignment(), and ilPRGAssignmentDBRepository\store().

                                                                               : array
    {
        if (!$pgs) {
            $pgs = $this->getProgressTree();
        }

        $ret[] = $pgs;
        foreach ($pgs->getSubnodes() as $id => $sub) {
            $this->getProgresses($ret, $sub);
        }
        return $ret;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getProgressesWithDeadline()

ilPRGAssignment::getProgressesWithDeadline

(

DateTimeImmutable

$deadline

)

Definition at line 196 of file class.ilPRGAssignment.php.

References getProgresses().

     : array {
        return array_values(array_filter(
            $this->getProgresses(),
            fn($pgs) => ! is_null($pgs->getDeadline()) && $pgs->getDeadline() <= $deadline
        ));
    }

Here is the call graph for this function:

getProgressForNode()

ilPRGAssignment::getProgressForNode

(

int

$node_id

)

Definition at line 183 of file class.ilPRGAssignment.php.

References $path, and getProgressTree().

Referenced by ilStudyProgrammeAssignmentActionsTest\testPRGAssignmentActionsChangePoints(), ilStudyProgrammeAssignmentActionsTest\testPRGAssignmentActionsInitDates(), ilStudyProgrammeAssignmentActionsTest\testPRGAssignmentActionsMarkAccredited(), ilStudyProgrammeAssignmentActionsTest\testPRGAssignmentActionsMarkRelevant(), ilStudyProgrammeAssignmentActionsTest\testPRGAssignmentActionsSucceedAndDeadline(), and ilStudyProgrammeUserTable\toRow().

                                                    : ilPRGProgress
    {
        $pgs = $this->getProgressTree();
        $path = $pgs->findSubnodePath((string) $node_id);

        foreach ($path as $hop) {
            if ($pgs->getId() !== $hop) {
                $pgs = $pgs->getSubnode($hop);
            }
        }
        return $pgs;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getProgressTree()

ilPRGAssignment::getProgressTree

(

)

Definition at line 160 of file class.ilPRGAssignment.php.

References $progress.

Referenced by ilStudyProgrammeMailTemplateContext\getLatestAssignment(), ilPRGAssignmentDBRepository\getLatestAssignment(), ILIAS\StudyProgramme\Certificate\ilStudyProgrammePlaceholderValues\getLatestSuccessfulAssignment(), ilStudyProgrammeMailTemplateContext\getLatestSuccessfulAssignment(), ilPRGAssignmentDBRepository\getLongestValidAssignment(), getProgresses(), and getProgressForNode().

                                     : ilPRGProgress
    {
        return $this->progress;
    }

Here is the caller graph for this function:

getRestartDate()

ilPRGAssignment::getRestartDate

(

)

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

References $restart_date.

Referenced by ilPRGAssignmentDBRepository\store(), and ilStudyProgrammeUserTable\toRow().

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

Here is the caller graph for this function:

getRestartedAssignmentId()

ilPRGAssignment::getRestartedAssignmentId

(

)

Definition at line 110 of file class.ilPRGAssignment.php.

References $restarted_asssignment_id.

Referenced by isRestarted(), and ilPRGAssignmentDBRepository\store().

                                              : int
    {
        return $this->restarted_asssignment_id;
    }

Here is the caller graph for this function:

getRootId()

ilPRGAssignment::getRootId

(

)

Definition at line 165 of file class.ilPRGAssignment.php.

Referenced by PRGEventsDelayed\deadlineChange(), ilStudyProgrammeEvents\deadlineChange(), PRGEventsDelayed\informUserByMailToRestart(), ilStudyProgrammeEvents\informUserByMailToRestart(), ilObjStudyProgramme\removeAssignment(), ilPRGAssignmentDBRepository\resetExpiryInfoSentFor(), ilPRGAssignmentDBRepository\resetRiskyToFailSentFor(), PRGEventsDelayed\scoreChange(), ilStudyProgrammeEvents\scoreChange(), ilPRGMail\sendMail(), ilPRGAssignmentDBRepository\store(), ilPRGAssignmentDBRepository\storeExpiryInfoSentFor(), ilPRGAssignmentDBRepository\storeRiskyToFailSentFor(), ilStudyProgrammeUserTable\toRow(), PRGEventsDelayed\userAssigned(), ilStudyProgrammeEvents\userAssigned(), PRGEventsDelayed\userDeassigned(), ilStudyProgrammeEvents\userDeassigned(), PRGEventsDelayed\userReAssigned(), ilStudyProgrammeEvents\userReAssigned(), PRGEventsDelayed\userRevertSuccessful(), ilStudyProgrammeEvents\userRevertSuccessful(), PRGEventsDelayed\userRiskyToFail(), ilStudyProgrammeEvents\userRiskyToFail(), PRGEventsDelayed\userSuccessful(), ilStudyProgrammeEvents\userSuccessful(), PRGEventsDelayed\validityChange(), and ilStudyProgrammeEvents\validityChange().

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

Here is the caller graph for this function:

getUserId()

ilPRGAssignment::getUserId

(

)

Definition at line 70 of file class.ilPRGAssignment.php.

References $usr_id.

Referenced by PRGEventsDelayed\deadlineChange(), ilStudyProgrammeEvents\deadlineChange(), ilObjStudyProgramme\removeAssignment(), PRGEventsDelayed\scoreChange(), ilStudyProgrammeEvents\scoreChange(), ilPRGMail\sendMail(), ilPRGAssignmentDBRepository\store(), ilStudyProgrammeUserTable\toRow(), PRGEventsDelayed\userAssigned(), ilStudyProgrammeEvents\userAssigned(), PRGEventsDelayed\userDeassigned(), ilStudyProgrammeEvents\userDeassigned(), PRGEventsDelayed\userRevertSuccessful(), ilStudyProgrammeEvents\userRevertSuccessful(), PRGEventsDelayed\userSuccessful(), ilStudyProgrammeEvents\userSuccessful(), PRGEventsDelayed\validityChange(), and ilStudyProgrammeEvents\validityChange().

                               : int
    {
        return $this->usr_id;
    }

Here is the caller graph for this function:

getUserInformation()

ilPRGAssignment::getUserInformation

(

)

Definition at line 148 of file class.ilPRGAssignment.php.

References $user_info.

Referenced by ilPRGMail\sendMail(), and ilStudyProgrammeUserTable\toRow().

                                        : ilPRGUserInformation
    {
        return $this->user_info;
    }

Here is the caller graph for this function:

isManuallyAssigned()

ilPRGAssignment::isManuallyAssigned

(

)

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

References $manually_assigned.

Referenced by ilPRGAssignmentDBRepository\store(), and ilStudyProgrammeUserTable\toRow().

                                        : bool
    {
        return $this->manually_assigned;
    }

Here is the caller graph for this function:

isRestarted()

ilPRGAssignment::isRestarted

(

)

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

References getRestartedAssignmentId().

                                 : bool
    {
        return $this->getRestartedAssignmentId() !== -1;
    }

Here is the call graph for this function:

withEvents()

ilPRGAssignment::withEvents

(

StudyProgrammeEvents

$events

)

Definition at line 205 of file class.ilPRGAssignment.php.

References $events.

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

withLastChange()

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

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

References $last_change, $last_change_by, and getLastChange().

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

Here is the call graph for this function:

withManuallyAssigned()

ilPRGAssignment::withManuallyAssigned

(

bool

$manual

)

Definition at line 135 of file class.ilPRGAssignment.php.

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

withProgressTree()

ilPRGAssignment::withProgressTree

(

ilPRGProgress

$progress

)

Definition at line 154 of file class.ilPRGAssignment.php.

References $progress.

Referenced by ilStudyProgrammeAssignmentActionsTest\testPRGAssignmentActionsMarkAccredited(), and ilStudyProgrammeAssignmentActionsTest\testPRGAssignmentActionsSucceedAndDeadline().

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

Here is the caller graph for this function:

withRestarted()

ilPRGAssignment::withRestarted	(	int	$restarted_asssignment_id,
		?\DateTimeImmutable	$restart_date = null
	)

Definition at line 120 of file class.ilPRGAssignment.php.

References $restart_date, and $restarted_asssignment_id.

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

withUserInformation()

ilPRGAssignment::withUserInformation

(

ilPRGUserInformation

$user_info

)

Definition at line 142 of file class.ilPRGAssignment.php.

References $user_info.

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

Field Documentation

$events

StudyProgrammeEvents ilPRGAssignment::$events

protected

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

Referenced by getEvents(), and withEvents().

$id

int ilPRGAssignment::$id

protected

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

Referenced by __construct(), and getId().

$last_change

DateTimeImmutable ilPRGAssignment::$last_change = null

protected

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

Referenced by getLastChange(), and withLastChange().

$last_change_by

int ilPRGAssignment::$last_change_by = null

protected

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

Referenced by getLastChangeBy(), and withLastChange().

$manually_assigned

bool ilPRGAssignment::$manually_assigned

protected

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

Referenced by isManuallyAssigned().

$progress

ilPRGProgress ilPRGAssignment::$progress

protected

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

Referenced by getProgressTree(), and withProgressTree().

$progresses

array ilPRGAssignment::$progresses = []

protected

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

$restart_date

DateTimeImmutable ilPRGAssignment::$restart_date = null

protected

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

Referenced by getRestartDate(), and withRestarted().

$restarted_asssignment_id

int ilPRGAssignment::$restarted_asssignment_id = self::NO_RESTARTED_ASSIGNMENT

protected

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

Referenced by getRestartedAssignmentId(), and withRestarted().

$user_info

ilPRGUserInformation ilPRGAssignment::$user_info

protected

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

Referenced by getUserInformation(), and withUserInformation().

$usr_id

int ilPRGAssignment::$usr_id

protected

Definition at line 44 of file class.ilPRGAssignment.php.

Referenced by __construct(), and getUserId().

AUTO_ASSIGNED_BY_COURSE

const ilPRGAssignment::AUTO_ASSIGNED_BY_COURSE = -3

Definition at line 39 of file class.ilPRGAssignment.php.

AUTO_ASSIGNED_BY_GROUP

const ilPRGAssignment::AUTO_ASSIGNED_BY_GROUP = -4

Definition at line 40 of file class.ilPRGAssignment.php.

AUTO_ASSIGNED_BY_ORGU

const ilPRGAssignment::AUTO_ASSIGNED_BY_ORGU = -2

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

AUTO_ASSIGNED_BY_RESTART

const ilPRGAssignment::AUTO_ASSIGNED_BY_RESTART = -5

Definition at line 41 of file class.ilPRGAssignment.php.

Referenced by ilStudyProgrammeUserTable\assignmentSourceToRepresent().

AUTO_ASSIGNED_BY_ROLE

const ilPRGAssignment::AUTO_ASSIGNED_BY_ROLE = -1

Definition at line 37 of file class.ilPRGAssignment.php.

DATE_FORMAT

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

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

DATE_TIME_FORMAT

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

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

Referenced by ilPRGAssignmentDBRepository\assignmentByRow(), ilPRGAssignmentDBRepository\store(), and ilStudyProgrammeAssignmentTest\testPRGAssignmentProperties().

NO_RESTARTED_ASSIGNMENT

const ilPRGAssignment::NO_RESTARTED_ASSIGNMENT = -1

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

Referenced by ilPRGAssignmentDBRepository\createFor().

---

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

• components/ILIAS/StudyProgramme/classes/model/Assignments/class.ilPRGAssignment.php