ilStudyProgrammeUserAssignment Class Reference

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

Collaboration diagram for ilStudyProgrammeUserAssignment:

Public Member Functions
	__construct ($a_id_or_model, \ilStudyProgrammeUserProgressDB $sp_user_progress_db)
	Throws when id does not refer to a study programme assignment. More...
	getId ()
	Get the id of the assignment. More...
	getStudyProgramme ()
	Get the program node where this assignment was made. More...
	getRootProgress ()
	Get the progress on the root node of the programme. More...
	getUserId ()
	Get the id of the user who is assigned. More...
	deassign ()
	Remove this assignment. More...
	delete ()
	Delete the assignment from database. More...
	addMissingProgresses ()
	Add missing progresses for new nodes in the programm. More...

Static Public Member Functions
static	getInstance ($a_id)
	Get an instance. More...
static	getInstancesOfUser ($a_user_id)
	Get all instances for a given user. More...
static	getInstancesForProgram ($a_program_id)
	Get all assignments that were made to the given program. More...

Data Fields
	$assignment

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.

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

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

Constructor & Destructor Documentation

__construct()

ilStudyProgrammeUserAssignment::__construct	(		$a_id_or_model,
		\ilStudyProgrammeUserProgressDB	$sp_user_progress_db
	)

Throws when id does not refer to a study programme assignment.

Exceptions

ilException

Parameters

int  |  ilStudyProgrammeAssignment

$a_id_or_model

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

References $sp_user_progress_db.

    {
        if ($a_id_or_model instanceof ilStudyProgrammeAssignment) {
            $this->assignment = $a_id_or_model;
        } else {
            $this->assignment = ilStudyProgrammeAssignment::find($a_id_or_model);
        }
        if ($this->assignment === null) {
            throw new ilException("ilStudyProgrammeUserAssignment::__construct: "
                                 . "Unknown assignmemt id '$a_id_or_model'.");
        }
        $this->sp_user_progress_db = $sp_user_progress_db;
    }

Member Function Documentation

addMissingProgresses()

ilStudyProgrammeUserAssignment::addMissingProgresses

(

)

Add missing progresses for new nodes in the programm.

The new progresses will be set to not relevant.

Returns

$this

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

References $assignment, $DIC, $id, $ilLog, ilStudyProgrammeProgress\createFor(), getId(), getStudyProgramme(), and ilStudyProgrammeProgress\STATUS_NOT_RELEVANT.

    {
        require_once("Modules/StudyProgramme/classes/exceptions/class.ilStudyProgrammeNoProgressForAssignmentException.php");

        $prg = $this->getStudyProgramme();
        $id = $this->getId();

        // Make $this->assignment protected again afterwards.
        $prg->applyToSubTreeNodes(function ($node) use ($id) {
            try {
                $node->getProgressForAssignment($id);
            } catch (ilStudyProgrammeNoProgressForAssignmentException $e) {
                global $DIC;
                $ilLog = $DIC['ilLog'];
                $ilLog->write("Adding progress for: " . $this->getId() . " " . $node->getId());
                require_once("Modules/StudyProgramme/classes/model/class.ilStudyProgrammeProgress.php");
                $progress = ilStudyProgrammeProgress::createFor($node->getRawSettings(), $this->assignment);
                $progress->setStatus(ilStudyProgrammeProgress::STATUS_NOT_RELEVANT)
                         ->update();
            }
        });

        return $this;
    }

Here is the call graph for this function:

deassign()

ilStudyProgrammeUserAssignment::deassign

(

)

Remove this assignment.

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

References getStudyProgramme().

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

Here is the call graph for this function:

delete()

ilStudyProgrammeUserAssignment::delete

(

)

Delete the assignment from database.

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

References $id, getId(), and getStudyProgramme().

Referenced by ilObjStudyProgramme\removeAssignment().

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

        $this->assignment->delete();
    }

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.

Returns

int

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

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

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

Here is the caller graph for this function:

