Represents one assignment of a user to a study programme. More...

Collaboration diagram for ilStudyProgrammeUserAssignment:

Public Member Functions
	__construct (ilStudyProgrammeAssignment $assignment, ilStudyProgrammeUserProgressDB $sp_user_progress_db, ilStudyProgrammeAssignmentRepository $assignment_repository, ilStudyProgrammeEvents $sp_events)

	getId ()
	Get the id of the assignment. More...

	getStudyProgramme ()
	Get the program node where this assignment was made. More...

	getRestartDate ()
	Get the possible restart date of this assignment. More...

	getRestartedAssignmentId ()
	Get restarted assignment id. More...

	getRootProgress ()
	Get the progress on the root node of the programme. More...

	restartAssignment ()
	Assign the user belonging to this assignment to the prg belonging to this assignment again. More...

	informUserByMailToRestart ()

	getUserId ()

	deassign ()
	Remove this assignment. More...

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

	updateValidityFromProgram ()

	updateDeadlineFromProgram ()

	getSPAssignment ()

Protected Attributes
	$assignment

	$assignment_repository

	$sp_events

Private Attributes
	$sp_user_progress_db

Detailed Description

Represents one assignment of a user to a study programme.

A user could have multiple assignments per programme.

Definition at line 13 of file class.ilStudyProgrammeUserAssignment.php.

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeUserAssignment::__construct	(	ilStudyProgrammeAssignment	$assignment,
		ilStudyProgrammeUserProgressDB	$sp_user_progress_db,
		ilStudyProgrammeAssignmentRepository	$assignment_repository,
		ilStudyProgrammeEvents	$sp_events
	)

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

      {
        $this->assignment = $assignment;
        $this->sp_user_progress_db = $sp_user_progress_db;
        $this->assignment_repository = $assignment_repository;
        $this->sp_events = $sp_events;
    }

References $assignment, $assignment_repository, $sp_events, and $sp_user_progress_db.

Member Function Documentation

◆ deassign()

ilStudyProgrammeUserAssignment::deassign ( )

Remove this assignment.

Exceptions

ilException

Definition at line 133 of file class.ilStudyProgrammeUserAssignment.php.

                               : void
    {
        $this->getStudyProgramme()->removeAssignment($this);
    }

References getStudyProgramme().

Here is the call graph for this function:

◆ delete()

ilStudyProgrammeUserAssignment::delete ( )

Delete the assignment from database.

Definition at line 141 of file class.ilStudyProgrammeUserAssignment.php.

                             : void
    {
        $progresses = $this->sp_user_progress_db->getInstancesForAssignment($this->getId());
        foreach ($progresses as $progress) {
            $progress->delete();
        }
        $this->assignment_repository->delete(
            $this->assignment
        );
    }

References getId().

Referenced by ilObjStudyProgramme\removeAssignment().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getId()

ilStudyProgrammeUserAssignment::getId ( )

Get the id of the assignment.

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

                            : int
    {
        return $this->assignment->getId();
    }

Referenced by delete(), getRootProgress(), ilStudyProgrammeEvents\informUserByMailToRestart(), ilPDStudyProgrammeExpandableListGUI\new_ilStudyProgrammeAssignmentListGUI(), ilPDStudyProgrammeSimpleListGUI\new_ilStudyProgrammeAssignmentListGUI(), ilObjStudyProgramme\removeAssignment(), ilStudyProgrammeEvents\userAssigned(), and ilStudyProgrammeEvents\userDeassigned().

Here is the caller graph for this function:

◆ getRestartDate()

ilStudyProgrammeUserAssignment::getRestartDate ( )

Get the possible restart date of this assignment.

Returns: DateTime | null

Definition at line 77 of file class.ilStudyProgrammeUserAssignment.php.

    {
        return $this->assignment->getRestartDate();
    }

◆ getRestartedAssignmentId()

ilStudyProgrammeUserAssignment::getRestartedAssignmentId ( )

Get restarted assignment id.

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

                                               : int
    {
        return $this->assignment->getRestartedAssignmentId();
    }

◆ getRootProgress()

ilStudyProgrammeUserAssignment::getRootProgress ( )

Get the progress on the root node of the programme.

Exceptions

ilException

Definition at line 95 of file class.ilStudyProgrammeUserAssignment.php.

                                      : ilStudyProgrammeUserProgress
    {
        return $this->getStudyProgramme()->getProgressForAssignment($this->getId());
    }

References getId(), and getStudyProgramme().

Referenced by updateDeadlineFromProgram(), and updateValidityFromProgram().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getSPAssignment()

