ilStudyProgrammeUserAssignmentDB Class Reference

Collaboration diagram for ilStudyProgrammeUserAssignmentDB:

Public Member Functions
	__construct (ilStudyProgrammeUserProgressDB $sp_user_progress_db, ilStudyProgrammeAssignmentRepository $assignment_repository, ilTree $tree, ilStudyProgrammeEvents $sp_events)
	getInstanceById (int $id)
	getInstanceByModel (\ilStudyProgrammeAssignment $assignment)
	getInstancesOfUser (int $user_id)
	getInstancesForProgram (int $program_id)
	getDueToRestartInstances ()
	getDueToRestartAndMail ()
	reminderSendFor (int $assignment_id)
	getDashboardInstancesforUser (int $usr_id)

Protected Attributes
	$sp_user_progress_db
	$assignment_repository
	$tree
	$sp_events

Detailed Description

Definition at line 5 of file class.ilStudyProgrammeUserAssignmentDB.php.

Constructor & Destructor Documentation

__construct()

ilStudyProgrammeUserAssignmentDB::__construct	(	ilStudyProgrammeUserProgressDB	$sp_user_progress_db,
		ilStudyProgrammeAssignmentRepository	$assignment_repository,
		ilTree	$tree,
		ilStudyProgrammeEvents	$sp_events
	)

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

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

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

Member Function Documentation

getDashboardInstancesforUser()

ilStudyProgrammeUserAssignmentDB::getDashboardInstancesforUser

(

int

$usr_id

)

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

                                                              : array
    {
        $ret = [];
        $assigments_by_prg = $this->assignment_repository->getDashboardInstancesforUser($usr_id);
        foreach ($assigments_by_prg as $prg => $assignments) {
            $ret[$prg] = [];
            foreach ($assignments as $id => $assignment) {
                $ret[$prg][$id] = new ilStudyProgrammeUserAssignment(
                    $assignment,
                    $this->sp_user_progress_db,
                    $this->assignment_repository,
                    $this->sp_events
                );
            }
        }
        return $ret;
    }

References $ret.

getDueToRestartAndMail()

ilStudyProgrammeUserAssignmentDB::getDueToRestartAndMail

(

)

Returns

ilStudyProgrammeUserAssignment[]

Definition at line 121 of file class.ilStudyProgrammeUserAssignmentDB.php.

                                             : array
    {
        return array_map(
            function ($ass) {
                return new ilStudyProgrammeUserAssignment(
                    $ass,
                    $this->sp_user_progress_db,
                    $this->assignment_repository,
                    $this->sp_events
                );
            },
            $this->assignment_repository->readDueToRestartAndMail()
        );
    }

getDueToRestartInstances()

ilStudyProgrammeUserAssignmentDB::getDueToRestartInstances

(

)

Returns

ilStudyProgrammeUserAssignment[]

Definition at line 103 of file class.ilStudyProgrammeUserAssignmentDB.php.

                                               : array
    {
        return array_map(
            function ($ass) {
                return new ilStudyProgrammeUserAssignment(
                    $ass,
                    $this->sp_user_progress_db,
                    $this->assignment_repository,
                    $this->sp_events
                );
            },
            $this->assignment_repository->readDueToRestart()
        );
    }

getInstanceById()

ilStudyProgrammeUserAssignmentDB::getInstanceById

(

int

$id

)

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

    {
        $assignment = $this->assignment_repository->read($id);
        if ($assignment === null) {
            throw new ilException("ilStudyProgrammeUserAssignment::__construct: "
                                 . "Unknown assignmemt id '$id'.");
        }
        return new ilStudyProgrammeUserAssignment(
            $assignment,
            $this->sp_user_progress_db,
            $this->assignment_repository,
            $this->sp_events
        );
    }

getInstanceByModel()

ilStudyProgrammeUserAssignmentDB::getInstanceByModel

(

\ilStudyProgrammeAssignment

$assignment

)

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

    {
        return new ilStudyProgrammeUserAssignment(
            $assignment,
            $this->sp_user_progress_db,
            $this->assignment_repository,
            $this->sp_events
        );
    }

getInstancesForProgram()

ilStudyProgrammeUserAssignmentDB::getInstancesForProgram

(

int

$program_id

)

Definition at line 87 of file class.ilStudyProgrammeUserAssignmentDB.php.

    {
        $assignments = $this->assignment_repository->readByPrgId($program_id);
        return array_map(function ($ass) {
            return new ilStudyProgrammeUserAssignment(
                $ass,
                $this->sp_user_progress_db,
                $this->assignment_repository,
                $this->sp_events
            );
        }, array_values($assignments)); // use array values since we want keys 0...
    }

getInstancesOfUser()

ilStudyProgrammeUserAssignmentDB::getInstancesOfUser

(

int

$user_id

)

Definition at line 64 of file class.ilStudyProgrammeUserAssignmentDB.php.

    {
        $assignments = $this->assignment_repository->readByUsrId($user_id);
 
        //if parent object is deleted or in trash
        //the assignment for the user should not be returned
        $ret = [];
        foreach ($assignments as $ass) {
            foreach (ilObject::_getAllReferences($ass->getRootId()) as $value) {
                if ($this->tree->isInTree($value)) {
                    $ret[] = new ilStudyProgrammeUserAssignment(
                        $ass,
                        $this->sp_user_progress_db,
                        $this->assignment_repository,
                        $this->sp_events
                    );
                    continue 2;
                }
            }
        }
        return $ret;
    }

References $ret, and ilObject\_getAllReferences().

Here is the call graph for this function:

reminderSendFor()

ilStudyProgrammeUserAssignmentDB::reminderSendFor

(

int

$assignment_id

)

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

                                                        : void
    {
        $this->assignment_repository->reminderSendFor($assignment_id);
    }

Field Documentation

$assignment_repository

ilStudyProgrammeUserAssignmentDB::$assignment_repository

protected

Definition at line 15 of file class.ilStudyProgrammeUserAssignmentDB.php.

Referenced by __construct().

$sp_events

ilStudyProgrammeUserAssignmentDB::$sp_events

protected

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

Referenced by __construct().

$sp_user_progress_db

ilStudyProgrammeUserAssignmentDB::$sp_user_progress_db

protected

Definition at line 10 of file class.ilStudyProgrammeUserAssignmentDB.php.

Referenced by __construct().

$tree

ilStudyProgrammeUserAssignmentDB::$tree

protected

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

Referenced by __construct().

---

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

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