Class ilStudyProgrammeAssignment. More...

Collaboration diagram for ilStudyProgrammeAssignment:

Public Member Functions
	__construct (int $id)

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

	getRootId ()
	Get the object id of the program the user was assigned to. More...

	setRootId (int $id)

	getUserId ()
	Get the id of the user who is assigned. More...

	setUserId (int $usr_id)

	getLastChangeBy ()
	Get the id of the user who did the last change on this assignment. More...

	setLastChangeBy (int $assigned_by_id)
	Set the id of the user who did the last change on this assignment. More...

	getLastChange ()
	Get the timestamp of the last change on this program or a sub program. More...

	updateLastChange ()
	Update the last change timestamp to the current time. More...

	setLastChange (DateTime $timestamp)
	Set the last change timestamp to the given time. More...

	setRestartDate (DateTime $date=null)
	Set the date, at which the user is to be reassigned to the programme. More...

	getRestartDate ()
	Get the date, at which the user is to be reassigned to the programme. More...

	setRestartedAssignmentId (int $id)
	Set the id of the assignment which was intiated due to expiring progress of this assignment. More...

	getRestartedAssignmentId ()
	Get the id of the assignment which was intiated due to expiring progress of this assignment. More...

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

Class ilStudyProgrammeAssignment.

Represents one assignment of the user to a program tree.

One user can have multiple assignments to the same tree. This makes it possible to represent programs that need to be accomplished periodically as well.

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

Version: : 0.1.0

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

Constructor & Destructor Documentation

◆ __construct()

ilStudyProgrammeAssignment::__construct ( int $id )

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

    {
        $this->id = $id;
    }

References $id.

Member Function Documentation

◆ getId()

ilStudyProgrammeAssignment::getId ( )

Get the id of the assignment.

Returns: int

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

                            : int
    {
        return $this->id;
    }

References $id.

Referenced by ilStudyProgrammeAssignmentDBRepository\update().

Here is the caller graph for this function:

◆ getLastChange()

ilStudyProgrammeAssignment::getLastChange ( )

Get the timestamp of the last change on this program or a sub program.

Returns: DateTime

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

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

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

Here is the caller graph for this function:

◆ getLastChangeBy()

ilStudyProgrammeAssignment::getLastChangeBy ( )

Get the id of the user who did the last change on this assignment.

Returns: int

Definition at line 136 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 ( )

Get the date, at which the user is to be reassigned to the programme.

Returns: DateTime | null

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

    {
        return $this->restart_date;
    }

References $restart_date.

Referenced by ilStudyProgrammeAssignmentDBRepository\update().

Here is the caller graph for this function:

◆ getRestartedAssignmentId()

ilStudyProgrammeAssignment::getRestartedAssignmentId ( )

Get the id of the assignment which was intiated due to expiring progress of this assignment.

Returns: int

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

                                               : int
    {
        return $this->restarted_asssignment_id;
    }

References $restarted_asssignment_id.

Referenced by ilStudyProgrammeAssignmentDBRepository\update().

Here is the caller graph for this function:

◆ getRootId()

ilStudyProgrammeAssignment::getRootId ( )

Get the object id of the program the user was assigned to.

Returns: int

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

                                : int
    {
        return $this->root_prg_id;
    }

References $root_prg_id.

Referenced by ilStudyProgrammeAssignmentDBRepository\update().

Here is the caller graph for this function:

◆ getUserId()

ilStudyProgrammeAssignment::getUserId ( )

Get the id of the user who is assigned.

Returns: int

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

                                : int
    {
        return $this->usr_id;
    }

References $usr_id.

Referenced by ilStudyProgrammeAssignmentDBRepository\update().

Here is the caller graph for this function:

◆ setLastChange()

ilStudyProgrammeAssignment::setLastChange ( DateTime $timestamp )

Set the last change timestamp to the given time.

Returns: $this

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

                                                       : ilStudyProgrammeAssignment
    {
        $this->last_change = $timestamp->format(self::DATE_TIME_FORMAT);
        return $this;
    }

References $timestamp.

Referenced by updateLastChange().

Here is the caller graph for this function:

◆ setLastChangeBy()

ilStudyProgrammeAssignment::setLastChangeBy ( int $assigned_by_id )

Set the id of the user who did the last change on this assignment.

Throws when $a_usr_id is not the id of a user.

Exceptions

ilException

Returns: $this

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

                                                         : ilStudyProgrammeAssignment
    {
        $auto_assignment = [
            self::AUTO_ASSIGNED_BY_ROLE,
            self::AUTO_ASSIGNED_BY_ORGU,
            self::AUTO_ASSIGNED_BY_COURSE,
            self::AUTO_ASSIGNED_BY_GROUP
        ];
        $is_auto_assignment = in_array($assigned_by_id, $auto_assignment);
        $exists = ilObject::_exists($assigned_by_id);
        $is_usr = ilObject::_lookupType($assigned_by_id) == "usr";
        if (!$is_auto_assignment && ($exists && !$is_usr)) {
            throw new ilException("ilStudyProgrammeAssignment::setLastChangeBy: '$assigned_by_id' "
                                 . "is neither a user's id nor a valid membership source.");
        }
 
        $this->last_change_by = $assigned_by_id;
        return $this;
    }