getInstance()

static ilStudyProgrammeUserAssignment::getInstance (   $a_id )

static

Get an instance.

Just wraps constructor.

Exceptions

ilException

Parameters

int

$a_id

Returns

ilStudyProgrammeUserAssignment

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

References ilObjStudyProgramme\_getStudyProgrammeUserProgressDB().

Referenced by ilStudyProgrammeUserProgress\getAssignment(), and ilObjStudyProgrammeIndividualPlanGUI\getAssignmentObject().

    {
        return new ilStudyProgrammeUserAssignment($a_id, ilObjStudyProgramme::_getStudyProgrammeUserProgressDB());
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getInstancesForProgram()

static ilStudyProgrammeUserAssignment::getInstancesForProgram (   $a_program_id )

static

Get all assignments that were made to the given program.

Parameters

int

$a_program_id

Returns

ilStudyProgrammeUserAssignment[]

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

References ilObjStudyProgramme\_getStudyProgrammeUserProgressDB(), array, and ActiveRecord\where().

Referenced by ilObjStudyProgramme\updateAllAssignments().

    {
        $assignments = ilStudyProgrammeAssignment::where(array( "root_prg_id" => $a_program_id ))
                                                    ->get();
        return array_map(function ($ass) {
            return new ilStudyProgrammeUserAssignment($ass, ilObjStudyProgramme::_getStudyProgrammeUserProgressDB());
        }, array_values($assignments)); // use array values since we want keys 0...
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getInstancesOfUser()

static ilStudyProgrammeUserAssignment::getInstancesOfUser (   $a_user_id )

static

Get all instances for a given user.

Parameters

int

$a_user_id

Returns

ilStudyProgrammeUserAssignment[]

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

References $DIC, $ret, ilObject\_getAllReferences(), ilObjStudyProgramme\_getStudyProgrammeUserProgressDB(), array, and ActiveRecord\where().

Referenced by ilStudyProgrammeAppEventListener\onServiceUserDeleteUser(), and ilPDStudyProgrammeSimpleListGUI\readUsersAssignments().

    {
        global $DIC;
        $tree = $DIC['tree'];

        $assignments = ilStudyProgrammeAssignment::where(array( "usr_id" => $a_user_id ))
                                                    ->get();

        //if parent object is deleted or in trash
        //the assignment for the user should not be returned
        $ret = array();
        foreach ($assignments as $ass) {
            $ass_obj = new ilStudyProgrammeUserAssignment($ass, ilObjStudyProgramme::_getStudyProgrammeUserProgressDB());
            foreach (ilObject::_getAllReferences($ass_obj->assignment->getRootId()) as $value) {
                if ($tree->isInTree($value)) {
                    $ret[] = $ass_obj;
                    break;
                }
            }
        }

        return $ret;
    }

Here is the call graph for this function:

Here is the caller graph for this function:

getRootProgress()

ilStudyProgrammeUserAssignment::getRootProgress

(

)

Get the progress on the root node of the programme.

Exceptions

ilException

Returns

ilStudyProgrammeUserProgress

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

References getId(), and getStudyProgramme().

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

Here is the call graph for this function:

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

Returns

ilObjStudyProgramme

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

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

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

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

Here is the call graph for this function:

Here is the caller graph for this function:

getUserId()

ilStudyProgrammeUserAssignment::getUserId

(

)

Get the id of the user who is assigned.

Returns

int

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

Referenced by ilStudyProgrammeEvents\userAssigned(), and ilStudyProgrammeEvents\userDeassigned().

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

Here is the caller graph for this function:

Field Documentation

$assignment

ilStudyProgrammeUserAssignment::$assignment

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

Referenced by addMissingProgresses().

$sp_user_progress_db

ilStudyProgrammeUserAssignment::$sp_user_progress_db

private

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

Referenced by __construct().

---

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

• Modules/StudyProgramme/classes/class.ilStudyProgrammeUserAssignment.php