Represents one assignment of the user to a program tree. More...

Collaboration diagram for ilStudyProgrammeAssignment:

Public Member Functions
	__construct (int $id)

	getId ()

	getRootId ()

	withRootId (int $root_prg_id)

	getUserId ()

	withUserId (int $usr_id)

	getLastChangeBy ()

	getLastChange ()

	withLastChange (int $last_change_by, DateTimeImmutable $timestamp)

	getRestartDate ()

	getRestartedAssignmentId ()

	withRestarted (int $restarted_asssignment_id, DateTimeImmutable $restart_date=null)

Data Fields
const	NO_RESTARTED_ASSIGNMENT = -1

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

const	DATE_FORMAT = 'Y-m-d'

const	AUTO_ASSIGNED_BY_ROLE = -1

const	AUTO_ASSIGNED_BY_ORGU = -2

const	AUTO_ASSIGNED_BY_COURSE = -3

const	AUTO_ASSIGNED_BY_GROUP = -4

Protected Attributes
	$id

	$usr_id

	$root_prg_id

	$last_change

	$last_change_by

	$restart_date

	$restarted_asssignment_id = self::NO_RESTARTED_ASSIGNMENT

Detailed Description

Represents one assignment of the user to a program tree.

One user can have multiple assignments to the same tree.

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; : 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 13 of file class.ilStudyProgrammeAssignment.php.

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeAssignment::__construct ( int $id )

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

    {
        $this->id = $id;
    }

References $id.

Member Function Documentation

◆ getId()

ilStudyProgrammeAssignment::getId ( )

Definition at line 66 of file class.ilStudyProgrammeAssignment.php.

                            : int
    {
        return $this->id;
    }

References $id.

Referenced by ilStudyProgrammeProgressDBRepository\getRootProgressOf(), ilPDStudyProgrammeExpandableListGUI\new_ilStudyProgrammeAssignmentListGUI(), ilPDStudyProgrammeSimpleListGUI\new_ilStudyProgrammeAssignmentListGUI(), ilObjStudyProgramme\removeAssignment(), ilStudyProgrammeAssignmentDBRepository\update(), ilStudyProgrammeEvents\userAssigned(), and ilStudyProgrammeEvents\userDeassigned().

Here is the caller graph for this function:

◆ getLastChange()

ilStudyProgrammeAssignment::getLastChange ( )

Definition at line 100 of file class.ilStudyProgrammeAssignment.php.

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

References $last_change.

Referenced by ilObjStudyProgramme\getAssignmentsRaw(), ilStudyProgrammeAssignmentDBRepository\update(), and withLastChange().

Here is the caller graph for this function:

◆ getLastChangeBy()

ilStudyProgrammeAssignment::getLastChangeBy ( )

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

                                      : int
    {
        return $this->last_change_by;
    }

References $last_change_by.

Referenced by ilStudyProgrammeAssignmentDBRepository\update().

Here is the caller graph for this function:

◆ getRestartDate()

ilStudyProgrammeAssignment::getRestartDate ( )

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

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

Referenced by ilStudyProgrammeAssignmentDBRepository\update().

Here is the caller graph for this function:

◆ getRestartedAssignmentId()

ilStudyProgrammeAssignment::getRestartedAssignmentId ( )

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

                                               : int
    {
        return $this->restarted_asssignment_id;
    }

Referenced by ilStudyProgrammeAssignmentDBRepository\update().

Here is the caller graph for this function:

◆ getRootId()

ilStudyProgrammeAssignment::getRootId ( )

Definition at line 71 of file class.ilStudyProgrammeAssignment.php.

                                : int
    {
        return $this->root_prg_id;
    }

References $root_prg_id.

Referenced by ilObjStudyProgrammeMembersGUI\getAssignmentsById(), ilStudyProgrammeProgressDBRepository\getRootProgressOf(), ilPDStudyProgrammeSimpleListGUI\hasPermission(), ilPDStudyProgrammeExpandableListGUI\new_ilStudyProgrammeAssignmentListGUI(), ilObjStudyProgramme\removeAssignment(), ilStudyProgrammeAssignmentDBRepository\update(), ilStudyProgrammeEvents\userAssigned(), ilStudyProgrammeEvents\userDeassigned(), and ilStudyProgrammeEvents\userReAssigned().

Here is the caller graph for this function:

◆ getUserId()

ilStudyProgrammeAssignment::getUserId ( )

Definition at line 83 of file class.ilStudyProgrammeAssignment.php.

                                : int
    {
        return $this->usr_id;
    }

References $usr_id.

Referenced by ilStudyProgrammeProgressDBRepository\getRootProgressOf(), ilObjStudyProgramme\removeAssignment(), ilStudyProgrammeAssignmentDBRepository\update(), ilStudyProgrammeEvents\userAssigned(), ilStudyProgrammeEvents\userDeassigned(), and ilStudyProgrammeEvents\userReAssigned().

Here is the caller graph for this function:

◆ withLastChange()

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

Exceptions

ilException if new date is earlier than the existing one

Definition at line 111 of file class.ilStudyProgrammeAssignment.php.

      : ilStudyProgrammeAssignment {
        $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;
    }

References getLastChange().

Here is the call graph for this function:

◆ withRestarted()

ilStudyProgrammeAssignment::withRestarted	(	int	$restarted_asssignment_id,
		DateTimeImmutable	$restart_date = `null`
	)

Definition at line 140 of file class.ilStudyProgrammeAssignment.php.

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

◆ withRootId()

ilStudyProgrammeAssignment::withRootId ( int $root_prg_id )

Definition at line 76 of file class.ilStudyProgrammeAssignment.php.

                                                 : ilStudyProgrammeAssignment
    {
        $clone = clone $this;
        $clone->root_prg_id = $root_prg_id;
        return $clone;
    }

References $root_prg_id.

Referenced by ilStudyProgrammeAssignmentDBRepository\assignmentByRow().

Here is the caller graph for this function:

◆ withUserId()

ilStudyProgrammeAssignment::withUserId ( int $usr_id )

Definition at line 88 of file class.ilStudyProgrammeAssignment.php.

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