References ilObject\_exists(), ilObject\_lookupType(), AUTO_ASSIGNED_BY_COURSE, AUTO_ASSIGNED_BY_GROUP, AUTO_ASSIGNED_BY_ORGU, and AUTO_ASSIGNED_BY_ROLE.

Here is the call graph for this function:

◆ setRestartDate()

ilStudyProgrammeAssignment::setRestartDate ( DateTime $date = null )

Set the date, at which the user is to be reassigned to the programme.

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

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

◆ setRestartedAssignmentId()

ilStudyProgrammeAssignment::setRestartedAssignmentId ( int $id )

Set the id of the assignment which was intiated due to expiring progress of this assignment.

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

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

References $id.

◆ setRootId()

ilStudyProgrammeAssignment::setRootId ( int $id )

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

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

References $id.

Referenced by ilStudyProgrammeAssignmentDBRepository\assignmentByRow().

Here is the caller graph for this function:

◆ setUserId()

ilStudyProgrammeAssignment::setUserId ( int $usr_id )

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

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

References $usr_id.

◆ updateLastChange()

ilStudyProgrammeAssignment::updateLastChange ( )

Update the last change timestamp to the current time.

Returns: $this

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

                                       : ilStudyProgrammeAssignment
    {
        $this->setLastChange(new DateTime());
        return $this;
    }

References setLastChange().

Here is the call graph for this function:

Field Documentation

◆ $id

ilStudyProgrammeAssignment::$id

protected

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

Referenced by __construct(), getId(), setRestartedAssignmentId(), and setRootId().

◆ $last_change

ilStudyProgrammeAssignment::$last_change

protected

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

◆ $last_change_by

ilStudyProgrammeAssignment::$last_change_by

protected

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

Referenced by getLastChangeBy().

◆ $restart_date

ilStudyProgrammeAssignment::$restart_date

protected

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

Referenced by getRestartDate().

◆ $restarted_asssignment_id

ilStudyProgrammeAssignment::$restarted_asssignment_id = self::NO_RESTARTED_ASSIGNMENT

protected

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

Referenced by getRestartedAssignmentId().

◆ $root_prg_id

ilStudyProgrammeAssignment::$root_prg_id

protected

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

Referenced by getRootId().

◆ $usr_id

ilStudyProgrammeAssignment::$usr_id

protected

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

Referenced by getUserId(), and setUserId().

◆ AUTO_ASSIGNED_BY_COURSE

const ilStudyProgrammeAssignment::AUTO_ASSIGNED_BY_COURSE = -3

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

Referenced by setLastChangeBy().

◆ AUTO_ASSIGNED_BY_GROUP

const ilStudyProgrammeAssignment::AUTO_ASSIGNED_BY_GROUP = -4

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

Referenced by setLastChangeBy().

◆ AUTO_ASSIGNED_BY_ORGU

const ilStudyProgrammeAssignment::AUTO_ASSIGNED_BY_ORGU = -2

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

Referenced by setLastChangeBy().

◆ AUTO_ASSIGNED_BY_ROLE

const ilStudyProgrammeAssignment::AUTO_ASSIGNED_BY_ROLE = -1

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

Referenced by setLastChangeBy().

◆ DATE_FORMAT

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

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

Referenced by ilStudyProgrammeAssignmentDBRepository\getDueToRestartBaseSQL(), and ilStudyProgrammeAssignmentDBRepository\loadDueToManuelRestart().

◆ DATE_TIME_FORMAT

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

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

Referenced by ilStudyProgrammeAssignmentDBRepository\assignmentByRow(), and ilStudyProgrammeAssignmentDBRepository\update().

◆ NO_RESTARTED_ASSIGNMENT

const ilStudyProgrammeAssignment::NO_RESTARTED_ASSIGNMENT = -1

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

Referenced by ilStudyProgrammeAssignmentDBRepository\createFor(), ilStudyProgrammeAssignmentDBRepository\getDueToRestartBaseSQL(), ilStudyProgrammeAssignmentDBRepository\loadDueToManuelRestart(), ilStudyProgrammeAssignmentRepositoryTest\test_create(), ilStudyProgrammeAssignmentTest\test_restarted_assigment(), and ilStudyProgrammeUserAssignmentTest\testRstartAssignment().

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

Modules/StudyProgramme/classes/model/Assignments/class.ilStudyProgrammeAssignment.php

Public Member Functions

Data Fields

Protected Attributes

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ getId()

◆ getLastChange()

◆ getLastChangeBy()

◆ getRestartDate()

◆ getRestartedAssignmentId()

◆ getRootId()

◆ getUserId()

◆ setLastChange()

◆ setLastChangeBy()

◆ setRestartDate()

◆ setRestartedAssignmentId()

◆ setRootId()

◆ setUserId()

◆ updateLastChange()

Field Documentation

◆ $id

◆ $last_change

◆ $last_change_by

◆ $restart_date

◆ $restarted_asssignment_id

◆ $root_prg_id

◆ $usr_id

◆ AUTO_ASSIGNED_BY_COURSE

◆ AUTO_ASSIGNED_BY_GROUP

◆ AUTO_ASSIGNED_BY_ORGU

◆ AUTO_ASSIGNED_BY_ROLE

◆ DATE_FORMAT

◆ DATE_TIME_FORMAT

◆ NO_RESTARTED_ASSIGNMENT