ilStudyProgrammeUserAssignment::getSPAssignment ( )

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

                                      : ilStudyProgrammeAssignment
    {
        return $this->assignment;
    }

References $assignment.

◆ getStudyProgramme()

ilStudyProgrammeUserAssignment::getStudyProgramme ( )

Get the program node where this assignment was made.

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

Exceptions

ilException

Definition at line 62 of file class.ilStudyProgrammeUserAssignment.php.

                                        : ilObjStudyProgramme
    {
        $refs = ilObject::_getAllReferences((int) $this->assignment->getRootId());
        if (!count($refs)) {
            throw new ilException("ilStudyProgrammeUserAssignment::getStudyProgramme: "
                                 . "could not find ref_id for program '"
                                 . $this->assignment->getRootId() . "'.");
        }
        return ilObjStudyProgramme::getInstanceByRefId((int) array_shift($refs));
    }

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

Referenced by deassign(), ilObjStudyProgrammeMembersGUI\getAssignmentsById(), getRootProgress(), ilPDStudyProgrammeSimpleListGUI\hasPermission(), ilPDStudyProgrammeExpandableListGUI\new_ilStudyProgrammeAssignmentListGUI(), ilPDStudyProgrammeSimpleListGUI\new_ilStudyProgrammeAssignmentListGUI(), ilObjStudyProgramme\removeAssignment(), restartAssignment(), updateDeadlineFromProgram(), updateValidityFromProgram(), ilStudyProgrammeEvents\userAssigned(), ilStudyProgrammeEvents\userDeassigned(), and ilStudyProgrammeEvents\userReAssigned().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ getUserId()

ilStudyProgrammeUserAssignment::getUserId ( )

Definition at line 123 of file class.ilStudyProgrammeUserAssignment.php.

                                : int
    {
        return $this->assignment->getUserId();
    }

Referenced by ilStudyProgrammeEvents\informUserByMailToRestart(), restartAssignment(), ilStudyProgrammeEvents\userAssigned(), ilStudyProgrammeEvents\userDeassigned(), and ilStudyProgrammeEvents\userReAssigned().

Here is the caller graph for this function:

◆ informUserByMailToRestart()

ilStudyProgrammeUserAssignment::informUserByMailToRestart ( )

Definition at line 118 of file class.ilStudyProgrammeUserAssignment.php.

                                                : void
    {
        $this->sp_events->informUserByMailToRestart($this);
    }

◆ restartAssignment()

ilStudyProgrammeUserAssignment::restartAssignment ( )

Assign the user belonging to this assignment to the prg belonging to this assignment again.

Exceptions

ilException

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

                                        : ilStudyProgrammeUserAssignment
    {
        $restarted = $this->getStudyProgramme()->assignUser($this->getUserId(), $this->getUserId());
        $this->assignment_repository->update(
            $this->assignment->setRestartedAssignmentId($restarted->getId())
        );
 
        $this->sp_events->userReAssigned($this);
 
        return $restarted;
    }

References getStudyProgramme(), and getUserId().

Here is the call graph for this function:

◆ updateDeadlineFromProgram()

ilStudyProgrammeUserAssignment::updateDeadlineFromProgram ( )

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

                                                : void
    {
        $prg = $this->getStudyProgramme();
        $progress = $this->getRootProgress();
        if ($progress->hasSuccessStatus()) {
            return;
        }
 
        $deadline_settings = $prg->getDeadlineSettings();
        $period = $deadline_settings->getDeadlinePeriod();
        $date = $deadline_settings->getDeadlineDate();
        if ($period) {
            $date = $progress->getAssignmentDate();
            $date->add(new DateInterval('P' . $period . 'D'));
        }
        $progress->setDeadline($date);
        $progress->storeProgress();
    }

References getRootProgress(), and getStudyProgramme().

Referenced by ilObjStudyProgrammeMembersGUI\updateUserAssignmentFromProgramm().

Here is the call graph for this function:

Here is the caller graph for this function:

◆ updateValidityFromProgram()

ilStudyProgrammeUserAssignment::updateValidityFromProgram ( )

Definition at line 173 of file class.ilStudyProgrammeUserAssignment.php.

                                                : void
    {
        $prg = $this->getStudyProgramme();
        $progress = $this->getRootProgress();
        if (!$progress->hasSuccessStatus()) {
            return;
        }
 
        $validity_settings = $prg->getValidityOfQualificationSettings();
        $period = $validity_settings->getQualificationPeriod();
        $date = $validity_settings->getQualificationDate();
 
        if ($period) {
            $date = $progress->getCompletionDate();
            $date->add(new DateInterval('P' . $period . 'D'));
        }
        $progress->setValidityOfQualification($date);
        $progress->storeProgress();
    }