class.ilStudyProgrammeUserAssignmentDB.php

Go to the documentation of this file.

<?php

declare(strict_types=1);

class ilStudyProgrammeUserAssignmentDB
{
    protected $sp_user_progress_db;

    protected $assignment_repository;

    protected $tree;

    protected $sp_events;

    public function __construct(
        ilStudyProgrammeUserProgressDB $sp_user_progress_db,
        ilStudyProgrammeAssignmentRepository $assignment_repository,
        ilTree $tree,
        ilStudyProgrammeEvents $sp_events
    ) {
        $this->sp_user_progress_db = $sp_user_progress_db;
        $this->assignment_repository = $assignment_repository;
        $this->tree = $tree;
        $this->sp_events = $sp_events;
    }

    public function getInstanceById(int $id)
    {
        $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
        );
    }

    public function getInstanceByModel(\ilStudyProgrammeAssignment $assignment)
    {
        return new ilStudyProgrammeUserAssignment(
            $assignment,
            $this->sp_user_progress_db,
            $this->assignment_repository,
            $this->sp_events
        );
    }

    public function getInstancesOfUser(int $user_id)
    {
        $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;
    }

    public function getInstancesForProgram(int $program_id)
    {
        $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...
    }

    public function getDueToRestartInstances() : 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()
        );
    }

    public function getDueToRestartAndMail() : 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()
        );
    }

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

    public function getDashboardInstancesforUser(int $usr_id) : 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;
    }
}